GetEdgeContainerAppResourceStatus API Reference - Edge Security Acceleration - Alibaba Cloud - Edge Security Acceleration

Queries the resource distribution of an edge container application.

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

esa:GetEdgeContainerAppResourceStatus

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The application ID, which can be obtained by calling the ListEdgeContainerApps operation.	app-96253477062511****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	15C66C7B-671A-4297-9187-2C4477247A74
Regions	array<object>	The deployment regions.
	object	A deployment region object.
Region	string	Chinese mainland: East China: huadong South China: huanan Central China: huazhong North China: huabei Northwest China: xibei Southwest China: xinan Northeast China: dongbei Special Administrative Regions and Overseas: Taiwan, China: tw Macau, China: mo Hong Kong, China: hk Japan: jp United States: us Thailand: th Korea: kr Russia: ru Singapore: sg France: fr Spain: es Italy: it Sweden: se UAE: ae Indonesia: id Chile: cl Philippines: ph Malaysia: my Vietnam: vn Argentina: AR Australia: au Brazil: br Colombia: co Germany: de UK: GB Peru: pe Saudi Arabia: sa Netherlands: nl South Africa: za	huadong
Isp	string	The ISP. This parameter is empty for regions outside the Chinese mainland. Valid values: China Mobile: cmcc China Telecom: chinanet China Unicom: unicom	unicom
Total	integer	The total number of deployed replicas.	1
Ready	integer	The number of ready replicas.	1
IsStaging	boolean	Indicates whether the region is a staging environment.	false
IsOffline	boolean	Indicates whether graceful offline mode is enabled.	false

Examples

Success response

JSON format

{
  "RequestId": "15C66C7B-671A-4297-9187-2C4477247A74",
  "Regions": [
    {
      "Region": "huadong",
      "Isp": "unicom",
      "Total": 1,
      "Ready": 1,
      "IsStaging": false,
      "IsOffline": false
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter. Check the parameter configuration.	Invalid parameter. Check the parameter configuration.
400	InternalError	An internal exception occurred, please try again later.	An inner exception was triggered. Please try again later.
400	InvalidParameter.Appid	The format of the application ID is invalid. You can call ListEdgeContainerApps to obtain the application ID.	The format of the input application ID is incorrect. You can use the ListEdgeContainerApps API to obtain the application ID.
404	InvalidApp.NotFound	The application does not exist. Check whether the application ID you specified is correct and try again.	The application does not exist. Check whether the application ID you specified is correct and try again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.