租户端 互联网中间件 微服务框架(TSF) 微服务网关相关接口 查询网关分组或API绑定(或未绑定)的插件列表

查询网关分组或API绑定(或未绑定)的插件列表

最近更新时间: 2026-09-17 00:04:00

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.cn。

分页查询网关分组/API绑定(或未绑定)的插件列表

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

接口更新时间:2024-09-14 11:55:39。

接口既验签名又鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribePluginInstances
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
ScopeValue String 分组或者API的ID
示例值:
Bound Bool 绑定: true; 未绑定: false
示例值:
Offset Int64 翻页偏移量
示例值:
Limit Int64 每页展示的条数
示例值:
Type String 插件类型
示例值:
SearchWord String 搜索关键字
示例值:

3. 输出参数

参数名称 类型 描述
Result TsfPageGatewayPlugin 插件信息列表
示例值:查看
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

该接口暂无业务逻辑相关的错误码,其他错误码详见公共错误码

5. 示例

示例1 查询分组已绑定的插件列表

输入示例

https://tsf.api3.<no value>/?Action=DescribePluginInstances
&ScopeValue=grp-83wrlmav
&Bound=true
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "fa153f44-22b6-4ea3-86ef-6e257d440f26",
        "Result": {
            "TotalCount": 1,
            "Content": [
                {
                    "Id": "pgn-33pk2soi",
                    "Name": "Tag认证插件",
                    "Type": "Tag",
                    "Description": "this is description",
                    "CreatedTime": "2019-11-02 15:43:09",
                    "UpdatedTime": "2019-11-02 17:30:51",
                    "Status": "drafted"
                }
            ]
        }
    }
}