DescribeDiagnosticMetrics - Elastic Compute Service - Alibaba Cloud Documentation Center

Queries diagnostic metrics.

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The IDs of diagnostic metrics.	cn-hangzhou
MetricIds	array	No	The ID of diagnostic metric.
	string	No	The resource type supported by the diagnostic metric.	Instance.DiskLoadFailure
ResourceType	string	No	The query token. Set the value to the `NextToken` value returned in the last call to the DescribeDiagnosticMetrics operation. Leave this parameter empty the first time you call this operation. Enumeration Value: instance	instance
NextToken	string	No	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.	caeba0bbb2be03f84eb48b699f0a4883
MaxResults	integer	No	The ID of the request.	10

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The query token returned in this call.	473469C7-AA6F-4DC5-B3DB-A3DC0DE*****
NextToken	string	The list of diagnostic metrics.	caeba0bbb2be03f84eb48b699f0a4883
Metrics	object []	The ID of the diagnostic metric.
MetricId	string	The name of the diagnostic metric.	GuestOS.WinFirewall
MetricName	string	CPU diagnostic	The category of the diagnostic metric.
MetricCategory	string	The description of the diagnostic metric.	CPU
Description	string	CPU diagnostic	The resource type supported by the diagnostic metric.
ResourceType	string	Indicates whether the diagnostic metric needs to be assessed by running a Cloud Assistant command in a guest operating system.	instance
GuestMetric	boolean	The operating system type supported by the diagnostic metric. Valid values: Windows Linux All: both Windows and Linux	true

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE*****",
  "NextToken": "caeba0bbb2be03f84eb48b699f0a4883",
  "Metrics": [
    {
      "MetricId": "GuestOS.WinFirewall",
      "MetricName": "The category of the diagnostic metric.\n",
      "MetricCategory": "CPU",
      "Description": "The resource type supported by the diagnostic metric.\n",
      "ResourceType": "instance",
      "GuestMetric": true,
      "SupportedOperatingSystem": "ALL"
    }
  ]
}

Error codes

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

Change history

Change time	Summary of changes	Operation
2022-07-21	Add Operation	see changesets