DescribeUsagePlansStatus
最近更新时间: 2025-10-20 17:05:59
1. 接口描述
接口请求域名: apigateway.api3.fincloud.tencent.cn。
本接口(DescribeUsagePlanStatus)用于查询使用计划的列表。
默认接口请求频率限制:20次/秒。
接口更新时间:2020-06-02 11:28:12。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeUsagePlansStatus |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-08-08 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Limit | 否 | 否 | Int64 | 返回数量,默认为 20,最大值为 100。 |
| Offset | 否 | 否 | Int64 | 偏移量,默认为 0。 |
| Filters | 否 | 否 | Array of Filter | 使用计划过滤条件。支持UsagePlanId、UsagePlanName、NotServiceId、NotApiId、Environment。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | UsagePlansStatus | 使用计划列表。 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue.InvalidFilterNotSupportedName | 参数取值错误。 |
| InvalidParameterValue.InvalidRegion | 地域错误。 |