Updated on 2022-08-15 GMT+08:00

Querying AS Quotas

Function

This API is used to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.

URI

GET /autoscaling-api/v1/{project_id}/quotas

Table 1 Parameter description

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the project ID.

Request Message

  • Request parameters

    None

  • Example request

    This example shows how to query the total quotas and used quotas of AS groups, AS configurations, bandwidth scaling policies, AS policies, and instances for a specified tenant.

    GET https://{Endpoint}/autoscaling-api/v1/{project_id}/quotas

Response Message

  • Response parameters
    Table 2 Response parameters

    Parameter

    Type

    Description

    quotas

    quotas object

    Specifies quota details. For details, see Table 3.

    Table 3 quotas field description

    Parameter

    Type

    Description

    resources

    Array of resources objects

    Specifies resources. For details, see Table 4.

    Table 4 resources field description

    Parameter

    Type

    Description

    type

    String

    Specifies the quota type.

    • scaling_Group: AS group quota
    • scaling_Config: AS configuration quota
    • scaling_Policy: AS policy quota
    • scaling_Instance: instance quota
    • bandwidth_scaling_policy: bandwidth scaling policy quota

    used

    Integer

    Specifies the used amount of the quota.

    When type is set to scaling_Policy or scaling_Instance, this parameter is reserved, and the system returns -1 as the parameter value. You can query the used quota of AS policies and AS instances in a specified AS group. For details, see Querying AS policy and instance quotas.

    quota

    Integer

    Specifies the total quota.

    max

    Integer

    Specifies the quota upper limit.

    min

    Integer

    Specifies the quota lower limit.

  • Example response
    {
        "quotas": {
            "resources": [
                {
                    "type": "scaling_Group",
                    "used": 2,
                    "quota": 25,
                    "max": 50,
                    "min": 0
                },
                {
                    "type": "scaling_Config",
                    "used": 3,
                    "quota": 100,
                    "max": 200,
                    "min": 0
                },
                {
                    "type": "scaling_Policy",
                    "used": -1,
                    "quota": 50,
                    "max": 50,
                    "min": 0
                },
                {
                    "type": "scaling_Instance",
                    "used": -1,
                    "quota": 200,
                    "max": 1000,
                    "min": 0
                },
                {
                    "type": "bandwidth_scaling_policy",
                    "used": 1,
                    "quota": 10,
                    "max": 100,
                    "min": 0
                }
            ]
        }
    }

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    The server failed to process the request.

    401 Unauthorized

    You must enter the username and password to access the requested page.

    403 Forbidden

    You are forbidden to access the requested page.

    404 Not Found

    The server could not find the requested page.

    405 Method Not Allowed

    You are not allowed to use the method specified in the request.

    406 Not Acceptable

    The response generated by the server could not be accepted by the client.

    407 Proxy Authentication Required

    You must use the proxy server for authentication so that the request can be processed.

    408 Request Timeout

    The request timed out.

    409 Conflict

    The request could not be processed due to a conflict.

    500 Internal Server Error

    Failed to complete the request because of an internal service error.

    501 Not Implemented

    Failed to complete the request because the server does not support the requested function.

    502 Bad Gateway

    Failed to complete the request because the request is invalid.

    503 Service Unavailable

    Failed to complete the request because the system is unavailable.

    504 Gateway Timeout

    A gateway timeout error occurred.

Error Codes

See Error Codes.