查询某个插件下绑定或未绑定的API分组

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

1. 接口描述

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

查询某个插件下绑定或未绑定的API分组

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

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

接口只验签名不鉴权。

2. 输入参数

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

参数名称	必选	允许NULL	类型	描述
Action	是	否	String	公共参数，本接口取值：DescribeGroupsWithPlugin
Version	是	否	String	公共参数，本接口取值：2018-03-26
Region	是	否	String	公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表
Limit	是	否	Int64	每页记录数量示例值：
Bound	是	否	Bool	绑定/未绑定: true / false 示例值：
SearchWord	否	否	String	搜索关键字示例值：
GatewayInstanceId	否	否	String	网关实体ID 示例值：
PluginId	是	否	String	插件ID 示例值：
Offset	是	否	Int64	翻页偏移量示例值：

3. 输出参数

参数名称	类型	描述
Result	TsfPageApiGroupInfo	API分组信息列表示例值：查看
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: DescribeGroupsWithPlugin
<Common Parameters>

{
  "PluginId": "pgn-iuyb0s7c",
  "Bound": true,
  "SearchWord": "/grpCtx",
  "Offset": 0,
  "Limit": 5,
  "GatewayInstanceId": "gw-ins-4qvyt5dc"
}

输出示例

{
  "Response": {
    "RequestId": "665d9f05-3e80-464f-beb0-64345fe5c61e",
    "Result": {
      "Content": [
        {
          "AclMode": "none",
          "ApiCount": 0,
          "AuthType": "secret",
          "BindedGatewayDeployGroups": [],
          "ClusterId": null,
          "ClusterName": null,
          "ClusterType": null,
          "CreatedTime": "2024-11-04 14:21:53",
          "Description": "",
          "GatewayInstanceId": "gw-ins-4qvyt5dc",
          "GatewayInstanceIdList": null,
          "GatewayInstanceType": null,
          "GroupContext": "/grpCtx",
          "GroupId": "grp-v446jrhc",
          "GroupName": "grpName",
          "GroupType": "ms",
          "NamespaceNameKey": null,
          "NamespaceNameKeyPosition": "path",
          "ServiceNameKey": null,
          "ServiceNameKeyPosition": "path",
          "Status": "drafted",
          "UpdatedTime": "2024-11-04 14:24:41"
        }
      ],
      "TotalCount": 1
    }
  }
}