All Products
Search
Document Center

Elastic Compute Service:DescribeDiagnosticMetricSets

Last Updated:Sep 29, 2024

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.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
ecs:DescribeDiagnosticMetricSetsget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringYes

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

cn-hangzhou
MetricSetIdsarrayNo

The ID of diagnostic metric set N.

stringNo

The ID of diagnostic metric set N.

dms-uf6i0tv2refv8wz*****
TypestringNo

The type of the diagnostic metric set. Valid values:

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

Default value: user.

User
ResourceTypestringNo

The resource type supported by the diagnostic metric set.

Enumeration Value:
  • instance
instance
NextTokenstringNo

The query token. Set the value to the NextToken value returned in the last call to the DescribeDiagnosticMetricSets operation. Leave this parameter empty the first time you call this operation.

caeba0bbb2be03f84eb48b699f0a4883
MaxResultsintegerNo

The maximum number of entries to return on each page. Maximum value: 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.
10

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
NextTokenstring

The query token returned in this call.

caeba0bbb2be03f84eb48b699f0a4883
MetricSetsarray<object>

A collection of diagnostic metrics.

MetricSetobject
MetricSetIdstring

The ID of the diagnostic metric set.

dms-bp17p0qwtr72zmu*****
MetricSetNamestring

The name of the diagnostic metric set.

connection issue diagnostics
Descriptionstring

The description of the diagnostic metric set.

connection issue diagnostics
Typestring

The type of the diagnostic metric set. Valid values:

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

The resource type supported by the diagnostic metric set.

instance
MetricIdsarray

The IDs of the diagnostic metrics.

MetricIdstring

The IDs of the diagnostic metrics.

Instance.DiskLoadFailure

Examples

Sample success responses

JSONformat

{
  "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, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2022-07-21Add OperationView Change Details