文档中心>API 中心>API 网关>插件相关接口>展示插件相关的API列表

展示插件相关的API列表

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

我的收藏

1. 接口描述

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

展示插件相关的API列表,包括已绑定的和未绑定的API信息。

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

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 DescribeAllPluginApis

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeAllPluginApis
&PluginId=Plugin-23sdcda
&EnvironmentName=release
&ServiceId=service-jzo37opy
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 2,
            "ApiSet": [
                {
                    "ApiId": "api-hjqpe4dg",
                    "ApiName": "notbind",
                    "ApiType": "NORMAL",
                    "Path": "/notbind",
                    "Method": "GET",
                    "IsAttached": false,
                    "AttachedOtherPlugin": false
                },
                {
                    "ApiId": "api-1clczx66",
                    "ApiName": "mock2",
                    "ApiType": "NORMAL",
                    "Path": "/mock2",
                    "Method": "GET",
                    "IsAttached": false,
                    "AttachedOtherPlugin": true
                }
            ]
        },
        "RequestId": "5aaeb03a-8f00-4644-95e8-6307b1690aa2"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.FormatError 域名格式错误。
InvalidParameter.FormatError 参数格式错误。
InvalidParameterValue.InvalidFilterNotSupportedName 参数取值错误。
ResourceNotFound.InvalidPlugin 插件不存在。
ResourceNotFound.InvalidService 对应服务不可见。
UnauthorizedOperation.AccessResource 您没有权限访问资源。