Abnormal Change Order Metrics Reference - Serverless App Engine - Alibaba Cloud - Serverless App Engine

To retrieve the top N applications with abnormal change orders, call the GetChangeOrderMetric API.

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:GetChangeOrderMetric

none

*All Resource

*

None

Request syntax

GET /pop/v1/sam/getChangeOrderMetric HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The ID of the region.	cn-hangzhou
CreateTime	string	Yes	The start time when the change order was created.	1661152748883
OrderBy	string	Yes	The field by which to sort the query results. The value of this parameter must be a field in the response parameters.	errorPercent
Limit	integer	Yes	The number of entries to return. Valid values: 0 to 100.	10
AppSource	string	No	The type of the SAE application. micro_service web job	micro_service
CpuStrategy	string	No	The CPU allocation policy. request: CPU is allocated only when a request is received. always: A fixed amount of CPU is always allocated.	always
AppId	string	No	The ID of the application.
CoType	string	No	The type of the change order.

Response elements

Element	Type	Description	Example
	object
Message	string	The response message. Returns success if the request is successful. Returns an error code if the request fails.	success
RequestId	string	The request ID.	3B763F98-0BA2-5C23-B6B8-558568D2****
Data	array<object>	The list of application information.
	object	The application information.
AppId	string	The application ID.	7171a6ca-d1cd-4928-8642-7d5cfe69****
Name	string	The application name.	test
RegionId	string	The namespace ID.	cn-hangzhou
Total	integer	The total number of change orders.	4
Error	integer	The number of failed change orders.	1
ErrorPercent	number	The percentage of failed change orders.	0.25
TaskTimeCostMsAvg	string	The average task duration, in milliseconds.
OptimizeSuggestions	string	The optimization suggestions.
MaxTimeCostMs	number	The maximum duration, in milliseconds.
AvgTimeCostMs	number	The average duration of a change order, in milliseconds.
Code	string	The HTTP status code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client-side error occurred. 5xx: A server-side error occurred.	200
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	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",
      "Total": 4,
      "Error": 1,
      "ErrorPercent": 0.25,
      "TaskTimeCostMsAvg": "",
      "OptimizeSuggestions": "",
      "MaxTimeCostMs": 0,
      "AvgTimeCostMs": 0
    }
  ],
  "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.