All Products
Search
Document Center

:GetScaleAppMetric

Last Updated:Dec 05, 2024

Queries the top N applications in which auto scaling takes effect.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
sae:GetScaleAppMetricnone
*All Resources
*
    none
none

Request syntax

GET /pop/v1/sam/getScaleAppMetric HTTP/1.1

Request parameters

ParameterTypeRequiredDescriptionExample
RegionIdstringNo

The region ID.

cn-hangzhou
LimitlongYes

The number of entries to return. Valid values: 0 to 100.

10
AppSourcestringNo

The SAE application type. Valid values:

  • micro_service
  • web
  • job
micro_service
CpuStrategystringNo

The CPU allocation policy. Valid values:

  • request: CPU cores are allocated only when a request is initiated.
  • always: Fixed CPU cores are always allocated.
always

Response parameters

ParameterTypeDescriptionExample
object
Messagestring

The additional information that is returned. The following limits are imposed on the ID:

  • success: If the call is successful, success is returned.
  • An error code: If the call fails, an error code is returned.
success
RequestIdstring

The request ID.

3B763F98-0BA2-5C23-B6B8-558568D2C1C2
Dataarray<object>

The details of applications.

ScaleAppMetricDtoobject

The details of the application.

AppIdstring

The application ID.

7171a6ca-d1cd-4928-8642-7d5cfe69****
Namestring

The application name.

test
RegionIdstring

The namespace ID.

cn-hangzhou
Runningslong

The current number of instances.

10
MaxReplicaslong

The maximum number of instances.

10
Codestring

The HTTP status code. The following limits are imposed on the ID:

  • 2xx: The call was successful.
  • 3xx: The call was redirected.
  • 4xx: The call failed.
  • 5xx: A server error occurred.
200
Successboolean

Indicates whether the microservice list was obtained. The following limits are imposed on the ID:

  • true: The namespaces were obtained.
  • false: no
true

Examples

Sample success responses

JSONformat

{
  "Message": "success",
  "RequestId": "3B763F98-0BA2-5C23-B6B8-558568D2C1C2",
  "Data": [
    {
      "AppId": "7171a6ca-d1cd-4928-8642-7d5cfe69****",
      "Name": "test",
      "RegionId": "cn-hangzhou",
      "Runnings": 10,
      "MaxReplicas": 10
    }
  ],
  "Code": "200",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400InvalidParameter.NotEmptyYou must specify the parameter %s.
400InvalidParameter.ObviouslyThe specified parameter is invalid {%s}.
400InvalidParameter.WithMessageThe parameter is invalid {%s}: %s

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-28The Error code has changed. The request parameters of the API has changedView Change Details