GetArmsTopNMetric - - Alibaba Cloud Documentation Center

Queries the top N applications in Application Monitoring.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
sae:GetArmsTopNMetric	none	All Resources ``	none	none

Request syntax

GET /pop/v1/sam/getArmsTopNMetric HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-hangzhou
OrderBy	string	Yes	The field based on which you want to sort the returned entries.	count
Limit	long	Yes	The number of entries to return. Valid values: 0 to 100.	10
StartTime	long	Yes	The beginning of the time range to query.	1675823135951
EndTime	long	Yes	The end of the time range to query.	1675824035951
AppSource	string	No	The SAE application type. Valid values: micro_service web job	micro_service
CpuStrategy	string	No	The CPU allocation policy. Valid values: request: CPU cores are allocated only when a request is initiated. always: Fixed CPU cores are always allocated.	always

Response parameters

Parameter	Type	Description	Example
	object
Message	string	The additional information that is returned. The following limits are imposed on the ID: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.	success
RequestId	string	The request ID.	3B763F98-0BA2-5C23-B6B8-558568D2C1C2
Data	array<object>	The details of applications.
ArmsMetricDto	object	The details of the application.
AppId	string	The application ID.	7171a6ca-d1cd-4928-8642-7d5cfe69****
Name	string	The application name.	test
RegionId	string	The namespace ID.	cn-hangzhou
Count	long	The total number of requests.	100
Error	long	The number of errors.	0
Rt	long	The average response time. Unit: milliseconds.	100
Code	string	The HTTP status code. The following limits are imposed on the ID: 2xx: The call was successful. 3xx: The call was redirected. 4xx: The call failed. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the list of applications was obtained. The following limits are imposed on the ID: true: The namespaces were obtained. false: no	true

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "3B763F98-0BA2-5C23-B6B8-558568D2C1C2",
  "Data": [
    {
      "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
      "Name": "test",
      "RegionId": "cn-hangzhou",
      "Count": 100,
      "Error": 0,
      "Rt": 100
    }
  ],
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message
400	InvalidParameter.NotEmpty	You must specify the parameter %s.
400	InvalidParameter.Obviously	The specified parameter is invalid {%s}.
400	InvalidParameter.WithMessage	The parameter is invalid {%s}: %s

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

Change history

Change time	Summary of changes	Operation
2024-03-28	The Error code has changed. The request parameters of the API has changed	View Change Details