Querying the Quotas of an Account

Function

This API is used to query the quotas of a specified account.

The API can be called using both the global endpoint and region-specific endpoints. For IAM endpoints, see Regions and Endpoints.

Debugging

You can debug this API in API Explorer.

URI

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

**Table 1** URI parameters
Parameter	Mandatory	Type	Description
domain_id	Yes	String	Account ID. For details about how to obtain the account ID, see Obtaining Account, IAM User, Group, Project, Region, and Agency Information.

**Table 2** Query parameters
Parameter	Mandatory	Type	Description
type	No	String	Type of the quota to be queried. If this parameter is not specified, all types of quotas are returned. Options: user: IAM users group: user groups idp: identity providers agency: agencies policy: custom policies assigment_group_mp: maximum number of permissions that can be assigned to a user group for an IAM project assigment_agency_mp: maximum number of permissions that can be assigned to an agency assigment_group_ep: maximum number of permissions that can be assigned to a user group for an enterprise project assigment_user_ep: maximum number of permissions that can be assigned to a user for an enterprise project mapping: mapping rule quota for all identity providers in the account

Request Parameters

**Table 3** Parameters in the request header
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	IAM user token (no special permission requirements).

Response Parameters

Status code: 200

**Table 4** Parameters in the response body
Parameter	Type	Description
quotas	Object	Quota information of the account.

**Table 5** quotas
Parameter	Type	Description
resources	Array of objects	Resource information.

**Table 6** resources
Parameter	Type	Description
max	Integer	Maximum quota.
min	Integer	Minimum quota.
quota	Integer	Current quota.
type	String	Quota type.
used	Integer	Used quota. The number of used identity provider mapping rules is customized and is not returned.

Example Request

Request for querying the quotas of the account

GET https://iam.myhuaweicloud.com/v3.0/OS-QUOTA/domains/{domain_id}

Example Response

Status code: 200

The request is successful.

{ 
  "quotas" : { 
    "resources" : [ 
               { 
                  "max" : 1000, 
                  "min" : 50, 
                  "quota" : 50, 
                  "type" : "user", 
                  "used" : 10 
                }, 
               { 
                  "max" : 300, 
                  "min" : 10, 
                  "quota" : 20, 
                  "type" : "group", 
                  "used" : 8 
                }, 
               { 
                  "max" : 20, 
                  "min" : 10, 
                  "quota" : 10, 
                  "type" : "idp", 
                  "used" : 9 
                },
               { 
                  "max" : 300, 
                  "min" : 10, 
                  "quota" : 50, 
                  "type" : "agency", 
                  "used" : 12 
                }, 
               { 
                  "max" : 300, 
                  "min" : 128, 
                  "quota" : 200, 
                  "type" : "policy", 
                  "used" : 8 
                },
               { 
                  "max" : 500, 
                  "min" : 50, 
                  "quota" : 200, 
                  "type" : "assigment_group_mp", 
                  "used" : 8 
                },
               { 
                  "max" : 500, 
                  "min" : 50, 
                  "quota" : 200, 
                  "type" : "assigment_agency_mp", 
                  "used" : 8 
                },
               { 
                  "max" : 5000, 
                  "min" : 50, 
                  "quota" : 500, 
                  "type" : "assigment_group_ep", 
                  "used" : 8 
                },
               { 
                  "max" : 5000, 
                  "min" : 50, 
                  "quota" : 500, 
                  "type" : "assigment_user_ep", 
                  "used" : 8 
                },
               { 
                  "max" : 100, 
                  "min" : 10, 
                  "quota" : 10, 
                  "type" : "mapping", 
                  "used" : null 
                }
             ] 
            } 
}

Status code: 400

Invalid parameters.

{
  "error_msg" : "Request parameter %(key)s is invalid.",
  "error_code" : "IAM.0007"
}

Status code: 403

Access denied.

Example 1

{ 
   "error_msg" : "You are not authorized to perform the requested action.", 
   "error_code" : "IAM.0002" 
 }

Example 2

{ 
   "error_msg" : "Policy doesn't allow %(actions)s to be performed.", 
   "error_code" : "IAM.0003" 
 }

Status code: 404

The requested resource cannot be found.

{ 
  "error_msg" : "Could not find %(target)s: %(target_id)s.", 
  "error_code" : "IAM.0004" 
}

Status code: 500

Internal server error.

{ 
  "error_msg" : "An unexpected error prevented the server from fulfilling your request.", 
  "error_code" : "IAM.0006" 
}

Status Codes

Status Code	Description
200	The request is successful.
400	Invalid parameters.
401	Authentication failed.
403	Access denied.
404	The requested resource cannot be found.
500	Internal server error.