DescribeMetricList - Alibaba Cloud Linux - Alibaba Cloud Documentation Center

Operation description

The instance list returned by this operation contains only machines that are managed by SysOM. If an ECS instance exists but is not managed by SysOM, it does not appear in the list.

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

sysom:DescribeMetricList

get

*All Resource

*

None

Request syntax

GET /api/v1/openapi/proxy/get/describeMetricList HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
instance	string	No	The instance ID.	i-wz9d00ut2ska3mlyhn6j
metricName	string	No	The metric name.	sysom_cpu_graph
startTime	integer	No	The start time. The value is a UNIX timestamp in seconds.	1709740800000
endTime	integer	No	The end time. The value is a UNIX timestamp in seconds.	1683618245000

Response elements

Element	Type	Description	Example
	object	The response parameters.
code	string	The status code. If `code == Success`, the authorization is successful. Other status codes indicate that the authorization failed. Check the `message` field for the detailed fault information.	Success
data	array<object>	The response data.
	object	The response data.
labels	string	The metric labels.	{'taskExecName': 'build-and-deploy', 'pipelineName': 'pipeline-run-1722909642357'}
metricName	string	The metric name.	sysom_cpu_usage_idle
values	array	The metric data.
	array	A data point in the format of [, ].	["1743036429.0", "10489572.0"]
	string	The timestamp or value.	1743036429.0
message	string	The error message. If `code == Success`, this field is empty. Otherwise, this field contains the request error information.	Analysis ID: 56dae746-ef55-4f77-8373-cb3594c41457 Analysis failed for machine i-bp164ns76pzirbwv0snt. Failure reason: Not get GPU trace data for '56dae746-ef55-4f77-8373-cb3594c41457' '['93811']'!
requestId	string	Id of the request	2D693121-C925-5154-8DF6-C09A8B369822

Examples

Success response

JSON format

{
  "code": "Success",
  "data": [
    {
      "labels": "{'taskExecName': 'build-and-deploy', 'pipelineName': 'pipeline-run-1722909642357'}",
      "metricName": "sysom_cpu_usage_idle",
      "values": [
        [
          "1743036429.0"
        ]
      ]
    }
  ],
  "message": "Analysis ID: 56dae746-ef55-4f77-8373-cb3594c41457\nAnalysis failed for machine i-bp164ns76pzirbwv0snt. Failure reason: Not get GPU trace data for '56dae746-ef55-4f77-8373-cb3594c41457' '['93811']'!",
  "requestId": "2D693121-C925-5154-8DF6-C09A8B369822\n"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.