1. 接口描述
接口请求域名: tbdsnew.api3.fincloud.tencent.cn。
查看节点服务
默认接口请求频率限制:20次/秒。
接口更新时间:2024-11-01 09:21:05。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数,本接口取值:DescribeNodeComponent |
| Version | 是 | 否 | String | 公共参数,本接口取值:2019-01-03 |
| Region | 是 | 否 | String | 公共参数,地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群ID 示例值: tbds-664nmwbe |
| HostUuidList | 是 | 否 | Array of String | 节点列表 示例值: ['d67de2ed-2f22-407f-87cf-75d76e2d3039'] |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| ComponentWithServiceList | Array of ComponentWithService | 节点服务列表 注意:此字段可能返回 null,表示取不到有效值。 示例值:查看 |
| RequestId | String | 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| FailedOperation | 操作失败。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| ResourceNotFound.InstanceNotFound | 无法找到该实例。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InvalidParameter | 参数错误。 |
5. 示例
示例1 查看节点服务
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeNodeComponent
<公共请求参数>
{
"InstanceId": "tbds-664nmwbe",
"HostUuidList": [
"d67de2ed-2f22-407f-87cf-75d76e2d3039"
]
}
输出示例
{
"Response": {
"ComponentWithServiceList": [
{
"ServiceComponent": "AmoroServer",
"ServiceState": 1
},
{
"ServiceComponent": "DataNode",
"ServiceState": 1
},
{
"ServiceComponent": "Gateway",
"ServiceState": 1
},
{
"ServiceComponent": "HbaseThrift",
"ServiceState": 1
},
{
"ServiceComponent": "HiveMetaStore",
"ServiceState": 1
},
{
"ServiceComponent": "HiveServer2",
"ServiceState": 1
},
{
"ServiceComponent": "HiveWebHcat",
"ServiceState": 1
},
{
"ServiceComponent": "HMaster",
"ServiceState": 1
},
{
"ServiceComponent": "HRegionServer",
"ServiceState": 1
},
{
"ServiceComponent": "httpfs",
"ServiceState": 1
},
{
"ServiceComponent": "Hue",
"ServiceState": 1
},
{
"ServiceComponent": "ImpalaCataLog",
"ServiceState": 1
},
{
"ServiceComponent": "ImpalaServerCoordinator",
"ServiceState": 1
},
{
"ServiceComponent": "ImpalaServerExecutor",
"ServiceState": 1
},
{
"ServiceComponent": "ImpalaStateStore",
"ServiceState": 1
},
{
"ServiceComponent": "JournalNode",
"ServiceState": 1
},
{
"ServiceComponent": "Kafka",
"ServiceState": 1
},
{
"ServiceComponent": "KafkaManager",
"ServiceState": 1
},
{
"ServiceComponent": "KyuubiServer",
"ServiceState": 1
},
{
"ServiceComponent": "NameNode",
"ServiceState": 1
},
{
"ServiceComponent": "NodeManager",
"ServiceState": 1
},
{
"ServiceComponent": "QuorumPeerMain",
"ServiceState": 1
},
{
"ServiceComponent": "ResourceManager",
"ServiceState": 1
},
{
"ServiceComponent": "SparkJobHistoryServer",
"ServiceState": 1
},
{
"ServiceComponent": "Tomcat",
"ServiceState": 1
},
{
"ServiceComponent": "TrinoCoordinator",
"ServiceState": 0
},
{
"ServiceComponent": "zkfc",
"ServiceState": 1
}
],
"RequestId": "aeab489b-3310-464d-baa4-1fcedd089c2d"
}
}