Querying IAM User Quota

Function

Queries quota of an IAM user. Only the root account can query the quota.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

GET /v1/{project_id}/user/quotas

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
limit	No	Integer	Number of items displayed on each page. Value range: 1~100 Default value: 10
offset	No	Integer	Offset where the query starts. Value range: 0~2147483647 Default value: 0
user_id	No	String	User ID.

Request Parameters

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	No	String	User token. This parameter is mandatory when token authentication is used. You can obtain the token by calling the IAM API used to obtain a user token. Value of X-Subject-Token in the response header.
Authorization	No	String	Authentication information. This parameter is mandatory for AK/SK authentication.
X-Sdk-Date	No	String	Time when the request is sent. This parameter is mandatory for AK/SK authentication. The format is YYYYMMDD'T'HHMMSS'Z'.
X-Project-Id	No	String	Project ID. This parameter is mandatory for AK/SK authentication.

Response Parameters

Status code: 200

**Table 4** Response header parameters
Parameter	Type	Description
X-Request-Id	String	Request ID.

**Table 5** Response body parameters
Parameter	Type	Description
count	Integer	Total number of member accounts. Value range: 0~2147483647
assets	Array of UserQuotaInfo objects	Member account list.

**Table 6** UserQuotaInfo
Parameter	Type	Description
user_id	String	Member account (user) ID.
quota	ListUserQuotaDetail object	Quota information
usage	ListUserQuotaDetail object	Usage information.

**Table 7** ListUserQuotaDetail
Parameter	Type	Description
modeling_count_2d_model	Integer	Number of virtual avatar training models. –1 indicates no limitation. Value range: -1~10000000
modeling_count_2d_model_flexus	Integer	Number of virtual avatar training models (Flexus edition). –1 indicates no limitation. Value range: -1~10000000
video_time_2d_model	Float	Time needed for virtual avatar video production, in minutes. –1 indicates no limitation. Value range: -1~999999999
video_time_flexus_2d_model	Float	Virtual avatar video (Flexus edition) duration, in minutes. –1 indicates no limitation. Value range: -1~999999999
voice_clone_basic	Integer	Voice cloning (basic edition). –1 indicates no limitation. Value range: -1~10000000
voice_clone_middle	Integer	Voice cloning (advanced edition). –1 indicates no limitation. Value range: -1~10000000
voice_clone_advance	Integer	Voice cloning (premium edition). –1 indicates no limitation. Value range: -1~10000000
voice_clone_flexus	Integer	Voice cloning (Flexus edition). –1 indicates no limitation. Value range: -1~10000000

Status code: 400

**Table 8** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 401

**Table 9** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 403

**Table 10** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Status code: 500

**Table 11** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

Example Requests

GET https://{endpoint}/v1/{projectId}/user/quotas

Example Responses

Status code: 400

Parameters error, including the error code and its description.

{
  "error_code" : "MSS.00000003",
  "error_msg" : "Invalid parameter"
}

Status code: 401

Authentication is not performed or fails.

{
  "error_code" : "MSS.00000001",
  "error_msg" : "Unauthorized"
}

Status code: 403

Not authorized.

{
  "error_code" : "MSS.00000005",
  "error_msg" : "Forbidden"
}

Status code: 500

Internal service error.

{
  "error_code" : "MSS.00000004",
  "error_msg" : "Internal Error"
}

Status Codes

Status Code	Description
200	Querying IAM user quota succeeded.
400	Parameters error, including the error code and its description.
401	Authentication is not performed or fails.
403	Not authorized.
500	Internal service error.