基本信息

Action

DescribeInstanceGroups

Path

/iaas

Method

GET

请求参数

此接口除公共参数外，还包含以下参数。关于公共参数的更多信息，请参见前文内容。

参数名 类型 描述 是否必须

instance_groups.n

String

云服务器组 ID

否

relation

String

云服务器分组关系

否

tags.n

String

按照标签ID过滤, 只返回已绑定某标签的资源

否

owner

String

按照用户账户过滤, 只返回指定账户的资源

否

verbose

Integer

是否返回冗长的信息, 若为1, 则返回云服务器组相关其他资源的详细数据。

否

返回数据

此接口除了返回公共响应参数外，还返回以下参数。关于公共响应参数的更多信息，请参见前文内容。

参数名 类型 描述

instance_group_set

Array

JSON 格式的云服务器组数据列表, 每项参数可见下面 Response Item

total_count

Integer

根据过滤条件得到的云服务器组总数

返回示例

参数名 类型 描述

instance_group_id

String

云服务器组 ID

instance_group_name

String

云服务器组名称

description

String

云服务器组描述

relation

String

云服务器组关系

create_time

TimeStamp

云服务器组创建时间, 为UTC时间, 格式可参见 ISO8601.

请求示例

https://api.<your_domain>/iaas/?action=DescribeInstanceGroups
&instance_groups.1=ig-8qstg3wi
&verbose=1
&zone=gd2
&COMMON_PARAMS

返回示例

{
  "action":"DescribeInstanceGroupsResponse",
  "total_count":1,
  "instance_group_set":[
    {
      "instance_group_name":"attract",
      "description":"",
      "tags":[],
      "controller":"self",
      "console_id":"alphacloud",
      "root_user_id":"usr-97aasaOZ",
      "create_time":"2017-10-27T03:46:06Z",
      "relation":"attract",
      "owner":"usr-97aasaOZ",
      "instance_group_id":"ig-8qstg3wi"
    }
  ],
  "ret_code":0
}