文档中心>API 网关>API 文档>其他接口>查询后端通道所绑定的API列表

查询后端通道所绑定的API列表

最近更新时间:2024-03-12 01:08:41

我的收藏

1. 接口描述

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

查询后端通道所绑定的API列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUpstreamBindApis。
Version String 公共参数,本接口取值:2018-08-08。
Region String 公共参数,详见产品支持的 地域列表
Limit Integer 分页大小
示例值:10
Offset Integer 分页起始位置
示例值:0
UpstreamId String 后端通道ID
示例值:xxxxx
Filters.N Array of Filter ServiceId和ApiId过滤查询

3. 输出参数

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

4. 示例

示例1 查询vpc通道绑定api列表

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeUpstreamBindApis
&UpstreamId=“upstream-0c96l2bo”
&Limit=1
&Offset=0
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "BindApiSet": [
                {
                    "ApiId": "xx",
                    "ServiceName": "xx",
                    "BindTime": "2020-09-22T00:00:00+00:00",
                    "ApiName": "xx",
                    "ServiceId": "xx"
                }
            ]
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
AuthFailure CAM签名/鉴权错误。
DryRunOperation DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
FailedOperation 操作失败。
InternalError 内部错误。
InvalidParameter 参数错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceNotFound 资源不存在。
UnauthorizedOperation 未授权操作。
UnsupportedOperation 操作不支持。