Creating a client quota.
Function
This API is used to create a client quota.
URI
POST /v2/{project_id}/apic/instances/{instance_id}/app-quotas
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. |
Request 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). |
Parameter |
Mandatory |
Type |
Description |
---|---|---|---|
name |
Yes |
String |
Quota name. The value contains 3 to 255 characters, including letters, digits, and underscores (_). The value must start with a letter. Minimum: 3 Maximum: 255 |
call_limits |
Yes |
Integer |
Maximum number of times a client quota can be called. Minimum: 1 Maximum: 2147483647 |
time_unit |
Yes |
String |
Time unit. The options are SECOND (second), MINUTE (minute), HOURE (hour), and DAY (day). |
time_interval |
Yes |
Integer |
Unit of the time interval for throttling. Minimum: 1 Maximum: 2147483647 |
reset_time |
No |
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. |
remark |
No |
String |
Parameter description, which cannot contain < and >. Maximum: 255 |
Response Parameters
Status code: 201
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
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 401
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 403
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 404
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Status code: 500
Parameter |
Type |
Description |
---|---|---|
error_code |
String |
Error code. |
error_msg |
String |
Error description. |
Example Requests
{ "call_limits" : 1000, "name" : "ClientQuota_demo", "reset_time" : "2020-09-20 00:00:00", "time_interval" : 1, "time_unit" : "DAY" }
Example Responses
Status code: 201
OK
{ "app_quota_id" : "c900c5612dbe451bb43cbcc49cfaf2f3", "call_limits" : 1000, "create_time" : "2020-09-19T15:27:47.60571141+08:00", "name" : "ClientQuota_demo", "reset_time" : "2020-09-20 00:00:00", "time_interval" : 1, "time_unit" : "DAY" }
Status code: 400
Bad Request
{ "error_code" : "APIG.3325", "error_msg" : "The API quota name already exists" }
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.3030", "error_msg" : "The instance does not exist;id:f0fa1789-3b76-433b-a787-9892951c620ec" }
Status code: 500
Internal Server Error
{ "error_code" : "APIG.9999", "error_msg" : "System error" }
Status Codes
Status Code |
Description |
---|---|
201 |
OK |
400 |
Bad Request |
401 |
Unauthorized |
403 |
Forbidden |
404 |
Not Found |
500 |
Internal Server Error |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot