GetAvailabilityMetric API Overview for Application Health Monitoring - Serverless App Engine - Alibaba Cloud - Serverless App Engine

Retrieves the top N applications with abnormal instances, sorted by the total number of abnormal instances.

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

none

*All Resource

*

None

Request syntax

GET /pop/v1/sam/getAvailabilityMetric HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-hangzhou
Limit	integer	Yes	The number of entries to return. Valid values: 0 to 100.	10
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 requests are received. always: CPU cores are always allocated.	always

Response elements

Element	Type	Description	Example
	object	The response parameters.
Message	string	The additional information returned. Valid values: success: The call succeeded. An error code: The call failed.	success
RequestId	string	The request ID.	3A92C4EA-4C53-5A1C-8AEB-F2DB1198****
Data	array<object>	The data entries returned.
	object	The details about the aggregation type.
AppId	string	The application ID.	017f39b8-dfa4-4e16-a84b-1dcee4b1****
Name	string	The application name.	test
RegionId	string	The namespace ID.	cn-hangzhou
Runnings	integer	The current number of instances.	1
Instances	integer	The expected number of instances.	0
ErrorInstances	integer	The number of abnormal instances.	0
EnableAutoscale	integer	Indicates whether auto scaling is enabled. Valid values: 1: Auto scaling is enabled. 0: Auto scaling is disabled.	0
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 list was retrieved. false: The list was not retrieved.	true

Examples

Success response

JSON format

{
  "Message": "success",
  "RequestId": "3A92C4EA-4C53-5A1C-8AEB-F2DB1198****",
  "Data": [
    {
      "AppId": "017f39b8-dfa4-4e16-a84b-1dcee4b1****",
      "Name": "test",
      "RegionId": "cn-hangzhou",
      "Runnings": 1,
      "Instances": 0,
      "ErrorInstances": 0,
      "EnableAutoscale": 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.