Help Center/ ROMA Connect/ API Reference/ Service Integration APIs/ Client Quotas/ Querying Details of a Client Quota
Updated on 2023-06-29 GMT+08:00
View PDF
Share

Querying Details of a Client Quota

Function

Querying Details of a Client Quota

URI

GET /v2/{project_id}/apic/instances/{instance_id}/app-quotas/{app_quota_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Appendix > Obtaining a Project ID in the ROMA Connect API Reference.

instance_id

Yes

String

Instance ID.

app_quota_id

Yes

String

Client quota ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

app_quota_id

String

Client quota ID.

name

String

Quota name. The value contains 3 to 255 characters, including letters, digits, and underscores (_). The value must start with a letter.

call_limits

Integer

Maximum number of times a client quota can be called.

time_unit

String

Time unit. The options are SECOND (second), MINUTE (minute), HOURE (hour), and DAY (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 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 500

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

None

Example Responses

Status code: 200

OK

{
  "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:instance_id. 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: 404

Not Found

{
  "error_code" : "APIG.3093",
  "error_msg" : "App quota c900c5612dbe451bb43cbcc49cfaf2f3 does not exist"
}

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

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.

Parent topic: Client Quotas