有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

获取微服务列表

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeMicroservices。
Version String 公共参数,本接口取值:2018-03-26。
Region String 公共参数,详见产品支持的 地域列表
NamespaceId String 命名空间ID
示例值:namespace-xxxxxxx
SearchWord String 搜索字段
示例值:ms-xxxxxxx
OrderBy String 排序字段
OrderType Integer 排序类型
Offset Integer 偏移量
示例值:0
Limit Integer 分页个数
示例值:1
Status.N Array of String 状态过滤,online、offline、single_online
示例值:["online"]
MicroserviceIdList.N Array of String IdList
示例值:["ms-xxx"]
MicroserviceNameList.N Array of String 搜索的服务名列表
示例值:["provider"]

3. 输出参数

参数名称 类型 描述
Result TsfPageMicroservice 微服务分页列表信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取微服务列表

输入示例

https://tsf.tencentcloudapi.com/?Action=DescribeMicroservices
&Offset=0
&Limit=1
&NamespaceId=namespace-xxxxxxx
&SearchWord=ms-xxxxxxx
&<公共请求参数>

输出示例

{
    "Response": {
        "RequestId": "3eab4695-2d7e-4f78-a8d2-ea93bab87dfd",
        "Result": {
            "TotalCount": 1,
            "Content": [
                {
                    "MicroserviceId": "ms-xxxxxxx",
                    "NamespaceId": "namespace-xxxxxxx",
                    "MicroserviceName": "consumer-demo",
                    "MicroserviceDesc": null,
                    "CreateTime": 1553673084000,
                    "UpdateTime": 1553673084000,
                    "RunInstanceCount": 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.ServiceInsertFailed 服务数据库入库失败。
FailedOperation.ServiceQueryFailed 服务查询失败。
FailedOperation.TsfPrivilegeError TSF权限模块异常,请联系系统管理员。。
FailedOperation.UnhandledException 模块未处理异常。
InternalError.UnhandledException [%s]模块未处理异常。。
InvalidParameter.BadRequest [%s]模块接口[%s]请求不正确(400 BAD REQUEST)。。
InvalidParameter.ParamError 参数错误。
InvalidParameterValue.ServiceNotExistsOrPermissionDenied 服务不存在或权限不足。
MissingParameter.NamespaceIdRequired 命名空间ID不能为空。
ResourceNotFound.MicroserviceOffline 目标微服务已离线[%s]。。
UnauthorizedOperation.NoLicense 缺少License。。
UnauthorizedOperation.NoPrivilege 用户无权限访问该接口。。