Updated on 2024-12-10 GMT+08:00

Object Model

This section describes the request throttling policy object model.

  • Operation Type indicates the operation that can be performed on a field.

    C: create; U: update; R: read

  • Mandatory indicates whether a field with the Operation Type of C is mandatory.
Table 1 Request throttling policy object model

Parameter

Type

Description

Operation Type

Mandatory

id

String

ID of a request throttling policy

R

-

name

String

Name of a request throttling policy

CRU

Yes

project_id

String

ID of the tenant that creates the request throttling policy

-

-

api_call_limits

Integer

Maximum number of times an API can be accessed within a specified period

CRU

Yes

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.

CRU

No

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 or equal to that of user_call_limits.

CRU

No

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 or equal to that of api_call_limits.

CRU

No

time_interval

Integer

Period of time for limiting the number of API calls

CRU

Yes

time_unit

String

Time unit, which can be:

  • SECOND
  • MINUTE
  • HOUR
  • DAY

CRU

Yes

create_time

Timestamp

Time when the request throttling policy is created

R

-

remark

String

Description of the request throttling policy

CRU

No

type

Integer

Type of the request throttling policy, which can be:

  • 1: exclusive
  • 2: shared

CRU

No