API上已绑定的插件

最近更新时间:2024-03-12 01:08:37

我的收藏

1. 接口描述

接口请求域名: apigateway.tencentcloudapi.com 。

展示API上已绑定的插件列表。

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

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePluginsByApi。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
ApiId String 要查询的API ID。
示例值:api-fa23vfd
ServiceId String 要查询的服务ID。
示例值:service-o5as3moe
EnvironmentName String 环境信息。
示例值:test
Limit Integer 返回数量,默认为 20,最大值为 100。
示例值:20
Offset Integer 偏移量,默认为 0。
示例值:0

3. 输出参数

参数名称 类型 描述
Result AttachedPluginSummary 插件可绑定的API列表信息。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 DescribeAvailablePluginApis

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribePluginsByApi
&ApiId=api-fa23vfd
&EnvironmentName=release
&ServiceId=service-o5as3moe
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "PluginSummary": [
                {
                    "PluginId": "plugin-9l0d4sdf",
                    "PluginName": "onlyname",
                    "PluginType": "IPControl",
                    "Description": "modifyDesc",
                    "PluginData": "{\"blocks\":\"1.1.1.1\",\"type\":\"black_list\"}",
                    "Environment": "release",
                    "AttachedTime": "2021-01-25T06:56:58Z"
                }
            ]
        },
        "RequestId": "4effd8e7-abd0-4f95-a881-301d68d9985e"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

错误码 描述
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.InvalidFilterNotSupportedName 参数取值错误。
ResourceNotFound.InvalidApi ApiId错误。
ResourceNotFound.InvalidService 对应服务不可见。
UnauthorizedOperation.AccessResource 您没有权限访问资源。
UnsupportedOperation.InvalidAction 接口错误。