All Products
Search
Document Center

CloudMonitor:DescribeMonitorGroupInstanceAttribute

Last Updated:Mar 01, 2024

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
GroupIdlongYes

The ID of the application group.

123456
PageNumberintegerNo

The number of the page to return.

Valid values: 1 to 1000000000.

Default value: 1.

1
PageSizeintegerNo

The number of entries to return on each page.

Valid values: 1 to 1000000000.

Default value: 10.

10
TotalbooleanNo

Specifies whether to return the total number of resources in the specified application group. Valid values:

  • true (default value)
  • false
true
CategorystringNo

The abbreviation of the Alibaba Cloud service name.

To obtain the abbreviation of an Alibaba Cloud service name, call the DescribeProjectMeta operation. The metricCategory tag in the Labels response parameter indicates the abbreviation of the Alibaba Cloud service name.

ecs
KeywordstringNo

The keyword that is used to search for resources.

portal
InstanceIdsstringNo

The ID of the resource. Separate multiple resource IDs with commas (,). You can query the details about a maximum of 20 resources in each request.

i-m5e0k0bexac8tykr****

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

9FB8EA79-7279-4482-8D6D-3D28EEDD871A
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true
Codeinteger

The HTTP status code.

Note The status code 200 indicates that the call was successful.
200
Messagestring

The error message.

The specified resource is not found.
PageNumberinteger

The page number of the returned page.

1
PageSizeinteger

The total number of returned pages.

2
Totalinteger

The total number of returned entries.

12
Resourcesobject []

The resources that are associated with the application group.

InstanceNamestring

The name of the instance.

hostName
Dimensionstring

The dimensions of the resource that is associated with the application group.

{"instanceId":"i-m5e0k0bexac8tykr****"}
Categorystring

The name of the cloud service.

ecs
InstanceIdstring

The ID of the instance.

i-m5e0k0bexac8tykr****
NetworkTypestring

The network type.

vpc
Descstring

The description of the resource.

desc_test
Tagsobject []

The tags of the resource.

Keystring

The tag key.

instanceNetworkType
Valuestring

The tag value.

VPC
Vpcobject

The information about the virtual private cloud (VPC).

VswitchInstanceIdstring

The ID of the vSwitch to which the instance belongs.

vsw-2ze36seq79n992****
VpcInstanceIdstring

The ID of the VPC.

vpc-2zew7etgiceg21****

Examples

Sample success responses

JSONformat

{
  "RequestId": "9FB8EA79-7279-4482-8D6D-3D28EEDD871A",
  "Success": true,
  "Code": 200,
  "Message": "The specified resource is not found.",
  "PageNumber": 1,
  "PageSize": 2,
  "Total": 12,
  "Resources": {
    "Resource": [
      {
        "InstanceName": "hostName",
        "Dimension": "{\"instanceId\":\"i-m5e0k0bexac8tykr****\"}",
        "Category": "ecs",
        "InstanceId": "i-m5e0k0bexac8tykr****",
        "NetworkType": "vpc",
        "Desc": "desc_test",
        "Tags": {
          "Tag": [
            {
              "Key": "instanceNetworkType",
              "Value": "VPC"
            }
          ]
        },
        "Region": {
          "AvailabilityZone": "cn-hangzhou-f",
          "RegionId": "cn-hangzhou"
        },
        "Vpc": {
          "VswitchInstanceId": "vsw-2ze36seq79n992****",
          "VpcInstanceId": "vpc-2zew7etgiceg21****"
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError messageDescription
206%s%s-
400ParameterInvalid%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403AccessForbiddenThe X.509 certificate or cms access key ID provided does not exist in our records.-
404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
429Throttli∂ngExceptionThe request was denied due to request throttling.-
500InternalErrorThe request processing has failed due to some unknown error.-

For a list of error codes, visit the Service error codes.