Queries detailed information about the instances in an application group.
Debugging
Request parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| Action | String | Yes | DescribeMonitorGroupInstanceAttribute |
The operation that you want to perform. Set the value to DescribeMonitorGroupInstanceAttribute. |
| GroupId | Long | Yes | 12345 |
The ID of the application group. |
| Category | String | No | ECS |
The abbreviation of the name of the service to which the instances in the application group belong. Valid values:
|
| InstanceIds | String | No | i-m5e0k0bexac8tykr**** |
The ID of the instance. Note You can query detailed information about a maximum of 20 instances at a time. Separate
multiple instance IDs with commas (,).
|
| Keyword | String | No | portal |
The keyword used to search for instances. |
| PageNumber | Integer | No | 1 |
The number of the page to return. Default value: 1. |
| PageSize | Integer | No | 10 |
The number of entries returned on each page. |
| Total | Boolean | No | true |
The total number of entries returned. |
Response parameters
| Parameter | Type | Example | Description |
|---|---|---|---|
| RequestId | String | 9FB8EA79-7279-4482-8D6D-3D28EEDD871A |
The ID of the request. |
| Code | Integer | 200 |
The HTTP status code. Note The status code 200 indicates that the call was successful.
|
| Success | Boolean | true |
Indicates whether the call was successful. |
| PageNumber | Integer | 1 |
The number of the returned page. |
| PageSize | Integer | 2 |
The total number of pages returned. |
| Total | Integer | 12 |
The total number of entries returned. |
| Resources | Array | N/A |
The information about the queried instances. |
| Resource | N/A | N/A |
The information about a queried instance. |
| Category | String | ECS |
The abbreviation of the service name. |
| Desc | String | desc_test |
The description of the instance. |
| Dimension | String | {"instanceId":"xxx"} |
The dimensions associated with the instance. |
| InstanceId | String | i-m5e0k0bexac8tykr**** |
The ID of the instance. |
| InstanceName | String | hostName |
The name of the instance. |
| NetworkType | String | vpc |
The type of the network. |
| Region | N/A | N/A |
The information about the region and zone where the instance resides. |
| AvailabilityZone | String | cn-hangzhou-f |
The ID of the zone where the instance resides. |
| RegionId | String | cn-hangzhou |
The ID of the region where the instance resides. |
| Tags | Array | N/A |
The tags attached to the instance. Each tag is a key-value pair. |
| Tag | N/A | N/A |
The information about a tag attached to the instance. Each tag is a key-value pair. |
| Key | String | instanceNetworkType |
The key of the tag. |
| Value | String | VPC |
The value of the tag. |
| Vpc | N/A | N/A |
The information about the virtual private cloud (VPC) where the instance resides and the VSwitch to which the instance belongs. Such information is returned for VPC-connected instances. |
| VpcInstanceId | String | vpc-2zew7etgiceg21**** |
The ID of the VPC where the instance resides. |
| VswitchInstanceId | String | vsw-2ze36seq79n992**** |
The ID of the VSwitch to which the instance belongs. |
| Message | String | success |
The returned message. |
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeMonitorGroupInstanceAttribute
&GroupId=12345
&<Common request parameters>
Sample success responses
XML format
<PageNumber>1</PageNumber>
<PageSize>30</PageSize>
<RequestId>7DB8DA3D-EDA6-46F8-9222-70C52416AE7D</RequestId>
<Success>true</Success>
<Code>200</Code>
<Total>1</Total>
<Resources>
<Resource>
<Vpc>
<VswitchInstanceId>vsw-2ze36seq79n992****</VswitchInstanceId>
<VpcInstanceId>vpc-2zew7etgiceg21****</VpcInstanceId>
</Vpc>
<Tags>
<Tag>
<Value>12345</Value>
<Key>aliUid</Key>
</Tag>
<Tag>
<Value>26842</Value>
<Key>bid</Key>
</Tag>
<Tag>
<Value>0</Value>
<Key>levelId</Key>
</Tag>
<Tag>
<Value>test_name</Value>
<Key>description</Key>
</Tag>
<Tag>
<Value>1540195308000</Value>
<Key>gmtModified</Key>
</Tag>
<Tag>
<Value>1538036293000</Value>
<Key>gmtCreated</Key>
</Tag>
<Tag>
<Value>1569572293000</Value>
<Key>endTime</Key>
</Tag>
<Tag>
<Value>1</Value>
<Key>dbInstanceId</Key>
</Tag>
<Tag>
<Value>rm-bp179a8xfaz4i61hx</Value>
<Key>dbInstanceName</Key>
</Tag>
<Tag>
<Value>cn-hangzhou</Value>
<Key>region</Key>
</Tag>
<Tag>
<Value>MySQL</Value>
<Key>engine</Key>
</Tag>
<Tag>
<Value>5.7</Value>
<Key>engineVersion</Key>
</Tag>
<Tag>
<Value>x</Value>
<Key>dbInstanceType</Key>
</Tag>
</Tags>
<NetworkType>VPC</NetworkType>
<Category>RDS</Category>
<Region>
<RegionId>cn-hangzhou</RegionId>
<AvailabilityZone>cn-hangzhou-MAZ8(f,g)</AvailabilityZone>
</Region>
<AliUid>127067667954****</AliUid>
<InstanceId>i-m5e0k0bexac8tykr****</InstanceId>
<Dimension>{"userId":"127067667954****","instanceId":"rm-bp179a8xfaz4i****"}</Dimension>
<Desc>test_name</Desc>
<InstanceName>test_name</InstanceName>
</Resource>
</Resources>JSON format
{
"PageNumber":1,
"PageSize":30,
"RequestId":"7DB8DA3D-EDA6-46F8-9222-70C52416AE7D",
"Success":true,
"Code":200,
"Total":1,
"Resources":{
"Resource":[
{
"Vpc":{
"VswitchInstanceId":"vsw-2ze36seq79n992****",
"VpcInstanceId":"vpc-2zew7etgiceg21****"
},
"NetworkType":"VPC",
"Tags":{
"Tag":[
{
"Value":"12345",
"Key":"aliUid"
},
{
"Value":"26842",
"Key":"bid"
},
{
"Value":"0",
"Key":"levelId"
},
{
"Value":"test_name",
"Key":"description"
},
{
"Value":"1540195308000",
"Key":"gmtModified"
},
{
"Value":"1538036293000",
"Key":"gmtCreated"
},
{
"Value":"1569572293000",
"Key":"endTime"
},
{
"Value":"1",
"Key":"dbInstanceId"
},
{
"Value":"rm-bp179a8xfaz4i61hx",
"Key":"dbInstanceName"
},
{
"Value":"cn-hangzhou",
"Key":"region"
},
{
"Value":"MySQL",
"Key":"engine"
},
{
"Value":"5.7",
"Key":"engineVersion"
},
{
"Value":"x",
"Key":"dbInstanceType"
}
]
},
"Category":"RDS",
"Region":{
"RegionId":"cn-hangzhou",
"AvailabilityZone":"cn-hangzhou-MAZ8(f,g)"
},
"AliUid":"127067667954****",
"InstanceId":"i-m5e0k0bexac8tykr****",
"Dimension":"{\"userId\":\"127067667954****\",\"instanceId\":\"rm-bp179a8xfaz4i****\"}",
"InstanceName":"test_name",
"Desc":"test_name"
}
]
}
}Error codes
For a list of error codes, visit the API Error Center.