Call GetCloudMetricLogs to query performance metric logs - Elastic High Performance Computing - Alibaba Cloud - Elastic High Performance Computing

Reads CloudMetrics performance logs for an E-HPC cluster.

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

ehpc:GetCloudMetricLogs

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ClusterId	string	Yes	The cluster ID.	ehpc-hz-jeJki6****
From	integer	Yes	The beginning of the time range to query. Specify a UNIX timestamp in seconds.	1583907780
To	integer	Yes	The end of the time range to query. Specify a UNIX timestamp in seconds.	1583907790
Reverse	boolean	No	Indicates whether to return logs in reverse chronological order. Default value: false.	false
AggregationType	string	No	The data aggregation type. Valid values: sum: the sum of the data avg: the average value max: the maximum value min: the minimum value Aggregation is disabled by default.	avg
AggregationInterval	integer	No	The data aggregation interval. Unit: seconds. Valid values: 1, 10, 60, 600, and 3600. Default value: 1.	10
MetricScope	string	No	The dimensions of the performance metric. Valid values: machine process network disk	network
Filter	string	No	The filter conditions. A JSON-formatted string with the following supported keys: InstanceId: the ID of the node Hostname: the hostname of the node NetworkInterface: the name of the network interface DiskDevice: the name of the disk	{"Hostname":"compute000"}
MetricCategories	string	No	The performance metric categories to return. Separate multiple categories with commas (,). Valid values: cpu memory	cpu

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	015C2C4D-1884-4EB7-BCD3-C5BB8D7E56DB
MetricLogs	object
MetricLog	array<object>	The queried performance metric data.
	object
Time	integer	The timestamp of the log entry. Returned as a UNIX timestamp in seconds.	1583907780
DiskDevice	string	The name of the disk.	vda1
NetworkInterface	string	The name of the network interface.	eth1
MetricData	string	A JSON-formatted string containing performance metric data across multiple categories.	{\"process\|cpusage\":0,\"process\|cpuser\":0,\"process\|cpusys\":0,******}
Hostname	string	The hostname of the node.	compute000
InstanceId	string	The node ID.	i-bp132g97g7zwnvta****

Examples

Success response

JSON format

{
  "RequestId": "015C2C4D-1884-4EB7-BCD3-C5BB8D7E56DB",
  "MetricLogs": {
    "MetricLog": [
      {
        "Time": 1583907780,
        "DiskDevice": "vda1",
        "NetworkInterface": "eth1",
        "MetricData": "{\\\"process|cpusage\\\":0,\\\"process|cpuser\\\":0,\\\"process|cpusys\\\":0,******}",
        "Hostname": "compute000",
        "InstanceId": "i-bp132g97g7zwnvta****"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParams	The specified parameter %s is invalid.	The specified parameter %s is invalid.
400	NotEnabled	You have not enabled this service	You have not enabled this service
400	InDebt	Your account has overdue payments.	Your account has overdue payments.
500	UnknownError	An unknown error occurred.	An unknown error occurred.
403	InvalidClusterStatus	The operation failed due to invalid cluster status.	The cluster status does not support the operation.
403	ConflictOpt	A conflicting operation is running.	A conflicting operation is running. Please try again later.
404	ClusterNotFound	The specified cluster does not exist.	The specified instance does not exist.
404	ObjectNotFound	The specified object is not found.	The specified object does not exist. Please verify the parameter.
503	ServiceUnavailable	The request has failed due to a temporary failure of the server	The request has failed due to a temporary failure of the server.
406	SlsError	SLS API request failed.	Failed to request the SLS interface.
406	AgentError	The agent service request failed.	The cluster-side command failed to run. %s
406	AliyunError	An Alibaba Cloud product error occurred.	Alibaba Cloud product error. %s
406	ExecFail	Failed to execute the command: %s.
407	NotAuthorized	You are not authorized by RAM for this request.	The request is not authorized by RAM.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.