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

Querying Quotas

Function

This API is used to query the alarm rule quota and the number of alarm rules that have been created.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

GET /V1.0/{project_id}/quotas

  • Parameter description
    Table 1 Parameter description

    Parameter

    Mandatory

    Description

    project_id

    Yes

    Specifies the project ID.

    For details about how to obtain the project ID, see Obtaining a Project ID.

  • Example: Query the alarm rule quota.
    GET https://{Cloud Eye endpoint}/V1.0/{project_id}/quotas

Request

None

Response

  • Response parameters
    Table 2 Response parameters

    Parameter

    Type

    Description

    quotas

    Object

    Specifies the quota list.

    For details, see Table 3.

    Table 3 Data structure description of quotas

    Parameter

    Type

    Description

    resources

    Array of objects

    Specifies the resource quota list.

    For details, see Table 4.

    Table 4 Data structure description of resources

    Parameter

    Type

    Description

    type

    String

    Specifies the quota type.

    alarm indicates the alarm rule.

    used

    Integer

    Specifies the used amount of the quota.

    unit

    String

    Specifies the quota unit.

    quota

    Integer

    Specifies the total amount of the quota.

  • Example response
    { 
    "quotas": 
        { 
        "resources": [
                {
                    "unit":"",
                    "type":"alarm",
                    "quota":1000,
                    "used":10 
                }
            ]
        } 
    }

Returned Values

  • Normal

    200

  • Abnormal

    Returned Value

    Description

    400 Bad Request

    Request error.

    401 Unauthorized

    The authentication information is not provided or is incorrect.

    403 Forbidden

    Access to the requested page is forbidden.

    408 Request Timeout

    The request timed out.

    429 Too Many Requests

    Concurrent requests are excessive.

    500 Internal Server Error

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

    503 Service Unavailable

    The service is currently unavailable.

Error Codes

See Error Codes.