API traffic governance

Updated at:
Copy as MD

This topic lists all OpenAPI operations for API traffic governance, along with their request and response parameters.

Edit a rate limiting configuration

The sofa.apigateway.api.limitconfig.update operation edits the rate limiting configuration for a specified API.

Request parameters

Name

Type

Required

Example

Description

api_id

STRING

Yes

NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSr****

The API ID.

limit_config

LimitConfigVO

No

-

The rate limiting configuration.

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

Response parameters

Name

Type

Example

Description

data

BOOLEAN

true, false

data

Update rate limiting for an authorized application

The sofa.apigateway.api.authapplimit.update operation updates the rate limiting configuration for a specified authorized application.

Request parameters

Name

Type

Required

Example

Description

api_id

STRING

No

api_id1

The API ID.

auth_app_info_id

STRING

No

auth_app_info_id1

The authorized application ID.

limit_config

LimitConfigVO

No

-

The rate limiting configuration.

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

Response parameters

Name

Type

Example

Description

data

BOOLEAN

-

data

Query rate limiting for an authorized application

The sofa.apigateway.api.authapplimit.get operation queries the rate limiting configuration for a specified authorized application.

Request parameters

Name

Type

Required

Example

Description

api_id

STRING

No

api_id1

The API ID.

auth_app_info_id

STRING

No

auth_app_info_id1

The authorized application ID.

tenant_id

STRING

No

TSCPDICNT

The tenant ID.

workspace_id

STRING

No

default

The workspace ID.

Response parameters

Name

Type

Example

Description

data

LimitConfigVO

-

data