描述容器集群角色信息
最近更新时间: 2026-09-17 00:05:47
1. 接口描述
接口请求域名： tbdsnew.api3.fincloud.tencent.cn。
描述容器集群角色信息
默认接口请求频率限制：20次/秒。
接口更新时间：2025-07-17 02:34:07。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeServiceComponentInfos |
| Version | 是 | 否 | String | 公共参数，本接口取值：2019-01-03 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| InstanceId | 是 | 否 | String | 集群id 示例值： tbds-aqy2cvg6 |
| ServiceName | 是 | 否 | String | 服务角色名称 示例值： KNOX |
| Offset | 否 | 否 | Int64 | 页编号，默认值为0，表示第一页 示例值： 1 |
| Limit | 否 | 否 | Int64 | 每页返回数量，默认值为10，最大值为200 示例值： 1 |
| Filters | 否 | 否 | Array of Filters | 过滤字段，Name支持字段：角色名ComponentNames，健康状态HealthStatus（对应Values：正常normal，异常abnormal） 示例值：查看 |
| OrderPairs | 否 | 否 | Array of OrderPair | 排序字段，Field支持字段：最近重启时间LastRestartTime；Asc支持true/false 示例值：查看 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| TotalCnt | Int64 | 角色总数 示例值： 1 |
| ServiceGroup | Int64 | 组件编号 示例值： 1 |
| ComponentList | Array of ComponentInfo | 角色详情信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| WebUIInfo | WebUIInfo | 服务Web UI 访问信息 注意：此字段可能返回 null，表示取不到有效值。 示例值：查看 |
| ServiceVersion | String | 服务版本 示例值： 1 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.CbsCgwError | 内部服务调用异常。 |
| InternalError.CvmError | 内部服务调用异常。 |
| InvalidParameter.InvalidServiceName | 服务名无效。 |
| InvalidParameter.InvalidTimeSpan | 无效的timespan。 |
| InvalidParameter.InvalidSercurityGrpupId | 无效的安全组ID。 |
| InvalidParameter.InvalidPassword | 无效密码。 |
| InvalidParameter.InvalidProjectId | 无效的项目ID。 |
| MissingParameter | 缺少参数错误。 |
| InvalidParameter.InvalidSoftInfo | 无效的SoftInfo。 |
| InternalError.CdbCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidAppId | 无效参数，AppId。 |
| InvalidParameter.InvalidSoftDeployInfo | 参数InvalidSoftDeployInfo无效或错误。 |
| InvalidParameter.InvalidSoftWareVersion | 软件版本无效。 |
| InvalidParameter | 参数错误。 |
| InvalidParameter.InvalidComponent | 无效的组件。 |
| InvalidParameter.InvalidMetaType | 无效的元数据表类型。 |
| InternalError.WoodServerError | 内部服务调用异常。 |
| InvalidParameter.InvalidInstanceName | 无效的集群名称。 |
| InvalidParameter.ZoneResourceNotMatch | 可用区与资源不匹配。 |
| FailedOperation.DuplicateOrderNotAllowed | 重复的订单，请检查emr控制台。 |
| InternalError.ProjectCgwError | 内部服务调用异常。 |
| InvalidParameter.UngrantedRole | 角色未授权。 |
| ResourcesSoldOut.CvmSoldOut | 云服务器已售罄。 |
| InvalidParameter.InvalidLoginSetting | 无效的登录设置。 |
| InvalidParameter.InvalidSoftWare | 参数错误。 |
| InternalError.TradeCgwError | 内部服务调用异常。 |
| InternalError.AccountCgwError | 内部服务调用异常。 |
| InvalidParameter.InvalidSubnetId | 无效的子网ID。 |
| InternalError | 内部错误。 |
| InvalidParameter.PayModeResourceNotMatch | 付费模式与资源不匹配。 |
| InternalError.VpcError | 内部服务调用异常。 |
| ResourcesSoldOut | 资源售罄。 |
| InternalError.KmsError | 内部服务调用异常。 |
| InternalError.CheckQuotaErr | cvm或cbs资源不够或软件不合法。 |
| InternalError.VpcCgwError | 内部服务调用异常。 |
| InvalidParameter.UngrantedPolicy | 策略为授权。 |
| UnsupportedOperation | 操作不支持。 |
| InvalidParameter.InvalidClusterId | 无效参数，ClusterId。 |
| UnknownParameter | 未知参数错误。 |
| InvalidParameter.NotContainMustSelectSoftware | 无效参数，不满足必须组件。 |
| InvalidParameterValue | 参数取值错误。 |
| InvalidParameter.InvalidCoreCount | Core节点数量无效。 |
| InvalidParameter.InvalidProductId | 无效的产品ID。 |
| InvalidParameter.InvalidVpcId | 无效的私有网络ID。 |
| InternalError.ConfigCgwError | 内部服务调用异常。 |
| ResourceInsufficient.InstanceInsufficient | 不支持或售罄的节点规格。 |
| InternalError.CbsError | 内部服务调用异常。 |
| InternalError.SgError | 安全组接口调用异常。 |
| InvalidParameter.InvalidZone | 无效的可用区。 |
| InvalidParameter.InvalidAutoRenew | 无效的自动续费标识。 |
| InvalidParameter.InvalidPaymode | 无效的付费类型。 |
| InvalidParameter.InvalidTimeUnit | 无效的TimeUnit。 |
| InvalidParameter.InvalidClientToken | 无效的ClientToken。 |
| InvalidParameter.InvalidPreExecutedFile | 无效的引导操作脚本。 |
| InternalError.CdbError | 内部服务调用异常。 |
| InternalError.TagError | 内部服务调用异常。 |
| InvalidParameter.InvalidResourceSpec | 无效的资源规格。 |
| InvalidParameter.InvalidDiskSize | 无效的磁盘大小。 |
| InternalError.CamError | 内部服务调用异常。 |
| InvalidParameter.InvalidSupportHA | 无效的高可用参数。 |
| ResourceNotFound.TagsNotFound | 没有查找到指定标签。 |
| InvalidParameter.InvalidSoftWareName | 软件名无效。 |
| InternalError.EKSError | 调用EKS报错。 |
| ResourcesSoldOut.CbsSoldOut | CBS资源售罄。 |
| InvalidParameter.InvalidExtendField | CustomConfig参数值无效。 |
| InvalidParameter.SoftwareNotInProduct | 存在无效的产品组件。 |
| InternalError.CamCgwError | 内部服务调用异常。 |
| ResourceInsufficient.DiskInsufficient | 硬盘规格不满足。 |
| InvalidParameter.InvalidInstanceType | 无效的机型。 |
| InternalError.TKEError | TKE调用出错。 |
| FailedOperation | 操作失败。 |
| FailedOperation.GetEksServerFailed | 获取eks服务失败。 |
5. 示例
示例1 描述容器集群角色信息
输入示例
POST / HTTP/1.1
Host: tbdsnew.api3.{conf.main_domain}
Content-Type: application/json
X-TC-Action: DescribeServiceComponentInfos
<公共请求参数>
{
"InstanceId": "tbds-aqy2cvg6",
"ServiceName": "KNOX"
}
输出示例
{
"Response": {
"ComponentList": [
{
"ComponentName": "Gateway",
"ComponentResource": {
"Affinity": {
"preferredDuringSchedulingIgnoredDuringExecution": [
{
"preference": {
"matchExpressions": [
{
"key": "custom.tbds.tc/type",
"operator": "In",
"values": [
"app"
]
}
]
},
"weight": 1
}
],
"requiredDuringSchedulingIgnoredDuringExecution": {
"nodeSelectorTerms": [
{
"matchExpressions": [
{
"key": "custom.tbds.tc/type",
"operator": "In",
"values": [
"app"
]
}
]
}
]
}
},
"ComponentName": "Gateway",
"CpuType": "",
"DiskCapacity": 0,
"DiskNumber": 0,
"DiskType": "",
"Disks": null,
"ExternalAccess": null,
"LimitCpu": 1,
"LimitMemory": 2,
"PodNumber": 1,
"RequestCpu": 0,
"RequestMemory": 0,
"Service": "KNOX",
"VolumeDir": null
},
"ConfState": -1,
"CpuInfo": "1核",
"DiskInfo": "",
"HealthStatus": {
"Code": 1,
"Desc": "",
"Text": "正常"
},
"LastRestartTime": "2025-05-19 00:00:16",
"MemInfo": "2G",
"NetworkAccess": {
"EnableNetworkAccess": 0,
"ExternalExtendedInfo": [],
"ExternalExtendedInfoIpv4": [],
"ExternalService": [],
"ExternalServiceIpv4": [],
"InternalExtendedInfo": [],
"InternalService": [
"Gateway:tbds-aqy2cvg6-knox-gateway-inner:30002"
]
},
"Num": "1/1",
"PodSetting": {
"MaxCpu": 171,
"MaxMem": 336,
"MaxPodNum": 100,
"MaxPodNumDefault": 100,
"MinCpu": 1,
"MinDataDiskSize": 100,
"MinMem": 2,
"MinPodNum": 1,
"PodNumRule": "ALL",
"SupportDataDiskTypes": "CLOUD_PREMIUM,CLOUD_SSD,CLOUD_HSSD",
"VolumeType": [
""
]
},
"ServiceType": 50,
"Status": 0,
"VolumeDir": "EMPTY_DIR"
}
],
"RequestId": "5a528cbe-c802-4896-9214-053ad29b50ee",
"ServiceGroup": 24,
"ServiceVersion": "1.6.1",
"TotalCnt": 1,
"WebUIInfo": {
"Url": "",
"WebUIStatus": -1
}
}
}