微服务引擎 TSE 查询网关服务来源实例列表-云原生网关相关接口-API 中心-腾讯云

1. 接口描述

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

查询网关服务来源实例列表

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeNativeGatewayServiceSources。
Version	是	String	公共参数，本接口取值：2020-12-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-guangzhou, ap-hongkong, ap-mumbai, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
GatewayID	是	String	网关实例ID 示例值：gateway-dde03567
Limit	是	Integer	单页条数，最大100 示例值：100
Offset	是	Integer	分页偏移量示例值：1
SourceName	否	String	服务来源实例名称，模糊搜索示例值：nacos-learn-prod
SourceTypes.N	否	Array of String	微服务引擎类型：TSE-Nacos｜TSE-Consul｜TSE-PolarisMesh｜Customer-Nacos｜Customer-Consul｜Customer-PolarisMesh 示例值：TSE-Nacos
OrderField	否	String	排序字段类型，当前仅支持SourceName 示例值：SourceName
OrderType	否	String	排序类型，AES/DESC 示例值：AES

3. 输出参数

参数名称	类型	描述
Total	Integer	总实例数示例值：100
List	Array of NativeGatewayServiceSourceItem	服务来源实例列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询网关服务来源实例列表

输入示例

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

{
    "SourceName": "nacos-learn-prod",
    "OrderType": "AES",
    "Limit": 1,
    "SourceTypes": [
        "TSE-Nacos"
    ],
    "OrderField": "SourceName",
    "Offset": 1,
    "GatewayID": "gateway-dde03567"
}

输出示例

{
    "Response": {
        "List": [
            {
                "GatewayID": "gateway-dde03567",
                "SourceID": "ins-5ef8277d",
                "SourceName": "nacos-learn-prod",
                "SourceType": "TSE-Nacos",
                "SourceInfo": {
                    "VpcInfo": {
                        "VpcID": "vpc-83p03121",
                        "SubnetID": "subnet-83p03121"
                    },
                    "Addresses": [
                        "10.0.0.1:8848"
                    ],
                    "Auth": {
                        "Username": "tse@tencentUser",
                        "Password": "tse@tencentPwd",
                        "AccessToken": ""
                    }
                },
                "CreateTime": "2024-12-09 18:11:19",
                "ModifyTime": "2024-12-09 18:11:19"
            }
        ],
        "RequestId": "0bcf3f70-550e-439d-81ee-7ebe260c2f06",
        "Total": 3
    }
}

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. 错误码

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

错误码	描述
InternalError.QueryError	查询内部错误。
InvalidParameterValue.QueryError	无效请求参数，查询失败。
ResourceNotFound.InstanceNotFound	实例不存在。
ResourceNotFound.ResourceNotFound	资源不存在。