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-xxx |
Offset | 否 | Integer | 偏移量 示例值:0 |
Limit | 否 | Integer | 分页个数 示例值:20 |
GroupIds.N | 否 | Array of String | 可选,根据部署组ID进行过滤 示例值:["group-xxx","group-xxx"] |
Filters.N | 否 | Array of Filter | 过滤条件。多个 filter 之间是与关系,单个 filter 多个 value 之间是或关系。filter name 取值有:id(实例id)、name(实例名)、lan-ip(内网ip)、node-ip(所在节点ip) |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
Result | TsfPageMsInstance | 微服务详情实例列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:null |
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-xxxxxxx",
"Limit": "20",
"Offset": "0"
}
输出示例
{
"Response": {
"Result": {
"TotalCount": 0,
"Content": [
{
"InstanceId": "abc",
"InstanceName": "abc",
"Port": "abc",
"LanIp": "abc",
"WanIp": "abc",
"InstanceAvailableStatus": "abc",
"ServiceInstanceStatus": "abc",
"ApplicationId": "abc",
"ApplicationName": "abc",
"ClusterId": "abc",
"ClusterName": "abc",
"NamespaceId": "abc",
"NamespaceName": "abc",
"GroupId": "abc",
"GroupName": "abc",
"InstanceStatus": "abc",
"HealthCheckUrl": "abc",
"ClusterType": "abc",
"ApplicationPackageVersion": "abc",
"ApplicationType": "abc",
"ServiceStatus": "abc",
"RegistrationTime": 0,
"LastHeartbeatTime": 0,
"RegistrationId": "abc",
"HiddenStatus": "abc",
"MetaJson": "abc"
}
]
},
"RequestId": "abc"
}
}
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
命令行工具
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 | 用户无权限访问该接口。。 |