QueryResourceStatics API Overview for SAE Application Resource Usage - SAE

Queries the resource usage of an 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

sae:QueryResourceStatics

get

*All Resource

*

None

Request syntax

GET /pop/v1/paas/quota/queryResourceStatics HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
AppId	string	Yes	The ID of the application.	7171a6ca-d1cd-4928-8642-7d5cfe69****

Response elements

Element	Type	Description	Example
	object	The data returned.
RequestId	string	The ID of the request.	7CCF7092-72CA-4431-90D6-C7D98752****
Message	string	The returned message. If the request is successful, success is returned. If the request fails, an error code is returned.	success
TraceId	string	The trace ID of the request. You can use this ID to query the details of the request.	ac1a08a015623098794277264e****
Data	object	The resource usage details.
Summary	object	The resource usage in the current month.
Cu	number	The amount of used CUs.	2312145
Cpu	number	The CPU usage. Unit: core × min.	3354
Memory	number	The memory usage. Unit: GiB × min.	6708
ActiveCpu	number	The active vCPU usage. Unit: core × min.	10
IdleCpu	number	The idle vCPU usage. Unit: core × min.	10
EphemeralStorage	number	The ephemeral storage usage. Unit: GiB × min.	20
GpuA10	number		c8g1
GpuPpu810e	number
RealTimeRes	object	The real-time resource usage.
Cpu	number	The CPU usage. Unit: core × min.	13
Memory	number	The memory usage. Unit: GiB × min.	26
EphemeralStorage	number	The ephemeral storage usage. Unit: GiB × min.	0
ErrorCode	string	The error code. This parameter is not returned if the request is successful. This parameter is returned if the request fails. For more information, see the Error codes section in this topic.	空
Code	string	The HTTP status code. 2xx: The request was successful. 3xx: The request was redirected. 4xx: A client error occurred. 5xx: A server error occurred.	200
Success	boolean	Indicates whether the resource usage of the application was successfully queried. true: The query was successful. false: The query failed.	true

Examples

Success response

JSON format

{
  "RequestId": "7CCF7092-72CA-4431-90D6-C7D98752****",
  "Message": "success",
  "TraceId": "ac1a08a015623098794277264e****",
  "Data": {
    "Summary": {
      "Cu": 2312145,
      "Cpu": 3354,
      "Memory": 6708,
      "ActiveCpu": 10,
      "IdleCpu": 10,
      "EphemeralStorage": 20,
      "GpuA10": 0,
      "GpuPpu810e": 0
    },
    "RealTimeRes": {
      "Cpu": 13,
      "Memory": 26,
      "EphemeralStorage": 0
    }
  },
  "ErrorCode": "空",
  "Code": "200",
  "Success": true
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidServerlessRegion.Unsupported	The current region is not supported: %s
400	InvalidApplication.NotFound	The current application does not exist.
500	Measuredata.Query.Error	An error occurred while querying measurement information.	Error happen when querying measurement information.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.