Querying a Resource Quota

Function

This API is used to query a resource quota. You can query the quota of users, user groups, identity providers, agencies, and policies.

URI

  • URI format

    GET /v3.0/OS-QUOTA/domains/{domain_id}

  • URI parameters

    Parameter

    Mandatory

    Type

    Description

    domain_id

    Yes

    String

    ID of the domain whose quota is to be queried.

    type

    No

    String

    Type of the quota to be queried. The value can be user, group, idp, agency, and policy.

Request Parameters

  • Parameters in the request header

    Parameter

    Mandatory

    Type

    Description

    X-Auth-Token

    Yes

    String

    User token (no special permission requirements).

  • Example request

    GET https://sample.domain.com/v3.0/OS-QUOTA/domains/{domain_id}?type=group
    

Response Parameters

Table 1 Parameters in the response body

Parameter

Type

Description

quotas

Object

Quota information of the domain.

Table 2 quotas

Parameter

Type

Description

resources

Array of objects

Resource information.

Table 3 resources

Parameter

Type

Description

max

Integer

Maximum quota.

min

Integer

Minimum quota.

quota

Integer

Current quota.

type

String

Quota type.

used

Integer

Used quota.

  • Example response

    Group quota:
    {
        "quotas": {
            "resources": [
                {
                    "max": 200,
                    "min": 10,
                    "quota": 20,
                    "type": "group",
                    "used": 6
                }
            ]
        }
    }
    

Status Codes

Status Code

Description

200

The request is successful.

400

The server failed to process the request.

401

Authentication failed.

403

Access denied.

500

Internal server error.

503

Service unavailable.