Use DescribeDiagnosticMetricSets to query diagnostic metric sets - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries the list of resource diagnostic metric sets by calling DescribeDiagnosticMetricSets.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:DescribeDiagnosticMetricSets

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call DescribeRegions to query the most recent region list.	cn-hangzhou
MetricSetIds	array	No	The list of diagnostic metric set IDs.
	string	No	The list of diagnostic metric set IDs.	dms-uf6i0tv2refv8wz*****
Type	string	No	The type of the diagnostic metric set. Valid values: User: user. Common: common. Default value: User. Valid values: User : User. Common : Common.	User
ResourceType	string	No	The resource type.	instance
NextToken	string	No	The pagination token. Set this parameter to the value of `NextToken` returned in the previous call. You do not need to set this parameter for the first request.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The number of entries per page for a paged query. Maximum value: 100. Default value: If this parameter is not specified, the default value is 10. If the specified value is greater than 100, the default value is 100.	10

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
NextToken	string	The pagination token returned in this call.	caeba0bbb2be03f84eb48b699f0a4883
MetricSets	array<object>	The diagnostic metric sets.
	object
MetricSetId	string	The ID of the diagnostic metric set.	dms-bp17p0qwtr72zmu*****
MetricSetName	string	The name of the diagnostic metric set.	Remote connection diagnostics
Description	string	The description of the diagnostic metric set.	Remote connection diagnostics
Type	string	The type of the diagnostic metric set. Valid values: User: user. Common: common.	User
ResourceType	string	The supported resource type.	instance
MetricIds	array	The list of diagnostic metrics.
	string	The diagnostic metric.	Instance.DiskLoadFailure

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidMetricSetId.NotExist	The specified MetricSetId does not exist.	The specified MetricSetId does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.