DescribeMicroservice

最近更新时间: 2025-10-20 17:06:15

1. 接口描述

接口请求域名: tsf.api3.fincloud.tencent.cn。

查询微服务详情

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

接口更新时间:2021-03-18 16:53:17。

接口只验签名不鉴权。

2. 输入参数

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

参数名称 必选 允许NULL 类型 描述
Action String 公共参数,本接口取值:DescribeMicroservice
Version String 公共参数,本接口取值:2018-03-26
Region String 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表
MicroserviceId String 微服务ID
Offset Int64 偏移量
Limit Int64 分页个数
GroupIds Array of String 可选,根据部署组ID进行过滤

3. 输出参数

参数名称 类型 描述
Result TsfPageMsInstance 此参数对外不可见。
微服务详情实例列表
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 错误码

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

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