1. 接口描述
接口请求域名： tsf.api3.fincloud.tencent.com。
获取微服务列表
默认接口请求频率限制：20次/秒。
接口更新时间：2024-09-14 11:55:39。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeMicroservices |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-03-26 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| SearchWord | 否 | 否 | String | 搜索字段 示例值： |
| NamespaceId | 是 | 否 | String | 命名空间ID 示例值： |
| OrderBy | 否 | 否 | String | 排序字段 示例值： |
| OrderType | 否 | 否 | Int64 | 排序类型 示例值： |
| Offset | 否 | 否 | Int64 | 偏移量 示例值： |
| Limit | 否 | 否 | Int64 | 分页个数 示例值： |
| Status | 否 | 否 | Array of String | 状态过滤，online、offline、single_online 示例值： |
| MicroserviceIdList | 否 | 否 | Array of String | IdList 示例值： |
| MicroserviceNameList | 否 | 否 | Array of String | 搜索的服务名列表 示例值： |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Result | TsfPageMicroservice | 微服务分页列表信息 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| MissingParameter.NamespaceIdRequired | 命名空间ID不能为空。 |
| InvalidParameter.ParamError | 参数错误。 |
| FailedOperation.ServiceQueryFailed | 服务查询失败。 |
| InvalidParameter.BadRequest | [%s]模块接口[%s]请求不正确（400 BAD REQUEST）。。 |
| UnauthorizedOperation.NoPrivilege | 用户无权限访问该接口。。 |
| FailedOperation.ServiceInsertFailed | 服务数据库入库失败。 |
| FailedOperation.TsfPrivilegeError | TSF权限模块异常，请联系系统管理员。。 |
| InternalError.UnhandledException | [%s]模块未处理异常。。 |
| ResourceNotFound.MicroserviceOffline | 目标微服务已离线[%s]。。 |
| UnauthorizedOperation.NoLicense | 缺少License。。 |
| InvalidParameterValue.ServiceNotExistsOrPermissionDenied | 服务不存在或权限不足。 |
| FailedOperation.UnhandledException | 模块未处理异常。 |