Help Center> ROMA Connect> API Reference> Service Integration APIs> Request Throttling Policy Management> Creating a Request Throttling Policy
Updated on 2023-06-29 GMT+08:00
View PDF

Creating a Request Throttling Policy

Function

After an API goes online, the system attaches a request throttling policy to it by default. The API provider can change the request throttling policy based on the service capabilities and load of the API. A request throttling policy restricts the maximum number of times an API can be called within a specified period.

URI

POST /v2/{project_id}/apic/instances/{instance_id}/throttles

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.

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).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

app_call_limits

No

Integer

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than that of user_call_limits. The maximum value is 2,147,483,647. The value is a positive integer.

name

Yes

String

Request throttling policy name. The value contains 3 to 64 characters, including letters, digits, and underscores (_). It must start with a letter.

time_unit

Yes

String

Time unit for limiting the number of API calls.

remark

No

String

Description of the request throttling policy, which can contain a maximum of 255 characters.

api_call_limits

Yes

Integer

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. The value is a positive integer.

type

No

Integer

Type of the request throttling policy.

  • 1: basic, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

  • 2: shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

enable_adaptive_control

No

String

Whether to enable dynamic request throttling.

  • TRUE

  • FALSE

This parameter is currently not supported.

user_call_limits

No

Integer

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to that of api_call_limits. The maximum value is 2,147,483,647. The value is a positive integer.

time_interval

Yes

Integer

Period of time for limiting the number of API calls. This parameter applies with each of the preceding three API call limits. The maximum value is 2,147,483,647. The value is a positive integer.

ip_call_limits

No

Integer

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than that of api_call_limits. The maximum value is 2,147,483,647. The value is a positive integer.

Response Parameters

Status code: 201

Table 4 Response body parameters

Parameter

Type

Description

app_call_limits

Integer

Maximum number of times the API can be accessed by an app within the same period. The value of this parameter must be less than that of user_call_limits. The maximum value is 2,147,483,647. The value is a positive integer.

name

String

Request throttling policy name. The value contains 3 to 64 characters, including letters, digits, and underscores (_). It must start with a letter.

time_unit

String

Time unit for limiting the number of API calls.

remark

String

Description of the request throttling policy, which can contain a maximum of 255 characters.

api_call_limits

Integer

Maximum number of times an API can be accessed within a specified period. The value of this parameter cannot exceed the default limit 200 TPS. You can change the default limit to meet service requirements. The maximum value is 2,147,483,647. The value is a positive integer.

type

Integer

Type of the request throttling policy.

  • 1: basic, limiting the maximum number of times a single API bound to the policy can be called within the specified period.

  • 2: shared, limiting the maximum number of times all APIs bound to the policy can be called within the specified period.

enable_adaptive_control

String

Whether to enable dynamic request throttling.

  • TRUE

  • FALSE

This parameter is currently not supported.

user_call_limits

Integer

Maximum number of times the API can be accessed by a user within the same period. The value of this parameter must be less than or equal to that of api_call_limits. The maximum value is 2,147,483,647. The value is a positive integer.

time_interval

Integer

Period of time for limiting the number of API calls. This parameter applies with each of the preceding three API call limits. The maximum value is 2,147,483,647. The value is a positive integer.

ip_call_limits

Integer

Maximum number of times the API can be accessed by an IP address within the same period. The value of this parameter must be less than that of api_call_limits. The maximum value is 2,147,483,647. The value is a positive integer.

id

String

Request throttling policy ID.

bind_num

Integer

Number of APIs to which the request throttling policy has been bound.

is_inclu_special_throttle

Integer

Whether a special throttling configuration has been created:

  • 1: yes

  • 2: no

create_time

String

Creation time.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Status code: 404

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

{
  "api_call_limits" : 800,
  "app_call_limits" : 300,
  "enable_adaptive_control" : "FALSE",
  "ip_call_limits" : 600,
  "name" : "throttle_demo",
  "remark" : "Throttling Policy 1",
  "time_interval" : 1,
  "time_unit" : "SECOND",
  "type" : 1,
  "user_call_limits" : 0
}

Example Responses

Status code: 201

Created

{
  "name" : "throttle_demo",
  "create_time" : "2020-07-31T08:44:02.205366118Z",
  "remark" : "Throttling Policy 1",
  "type" : 1,
  "time_interval" : 1,
  "ip_call_limits" : 600,
  "app_call_limits" : 300,
  "time_unit" : "SECOND",
  "api_call_limits" : 800,
  "id" : "3437448ad06f4e0c91a224183116e965",
  "user_call_limits" : 0,
  "enable_adaptive_control" : "FALSE",
  "bind_num" : 0,
  "is_inclu_special_throttle" : 2
}

Status code: 400

Bad Request

{
  "error_code" : "APIG.2011",
  "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: 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

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Internal Server Error

Error Codes

See Error Codes.