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

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

1. 接口描述

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

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

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

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

接口既验签名又鉴权。

2. 输入参数

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

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

3. 输出参数

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

4. 错误码

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

5. 示例

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

输入示例

https://tsf.api3.<no value>/?Action=DescribeGroupsWithPlugin
&PluginId=pgn-33pk2soi
&GatewayInstanceId=gw-ins-33pk2soi
&Bound=false
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "Content": [
                {
                    "Status": "xx", 
                    "UpdatedTime": "xx", 
                    "AuthType": "xx", 
                    "Description": "xx", 
                    "BindedGatewayDeployGroups": [
                        {
                            "DeployGroupId": "xx", 
                            "ApplicationName": "xx", 
                            "GroupStatus": "xx", 
                            "ClusterType": "xx", 
                            "DeployGroupName": "xx", 
                            "ApplicationType": "xx", 
                            "ApplicationId": "xx"
                        }
                    ], 
                    "GroupType": "xx", 
                    "AclMode": "xx", 
                    "ApiCount": 1, 
                    "GroupName": "xx", 
                    "GroupContext": "xx", 
                    "CreatedTime": "xx", 
                    "GroupId": "xx"
                }, 
                {
                    "Status": "xx", 
                    "UpdatedTime": "xx", 
                    "AuthType": "xx", 
                    "Description": "xx", 
                    "BindedGatewayDeployGroups": [
                        {
                            "DeployGroupId": "xx", 
                            "ApplicationName": "xx", 
                            "ApplicationId": "xx", 
                            "ClusterType": "xx", 
                            "DeployGroupName": "xx", 
                            "ApplicationType": "xx", 
                            "GroupStatus": "xx"
                        }
                    ], 
                    "GroupType": "xx", 
                    "AclMode": "xx", 
                    "GroupId": "xx", 
                    "GroupName": "xx", 
                    "GroupContext": "xx", 
                    "CreatedTime": "xx", 
                    "ApiCount": 3
                }
            ], 
            "TotalCount": 2
        }, 
        "RequestId": "xx"
    }
}