查询微服务详情

最近更新时间:2024-12-24 02:06:38

我的收藏

1. 接口描述

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

查询微服务详情

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMicroservice。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
MicroserviceId String 微服务ID
示例值:ms-a78gk87b
Offset Integer 偏移量
示例值:0
Limit Integer 分页个数
示例值:10
GroupIds.N Array of String 可选,根据部署组ID进行过滤
示例值:["group-yx87px4a"]
Filters.N Array of Filter 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。filter name 取值有:id(实例id)、name(实例名)、lan-ip(内网ip)、node-ip(所在节点ip)
示例值:[{"Name":"LanIp","Values":["172.16.16.139"]}]

3. 输出参数

参数名称 类型 描述
Result TsfPageMsInstance 微服务详情实例列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:{"Content":[{"AppMicroServiceType":"G","ApplicationId":"application-ydopqnxa","ApplicationName":"app-gw","ApplicationPackageVersion":"20241223011040","ApplicationType":"V","ClusterId":"cluster-2vz3nd3a","ClusterName":"cls_app","ClusterType":"V","GroupId":"group-yx87px4a","GroupName":"app-zuul-2","HealthCheckUrl":null,"HiddenStatus":"unhidden","InstanceAvailableStatus":null,"InstanceId":"ins-7wy598p8","InstanceName":"app22","InstanceStatus":null,"LanIp":"172.16.16.139","LanIpv6":null,"LastHeartbeatTime":1734943598,"MetaJson":"H4sIAAAAAAAAAGXQUU+DMBQF4P/SZ7tAh2nxjUDHiFtpWmbiXki3EUaibdmGgsb/LpPOmPh8vntycj9BIRdlxPkqi6Miy1mZJeABKGtfmr26NEbD4WBsq3sF7n5sLOgEi2xNR+rjeUAIxgFxIBX5hk819cl0Fg49wbYPbgUZkwWLYjqRRp8hfh/uQ2JvBSxaU8l/hVav1dmqfQVbtcO7Nnz754pnfp2S0IWLuMjT8okKOQ4dA+ShwEdo7vm+F3jOCJpOqbKw7pSuP46mc5lMHv+c+zMUzpAHl6a/jA9ZNvWxOkFBVzSS1F1sc3adAL6+AZBHey5SAQAA","NamespaceId":null,"NamespaceName":null,"Port":"8080","RegistrationId":"ins-7wy598p8","RegistrationTime":1734887748,"ServiceInstanceStatus":"Running","ServiceStatus":"passing","WanIp":"43.139.245.156"}],"TotalCount":1}
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询微服务实例详情

输入示例

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

{
    "MicroserviceId": "ms-a78gk87b",
    "Offset": 0,
    "Limit": 10,
    "GroupIds": [
        "group-yx87px4a"
    ],
    "Filters": [
        {
            "Name": "LanIp",
            "Values": [
                "172.16.16.139"
            ]
        }
    ]
}

输出示例

{
    "Response": {
        "RequestId": "80479d6c-27db-4d6c-b5f0-5ec576d2105f",
        "Result": {
            "Content": [
                {
                    "ApplicationId": "application-ydopqnxa",
                    "ApplicationName": "app-gw",
                    "ApplicationPackageVersion": "20241223011040",
                    "ApplicationType": "V",
                    "ClusterId": "cluster-2vz3nd3a",
                    "ClusterName": "cls_name",
                    "ClusterType": "V",
                    "GroupId": "group-yx87px4a",
                    "GroupName": "zuul-2",
                    "HealthCheckUrl": null,
                    "HiddenStatus": "unhidden",
                    "InstanceAvailableStatus": null,
                    "InstanceId": "ins-7wy598p8",
                    "InstanceName": "app22",
                    "InstanceStatus": null,
                    "LanIp": "172.16.16.139",
                    "LastHeartbeatTime": 1734943598,
                    "MetaJson": "H4sIAAAAAAAAAGXQUU+DMBQF4P/SZ7tAh2nxjUDHiFtpWmbiXki3EUaibdmGgsb/LpPOmPh8vntycj9BIRdlxPkqi6Miy1mZJeABKGtfmr26NEbD4WBsq3sF7n5sLOgEi2xNR+rjeUAIxgFxIBX5hk819cl0Fg49wbYPbgUZkwWLYjqRRp8hfh/uQ2JvBSxaU8l/hVav1dmqfQVbtcO7Nnz754pnfp2S0IWLuMjT8okKOQ4dA+ShwEdo7vm+F3jOCJpOqbKw7pSuP46mc5lMHv+c+zMUzpAHl6a/jA9ZNvWxOkFBVzSS1F1sc3adAL6+AZBHey5SAQAA",
                    "NamespaceId": null,
                    "NamespaceName": null,
                    "Port": "8080",
                    "RegistrationId": "ins-7wy598p8",
                    "RegistrationTime": 1734887748,
                    "ServiceInstanceStatus": "Running",
                    "ServiceStatus": "passing",
                    "WanIp": "43.139.245.156"
                }
            ],
            "TotalCount": 1
        }
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.GroupQueryFaild 部署组查询失败。
FailedOperation.ServiceQueryFailed 服务查询失败。
FailedOperation.TsfPrivilegeError TSF权限模块异常,请联系系统管理员。。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.CloudApiProxyError TSF云API请求调用失败。
InternalError.UnhandledException [%s]模块未处理异常。。
MissingParameter.ServiceIdRequired 未填写服务Id。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
ResourceNotFound.ServiceNotExist 无法获取服务,无法执行该操作。
UnauthorizedOperation.NoLicense 缺少License。。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。