All Products
Search
Document Center

:DescribeDiagnosticMetricSets

更新時間:Dec 06, 2023

Queries diagnostic metric sets.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter

Type

Required

Example

Description

Action String Yes DescribeDiagnosticMetricSets

The operation that you want to perform. Set the value to DescribeDiagnosticMetricSets.

RegionId String Yes cn-hangzhou

The region ID of the diagnostic metric set. You can call the DescribeRegions operation to query the most recent region list.

MetricSetIds.N String No dms-uf6i0tv2refv8wz*****

The ID of diagnostic metric set N.

Type String No User

The type of the diagnostic metric set. Valid values:

  • User: user-defined diagnostic metric set
  • Common: common diagnostic metric set

Default value: User.

ResourceType String No instance

The resource type supported by the diagnostic metric set.

NextToken String No caeba0bbb2be03f84eb48b699f0a4883

The pagination token that is used in the next request to retrieve a new page of results. You do not need to specify this parameter for the first request. You must specify the token that is obtained from the previous query as the value of NextToken.

MaxResults Integer No 10

The number of entries per page. Valid values: 1 to 100.

Default value:

  • If this parameter is left empty, the default value is 10.
  • If this parameter is set to a value greater than 100, the default value is 100.

Response parameters

Parameter

Type

Example

Description

RequestId String 473469C7-AA6F-4DC5-B3DB-A3DC0DE*****

The ID of the request.

NextToken String caeba0bbb2be03f84eb48b699f0a4883

A pagination token. It can be used in the next request to retrieve a new page of results.

MetricSets Array of MetricSet

The diagnostic metric sets.

MetricSetId String dms-bp17p0qwtr72zmu*****

The ID of the diagnostic metric set.

MetricSetName String connection issue diagnostics

The name of the diagnostic metric set.

Description String connection issue diagnostics

The description of the diagnostic metric set.

Type String User

The type of the diagnostic metric set. Valid values:

  • User: user-defined diagnostic metric set
  • Common: common diagnostic metric set
ResourceType String instance

The resource type supported by the diagnostic metric set.

MetricIds Array of String Instance.DiskLoadFailure

The diagnostic metrics.

Examples

Sample requests

http(s)://ecs.aliyuncs.com/?Action=DescribeDiagnosticMetricSets
&RegionId=cn-hangzhou
&MetricSetIds=["dms-uf6i0tv2refv8wz*****"]
&Type=User
&ResourceType=instance
&NextToken=caeba0bbb2be03f84eb48b699f0a4883
&MaxResults=10
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeDiagnosticMetricSetsResponse>
    <RequestId>473469C7-AA6F-4DC5-B3DB-A3DC0DE*****</RequestId>
    <NextToken>caeba0bbb2be03f84eb48b699f0a4883</NextToken>
    <MetricSets>
        <MetricSetId>dms-bp17p0qwtr72zmu*****</MetricSetId>
        <MetricSetName>connection issue diagnostics</MetricSetName>
        <Description>connection issue diagnostics</Description>
        <Type>User</Type>
        <ResourceType>instance</ResourceType>
        <MetricIds>Instance.DiskLoadFailure</MetricIds>
    </MetricSets>
</DescribeDiagnosticMetricSetsResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "NextToken" : "caeba0bbb2be03f84eb48b699f0a4883",
  "MetricSets" : [ {
    "MetricSetId" : "dms-bp17p0qwtr72zmu*****",
    "MetricSetName" : "connection issue diagnostics",
    "Description" : "connection issue diagnostics",
    "Type" : "User",
    "ResourceType" : "instance",
    "MetricIds" : [ "Instance.DiskLoadFailure" ]
  } ]
}

Error codes

For a list of error codes, see Service error codes.