API 网关查询 API 接口列表-API相关接口-API 中心-腾讯云

1. 接口描述

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

本接口（DescribeApisStatus）用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeApisStatus。
Version	是	String	公共参数，本接口取值：2018-08-08。
Region	是	String	公共参数，详见产品支持的地域列表。
ServiceId	是	String	API 所在的服务唯一 ID。示例值：service-ody35h5e
Offset	否	Integer	偏移量，默认为 0。
Limit	否	Integer	返回数量，默认为 20，最大值为 100
Filters.N	否	Array of Filter	API过滤条件。支持ApiId、ApiName、ApiPath、ApiType、AuthRelationApiId、AuthType、ApiBuniessType、NotUsagePlanId、 Environment、Tags (values为 $tag_key:tag_value的列表)、TagKeys （values 为 tag key的列表），其中NotUsagePlanId和Environment必须同时使用，不能单独使用一个。

3. 输出参数

参数名称	类型	描述
Result	DescribeApisStatusResultInfo	API 详情列表。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询API状态

用于查看一个服务下的某个 API 或所有 API 列表及其相关信息。

输入示例

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

{
    "ServiceId": "service-ody35h5e"
}

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 0,
            "ApiIdStatusSet": [
                {
                    "ServiceId": "abc",
                    "ApiId": "abc",
                    "ApiDesc": "abc",
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "ModifiedTime": "2020-09-22T00:00:00+00:00",
                    "ApiName": "abc",
                    "VpcId": 0,
                    "UniqVpcId": "abc",
                    "ApiType": "abc",
                    "Protocol": "abc",
                    "IsDebugAfterCharge": true,
                    "AuthType": "abc",
                    "ApiBusinessType": "abc",
                    "AuthRelationApiId": "abc",
                    "OauthConfig": {
                        "PublicKey": "abc",
                        "TokenLocation": "abc",
                        "LoginRedirectUrl": "abc"
                    },
                    "RelationBuniessApiIds": [
                        "abc"
                    ],
                    "Tags": [
                        {}
                    ],
                    "Path": "abc",
                    "Method": "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。

Tencent Cloud SDK 3.0 for Python: GitHub Gitee
Tencent Cloud SDK 3.0 for Java: GitHub Gitee
Tencent Cloud SDK 3.0 for PHP: GitHub Gitee
Tencent Cloud SDK 3.0 for Go: GitHub Gitee
Tencent Cloud SDK 3.0 for Node.js: GitHub Gitee
Tencent Cloud SDK 3.0 for .NET: GitHub Gitee
Tencent Cloud SDK 3.0 for C++: GitHub Gitee
Tencent Cloud SDK 3.0 for Ruby: GitHub Gitee

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

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

错误码	描述
FailedOperation.ServiceNotExist	服务不存在。
InvalidParameter.FormatError	参数格式错误。
InvalidParameterValue.InvalidFilterNotSupportedName	参数取值错误。
InvalidParameterValue.InvalidRegion	地域错误。
ResourceNotFound.InvalidService	对应服务不可见。
UnauthorizedOperation.AccessResource	您没有权限访问资源。
UnsupportedOperation.InvalidAction	接口错误。
UnsupportedOperation.RequestPostError	请求Post失败

查询 API 接口列表

本页目录：