查询 API 使用计划详情

最近更新时间: 2024-10-18 10:38:32

1. 接口描述

接口请求域名: apigateway.api3.fincloud.tencent.cn。

本接口(DescribeApiUsagePlan)用于查询服务中 API 使用计划详情。 服务若需要鉴权限流生效,则需要绑定使用计划到此服务中,本接口用于查询绑定到一个服务及其中 API 的所有使用计划。

默认接口请求频率限制:20次/秒。

接口更新时间:2020-05-28 16:04:21。

接口只验签名不鉴权。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeApiUsagePlan
Version String 公共参数,本接口取值:2018-08-08
Region String 公共参数,详见产品支持的地域列表(TODO)
ServiceId String 待查询的服务唯一 ID。
Limit Int64 返回数量,默认为 20,最大值为 100。
Offset Int64 偏移量,默认为 0。

3. 输出参数

参数名称 类型 描述
Result ApiUsagePlanSet api绑定使用计划列表。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码

错误码 描述
ResourceNotFound.InvalidService
InvalidParameter.FormatError
InternalError.OssException