全部产品

API 流量治理

更新时间:2020-04-21 11:33:47

本文列出了 API 流量治理相关的所有 OpenAPI 及其请求参数、返回参数。

编辑限流配置

sofa.apigateway.api.limitconfig.update 用于编辑指定 ID 的 API 的限流配置。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSrsQw3 API 标识
limit_config LimitConfigVO - 限流配置
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN true, false data

更新授权应用限流

sofa.apigateway.api.authapplimit.update 用于更新指定授权应用的限流配置。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING api_id1 API 标识
auth_app_info_id STRING auth_app_info_id1 授权应用标识
limit_config LimitConfigVO - 限流配置
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN - data

查询授权应用限制

sofa.apigateway.api.authapplimit.get 用于查询指定授权应用的限流配置信息。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING api_id1 API ID
auth_app_info_id STRING auth_app_info_id1 授权应用标识
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data LimitConfigVO - data

更新 API 缓存信息

sofa.apigateway.api.cacheinfo.update 用于更新指定 ID 的 API 缓存配置信息。

请求参数

名称 类型 是否必填 示例 描述
api_id STRING NQ3MMyVqDX6Jkbb7sj6Sm4UoYRSrsQw3 API 标识
param ApiCacheVO - 缓存配置信息
tenant_id STRING TSCPDICNT 租户标识
workspace_id STRING default 工作空间标识

返回参数

名称 类型 示例 描述
data BOOLEAN - data