1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.cn。
查询集群服务详细信息
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-16 13:21:44。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeServiceGroups |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群实例ID 示例值： tbds-nu7ckm3g |
| Offset | 否 | 否 | Int64 | 页编号，默认值为0，表示第一页 示例值： 0 |
| Limit | 否 | 否 | Int64 | 每页返回数量，默认值为50，最大值为100 示例值： 50 |
| ServiceNames | 否 | 否 | Array of String | 服务名称列表 示例值： 1 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCnt | Int64 | 总数 示例值： 1 |
| ServiceGroupList | Array of ServiceGroup | 服务组列表 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| DisPlayHiveProfileEnabled | Bool | 展示查询管理 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter.InvalidServiceName | 服务名无效。 |
| ResourceNotFound.ServiceNodeNotFound | 服务节点没有找到。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
| InternalError | 内部错误。 |
| ResourceInUse.InstanceInProcess | 实例在流程中。 |
| FailedOperation.GetMonitorInfoFailed | 监控信息异常。 |
| InvalidParameter.InvalidClusterId | 无效参数，ClusterId。 |
| UnauthorizedOperation.CheckCamAuth | 校验账号操作无权限。 |
| ResourceNotFound.ServiceConfNotFound | 无法找到服务组件配置。 |
| ResourceNotFound.ClusterNotFound | 无法找到该实例。 |
| ResourceNotFound.HardwareInfoNotFound | 无法找到硬件信息。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| FailedOperation | 操作失败。 |
5. 示例
示例1 获取集群服务组信息
获取集群服务组信息
输入示例
https://emr.api3.{{conf.domain_main}}/?Action=DescribeServiceGroups
&InstanceId=emr-ikoyp9nw
&Offset=0
&Limit=10
&<公共请求参数>
输出示例
{
"Response": {
"RequestId": "23b5b170-592d-4ab2-b366-007a0d6e1d3e",
"ServiceGroupList": [
{
"AccessInfo": "ClickHouseServer IPC:10.0.0.49:9000;10.0.0.39:9000\n",
"AddTime": "2020-04-08 15:25:46",
"ClusterId": 59824,
"ExitInvalidParam": false,
"IsSupportReStart": true,
"IsSupportSubmitConf": false,
"PathsInfo": "/usr/sbin",
"ServiceNodeList": [
{
"CoreDeploy": 2,
"CoreNecessary": 0,
"NodeName": "ClickHouseServer",
"NodeType": 63,
"RestartPolicies": [
{
"BatchSizeRange": [
1,
9999
],
"Describe": "默认重启模式",
"DisplayName": "默认重启模式",
"IsDefault": "true",
"Name": "default"
}
],
"TaskDeploy": 0,
"TaskNecessary": 0
}
],
"ServiceType": 30,
"SoftName": "CLICKHOUSE",
"SoftVersion": "19.16.12.49",
"Status": 0,
"UserGroup": "root",
"UserName": "root",
"VAddress": "",
"WebUiUrl": "--"
},
{
"AccessInfo": "QuorumPeerMain IPC:10.0.0.49:2181;10.0.0.39:2181\n",
"AddTime": "2020-04-08 15:25:46",
"ClusterId": 59824,
"ExitInvalidParam": false,
"IsSupportReStart": true,
"IsSupportSubmitConf": true,
"PathsInfo": "/usr/local/service/zookeeper",
"ServiceNodeList": [
{
"CoreDeploy": 2,
"CoreNecessary": 0,
"NodeName": "Zookeeper",
"NodeType": 0,
"RestartPolicies": [
{
"BatchSizeRange": [
1,
1
],
"Describe": "默认重启模式",
"DisplayName": "默认重启模式",
"IsDefault": "true",
"Name": "default"
}
],
"TaskDeploy": 0,
"TaskNecessary": 0
}
],
"ServiceType": 0,
"SoftName": "ZOOKEEPER",
"SoftVersion": "3.5.5",
"Status": 0,
"UserGroup": "root",
"UserName": "root",
"VAddress": "",
"WebUiUrl": "--"
}
],
"TotalCnt": 2
}
}