Querying Credential Quotas¶

Function¶

This API is used to query credential quotas. Fuzzy query by name is supported.

Calling Method¶

For details, see Calling APIs.

URI¶

GET /v2/{project_id}/apigw/instances/{instance_id}/app-quotas

**Table 1** Path Parameters¶
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID. For details about how to obtain it, see Obtaining a Project ID.
instance_id	Yes	String	Gateway ID, which can be obtained from the gateway information on the APIG console.

**Table 2** Query Parameters¶
Parameter	Mandatory	Type	Description
offset	No	Long	Offset from which the query starts. If the value is less than 0, it is automatically converted to 0. Default: 0
limit	No	Integer	Number of items displayed on each page. A value less than or equal to 0 will be automatically converted to 20, and a value greater than 500 will be automatically converted to 500. Minimum: 1 Maximum: 500 Default: 20
name	No	String	Credential quota name.

Request Parameters¶

**Table 3** Request header parameters¶
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is a token.

Response Parameters¶

Status code: 200

**Table 4** Response body parameters¶
Parameter	Type	Description
size	Integer	Length of the returned resource list.
total	Long	Number of resources that match the query conditions.
quotas	Array of AppQuotaInfo objects	Credential quotas.

**Table 5** AppQuotaInfo¶
Parameter	Type	Description
app_quota_id	String	Credential quota ID.
name	String	Quota name. Enter 3 to 255 characters, starting with a letter. Only letters, digits, and underscores (_) are allowed.
call_limits	Integer	Maximum number of times a credential quota can be called.
time_unit	String	Time unit. The options are SECOND, MINUTE, HOUR, and DAY. Enumeration values: SECOND MINUTE HOUR DAY
time_interval	Integer	Time limit of a quota.
remark	String	Parameter description. Maximum: 255
reset_time	String	Time when the quota is reset for the first time. If this parameter is not specified, the time is calculated based on the first calling time by default.
create_time	String	Creation time.
bound_app_num	Integer	Number of applications bound to the quota policy.

Status code: 400

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

Status code: 401

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

Status code: 403

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

Status code: 500

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

Example Requests¶

None

Example Responses¶

Status code: 200

{
  "total" : 1,
  "size" : 1,
  "quotas" : [ {
    "app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3",
    "call_limits" : 1000,
    "create_time" : "2020-09-19T07:27:47Z",
    "name" : "ClientQuota_demo",
    "reset_time" : "2020-09-20 00:00:00 +0000 +0000",
    "time_interval" : 1,
    "time_unit" : "DAY"
  } ]
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2012",
  "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation"
}

Status code: 401

Unauthorized

{
  "error_code" : "APIG.1002",
  "error_msg" : "Incorrect token or token resolution failed"
}

Status code: 403

Forbidden

{
  "error_code" : "APIG.1005",
  "error_msg" : "No permissions to request this method"
}

Status code: 500

Internal Server Error

{
  "error_code" : "APIG.9999",
  "error_msg" : "System error"
}

Status Codes¶

Status Code	Description
200	OK
400	Bad Request
401	Unauthorized
403	Forbidden
500	Internal Server Error

Error Codes¶

See Error Codes.

last updated: 2024-11-13 13:54 UTC - commit: 0a62e5dc1182b13184917e7aa490e164e6eb655a