查询API分组下的Api列表信息

最近更新时间:2024-03-12 02:00:07

我的收藏

1. 接口描述

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

查询API分组下的Api列表信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeGatewayApis。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
GroupId String 分组ID
示例值:grp-5yk7oor1
Offset Integer 翻页偏移量
示例值:0
Limit Integer 每页的记录数
示例值:10
SearchWord String 搜索关键字,支持 API path
GatewayDeployGroupId String 部署组ID
示例值:group-e42d597
ReleaseStatus String 发布状态, drafted(未发布)/released(已发布)/releasing(发布中)/failed(发布失败)
示例值:released

3. 输出参数

参数名称 类型 描述
Result TsfPageApiDetailInfo 翻页结构
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询API分组下的Api列表信息

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeGatewayApis
&GroupId=grp-5yk7oor1
&GatewayDeployGroupId=group-e42d597
&Offset=0
&Limit=10
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "Content": [
                {
                    "ApiId": "abc",
                    "NamespaceId": "abc",
                    "NamespaceName": "abc",
                    "MicroserviceId": "abc",
                    "MicroserviceName": "abc",
                    "Path": "abc",
                    "PathMapping": "abc",
                    "Method": "abc",
                    "GroupId": "abc",
                    "UsableStatus": "abc",
                    "ReleaseStatus": "abc",
                    "RateLimitStatus": "abc",
                    "MockStatus": "abc",
                    "CreatedTime": "abc",
                    "UpdatedTime": "abc",
                    "ReleasedTime": "abc",
                    "GroupName": "abc",
                    "Timeout": 0,
                    "Host": "abc",
                    "ApiType": "abc",
                    "Description": "abc",
                    "ApiMatchType": "abc",
                    "RpcExt": "abc",
                    "GatewayDeployGroupId": "abc",
                    "Md5": "abc",
                    "RpcType": "abc"
                }
            ]
        },
        "RequestId": "abc"
    }
}

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权限模块异常,请联系系统管理员。。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.GatewayDbError 网关数据异常。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense 缺少License。。