DescribePluginApis
最近更新时间: 2025-10-20 17:06:00
1. 接口描述
接口请求域名: apigateway.api3.fincloud.tencent.cn。
查询指定插件下绑定的API信息
默认接口请求频率限制:20次/秒。
接口更新时间:2021-07-07 10:19:32。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribePluginApis |
| Version | 是 | 否 | String | 公共参数,本接口取值:2018-08-08 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| PluginId | 是 | 否 | String | 查询的插件ID。 |
| Limit | 否 | 否 | Int64 | 返回数量,默认为 20,最大值为 100。 |
| Offset | 否 | 否 | Int64 | 偏移量,默认为 0。 |
| Filters | 否 | 否 | Array of Filter | 此参数对外不可见。 过滤条件。预留字段,目前不支持过滤。 |
| Order | 否 | 否 | String | 此参数对外不可见。 排序依据,默认按照插件绑定时间排序。 |
| OrderBy | 否 | 否 | String | 此参数对外不可见。 排序方式,默认倒序排序。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | AttachedApiSummary | 插件绑定的API列表信息。 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameter.FormatError | 参数格式错误。 |
| ResourceNotFound.InvalidPlugin | 插件不存在。 |
| UnauthorizedOperation.AccessResource | 您没有权限访问资源。 |