微服务平台 TSF
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 微服务平台 TSF > API 文档 > 微服务网关相关接口 > 查询API 分组信息列表

查询API 分组信息列表

最近更新时间：2024-04-03 11:31:10

我的收藏

本页目录：

1. 接口描述

接口请求域名： tsf.tencentcloudapi.com 。

查询API 分组信息列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action 是 String 公共参数，本接口取值：DescribeApiGroups。
Version 是 String 公共参数，本接口取值：2018-03-26。
Region 是 String 公共参数，详见产品支持的 地域列表。
SearchWord 否 String 搜索关键字
Offset 否 Integer 偏移量，默认为0
示例值：0
Limit 否 Integer 每页条数，默认为20
示例值：20
GroupType 否 String 分组类型。 ms： 微服务分组； external:外部Api分组
AuthType 否 String 鉴权类型。 secret： 密钥鉴权； none:无鉴权
Status 否 String 发布状态, drafted: 未发布。 released: 发布
OrderBy 否 String 排序字段："created_time"或"group_context"
OrderType 否 Integer 排序类型：0(ASC)或1(DESC)
GatewayInstanceId 否 String 网关实体ID

3. 输出参数

参数名称 类型 描述
Result TsfPageApiGroupInfo 翻页结构体
注意：此字段可能返回 null，表示取不到有效值。
RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 test

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiGroups
<公共请求参数>

{
    "Status": "字符串",
    "OrderBy": "字符串",
    "AuthType": "字符串",
    "OrderType": "1",
    "GroupType": "字符串",
    "Limit": "1",
    "GatewayInstanceId": "字符串",
    "SearchWord": "字符串",
    "Offset": "1"
}

输出示例

{
    "Response": {
        "RequestId": "685c0c8e-d107-44ed-bba0-723456e01783",
        "Result": null
    }
}

示例2 test1

输入示例

POST / HTTP/1.1
Host: tsf.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeApiGroups
<公共请求参数>

{
    "Status": "字符串",
    "OrderBy": "字符串",
    "AuthType": "字符串",
    "OrderType": "1",
    "GroupType": "字符串",
    "Limit": "1",
    "GatewayInstanceId": "字符串",
    "SearchWord": "字符串",
    "Offset": "1"
}

输出示例

{
    "Response": {
        "RequestId": "a1deb916-ce41-4f0e-9307-deea50b14d44",
        "Result": null
    }
}

示例3 查询API 分组信息列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeApiGroups
&Offset=0
&Limit=20
&<公共请求参数>

输出示例

{
    "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": 0,
                    "GroupName": "xx",
                    "GroupContext": "xx",
                    "CreatedTime": "xx",
                    "GroupId": "xx"
                }
            ],
            "TotalCount": 1
        },
        "RequestId": "5d996e05507e42d5970cd2e25ed5267a"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.TsfPrivilegeError TSF权限模块异常，请联系系统管理员。。
InvalidParameterValue.GatewayParameterInvalid 无效请求参数:%s。
MissingParameter.GatewayParameterRequired 缺少请求参数:%s。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。
中国站