文档中心>API 中心>API 网关>其他接口>查询后端通道列表详情

查询后端通道列表详情

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

我的收藏

1. 接口描述

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

查询后端通道列表详情

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

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

2. 输入参数

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

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

3. 输出参数

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

4. 示例

示例1 查询vpc

输入示例

https://apigateway.tencentcloudapi.com/?Action=DescribeUpstreams
&Limit=1
&Offset=0
&<公共请求参数>

输出示例

{
    "Response": {
        "Result": {
            "TotalCount": 1,
            "UpstreamSet": [
                {
                    "Retries": 1,
                    "Algorithm": "xx",
                    "UniqVpcId": "xx",
                    "Tags": [
                        {
                            "Value": "xx",
                            "Key": "xx"
                        }
                    ],
                    "UpstreamType": "xx",
                    "UpstreamHost": "xx",
                    "UpstreamId": "xx",
                    "K8sServices": [
                        {
                            "Name": "xx",
                            "Weight": 0,
                            "ClusterId": "xx",
                            "Namespace": "xx",
                            "ServiceName": "xx",
                            "ExtraLabels": [
                                {
                                    "Value": "xx",
                                    "Key": "xx"
                                }
                            ],
                            "Port": 0
                        }
                    ],
                    "UpstreamName": "xx",
                    "HealthChecker": {
                        "UnhealthyTimeout": 1,
                        "ActiveCheckInterval": 1,
                        "ActiveRequestHeader": [
                            {}
                        ],
                        "TimeoutThreshold": 1,
                        "HealthyHttpStatus": "xx",
                        "TcpFailureThreshold": 1,
                        "EnableActiveCheck": true,
                        "UnhealthyHttpStatus": "xx",
                        "ActiveCheckHttpPath": "xx",
                        "EnablePassiveCheck": true,
                        "HttpFailureThreshold": 1,
                        "ActiveCheckTimeout": 1
                    },
                    "CreatedTime": "2020-09-22T00:00:00+00:00",
                    "Nodes": [
                        {
                            "Weight": 1,
                            "Tags": [
                                "xx"
                            ],
                            "Healthy": "xx",
                            "ClusterId": "xx",
                            "NameSpace": "xx",
                            "Source": "xx",
                            "VmInstanceId": "xx",
                            "Host": "xx",
                            "ServiceName": "xx",
                            "UniqueServiceName": "xx",
                            "Port": 1
                        }
                    ],
                    "Scheme": "xx",
                    "UpstreamDescription": "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 操作失败。
FailedOperation.CamException CAM异常
InternalError 内部错误。
InternalError.CamException CAM内部请求错误,请稍后重试。若无法解决,请联系智能客服或提交工单。
InvalidParameter 参数错误。
InvalidParameterValue.InvalidFilterNotSupportedName 参数取值错误。
LimitExceeded 超过配额限制。
MissingParameter 缺少参数错误。
ResourceNotFound.InvalidAccessKeyId 密钥不存在。
UnsupportedOperation 操作不支持。
UnsupportedOperation.InvalidAction 接口错误。
UnsupportedOperation.RequestPostError 请求Post失败