Monitor Top N App Performance via ARMS Metrics API - Serverless App Engine - Alibaba Cloud - Serverless App Engine

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

sae:GetArmsTopNMetric

none

*All Resource

*

None

Request syntax

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

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The field based on which you want to sort the returned entries.	cn-hangzhou
OrderBy	string	Yes	The number of entries to return. Valid values: 0 to 100.	count
Limit	integer	Yes	The beginning of the time range to query.	10
StartTime	integer	Yes	The end of the time range to query.	1675823135951
EndTime	integer	Yes	The SAE application type. Valid values: micro_service web job	1675824035951
AppSource	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.	micro_service
CpuStrategy	string	No	The additional information that is returned. Valid values: success: If the call is successful, success is returned. An error code: If the call fails, an error code is returned.	always

Response elements

Element	Type	Description	Example
	object
Message	string	The request ID.	success
RequestId	string	3B763F98-0BA2-5C23-B6B8-558568D2C1C2	3B763F98-0BA2-5C23-B6B8-558568D2****
Data	array<object>	The details of applications.
	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	integer	The total number of requests.	100
Error	integer	The number of errors.	0
Rt	integer	The average response time. Unit: milliseconds.	100
Code	string	The HTTP status code. Valid values: 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 application list was retrieved. Valid values: true: The namespaces were obtained. false: no	true

Examples

Success response

JSON format

{
  "Message": "success",
  "RequestId": "3B763F98-0BA2-5C23-B6B8-558568D2****",
  "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

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.