查询插件列表和详情

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

我的收藏

1. 接口描述

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

展示插件列表和详情,支持分页,支持按照插件类型查询,支持按照插件ID批量查询,支持按照插件名称查询。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribePlugins。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
PluginIds.N Array of String 要查询的插件列表。
示例值:plugin-2nuhovb7
PluginName String 要查询的插件名称。
示例值:myplugin
PluginType String 要查询的插件类型。
示例值:IPControl
Limit Integer 返回数量,默认为 20,最大值为 100。
示例值:20
Offset Integer 偏移量,默认为 0。
示例值:0
Filters.N Array of Filter 过滤条件。预留字段,目前不支持过滤。

3. 输出参数

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

4. 示例

示例1 DescribePlugins

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribePlugins
&PluginIds.0=plugin-2nuhovb7
&PluginName=myplugin
&PluginType=IPControl
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "PluginSet": [
                {
                    "PluginId": "plugin-2nuhovb7",
                    "PluginName": "myplugin",
                    "PluginType": "IPControl",
                    "Description": "IPControl",
                    "PluginData": "{\"blocks\":\"1.1.1.12\",\"type\":\"black_list\"}",
                    "CreatedTime": "2021-01-25T10:15:21Z",
                    "ModifiedTime": "2021-01-25T10:15:21Z",
                    "AttachedApiTotalCount": 1,
                    "AttachedApis": [
                        {
                            "ServiceId": "service-jzo37opy",
                            "ServiceName": "clareplugin",
                            "ServiceDesc": "",
                            "ApiId": "api-buz84890",
                            "ApiName": "mock",
                            "ApiDesc": "",
                            "Environment": "release",
                            "AttachedTime": "2021-01-25T12:50:32Z"
                        }
                    ]
                }
            ]
        },
        "RequestId": "e2cc60e0-c1d9-4b11-97f9-d772ab3b0b6c"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError.CamException CAM内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue 参数取值错误。
InvalidParameterValue.InvalidFilterNotSupportedName 参数取值错误。
InvalidParameterValue.InvalidRegion 地域错误。
ResourceNotFound.InvalidPlugin 插件不存在。
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.RequestPostError 请求Post失败