DescribeDiagnosticMetrics API for querying diagnostic metrics - Elastic Compute Service - Alibaba Cloud - Elastic Compute Service

Queries diagnostic metrics.

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:DescribeDiagnosticMetrics

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID pf the diagnostic metric. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
MetricIds	array	No	The ID of diagnostic metrics.
	string	No	The ID of diagnostic metric N.	Instance.DiskLoadFailure
ResourceType	string	No	The resource type supported by the diagnostic metric.	instance
NextToken	string	No	The pagination token that is used in the 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`.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	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 you set this parameter to a value that 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	A pagination token. It can be used in the next request to retrieve a new page of results.	caeba0bbb2be03f84eb48b699f0a4883
Metrics	array<object>	The diagnostic metrics.
	object	The diagnostic metric.
MetricId	string	The ID of the diagnostic metric.	GuestOS.WinFirewall
MetricName	string	The name of the diagnostic metric.	CPU诊断
MetricCategory	string	The category of the diagnostic metric.	CPU
Description	string	The description of the diagnostic metric.	CPU诊断
ResourceType	string	The resource type supported by the diagnostic metric.	instance
GuestMetric	boolean	Indicates whether the diagnostic metric needs to be assessed by running a Cloud Assistant command in a guest operating system.	true
SupportedOperatingSystem	string	The operating system type supported by the diagnostic metric. Valid values: Windows Linux All: Windows and Linux	ALL

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Metrics": [
    {
      "MetricId": "GuestOS.WinFirewall",
      "MetricName": "CPU诊断",
      "MetricCategory": "CPU",
      "Description": "CPU诊断",
      "ResourceType": "instance",
      "GuestMetric": true,
      "SupportedOperatingSystem": "ALL"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.