微服务引擎 TSE 查询服务实例-北极星-注册中心-服务实例相关接口-API 中心-腾讯云

1. 接口描述

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

查询服务实例

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

推荐使用 API Explorer

点击调试

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

2. 输入参数

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

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeGovernanceInstances。
Version	是	String	公共参数，本接口取值：2020-12-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, eu-frankfurt, na-siliconvalley, sa-saopaulo 。
Service	是	String	实例所在的服务名。示例值：Producer
Namespace	是	String	实例所在命名空间名。示例值：Development
InstanceId	是	String	tse实例id。示例值：ins-df344df5
Host	否	String	根据实例ip过滤，多个ip使用英文逗号分隔。示例值：192.168.1.1,10.10.10.1
InstanceVersion	否	String	根据实例版本过滤。示例值：v1
Protocol	否	String	根据实例协议过滤。示例值：grpc
HealthStatus	否	Boolean	根据实例健康状态过滤。false：表示不健康，true：表示健康。示例值：true
Isolate	否	Boolean	根据实例隔离状态过滤。false：表示非隔离，true：表示隔离中。示例值：1
Metadatas.N	否	Array of Metadata	根据元数据信息过滤。目前只支持一组元数据键值，若传了多个键值对，只会以第一个过滤。
Offset	否	Integer	偏移量，默认为0。示例值：1
Limit	否	Integer	返回数量，默认为20，最大值为100。示例值：20
Location	否	Location	地域

3. 输出参数

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

4. 示例

示例1 查询服务实例

输入示例

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

{
    "Service": "service",
    "Namespace": "namespace",
    "Host": "127.0.0.1",
    "InstanceVersion": "prod",
    "Protocol": "tcp",
    "HealthStatus": true,
    "Isolate": true,
    "Metadatas": [
        {
            "Key": "key",
            "Value": "value"
        }
    ],
    "Offset": 1,
    "Limit": 1,
    "InstanceId": "ins-id"
}

输出示例

{
    "Response": {
        "TotalCount": 1,
        "Content": [
            {
                "Id": "id",
                "Service": "service-name",
                "Namespace": "namespace",
                "Host": "127.0.0.1",
                "Port": 1,
                "Protocol": "tcp",
                "Version": "1",
                "Weight": 1,
                "EnableHealthCheck": true,
                "Healthy": true,
                "Isolate": true,
                "CreateTime": "2024-10-08 10:00:00",
                "ModifyTime": "2024-10-08 10:00:00",
                "Metadatas": [
                    {
                        "Key": "key",
                        "Value": "value"
                    }
                ],
                "Ttl": 1,
                "InstanceVersion": "prod",
                "HealthStatus": "health",
                "Comment": "comment"
            }
        ],
        "RequestId": "req-id"
    }
}

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	内部错误。
InternalError.GovernanceFailure	访问治理中心引擎内部错误。
InternalError.IOError	内部服务调用异常。
InvalidParameterValue.BadRequestFormat	请求格式不正确。
InvalidParameterValue.QueryError	无效请求参数，查询失败。
ResourceNotFound	资源不存在。