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

最近更新时间: 2026-10-11 00:12:04

1. 接口描述

接口请求域名： tsf.api3.fincloud.tencent.com。

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

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

接口更新时间：2025-08-06 23:23:55。

接口只验签名不鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

错误码	描述
MissingParameter.GatewayParameterRequired	缺少请求参数:%s。

5. 示例

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

输入示例

POST / HTTP/1.1
Host: tsf.api3.fincloud.tencent.com
Content-Type: application/json
X-TC-Action: DescribePluginInstances
<Common Parameters>

{
  "ScopeValue": "grp-v446jrhc",
  "Bound": true,
  "Offset": 0,
  "Limit": 10,
  "Type": "QQMiniProgramLogin",
  "SearchWord": "pgnName"
}

输出示例

{
  "Response": {
    "RequestId": "b6b81196-b506-4758-a2ea-80ee688cf3b3",
    "Result": {
      "Content": [
        {
          "CreatedTime": "2023-11-28 16:11:28",
          "Description": "This is desc",
          "Id": "pgn-if8otbfp",
          "Name": "pgnName",
          "Status": "released",
          "Type": "QQMiniProgramLogin",
          "UpdatedTime": "2023-11-28 16:11:27"
        }
      ],
      "TotalCount": 1
    }
  }
}