数据结构

最近更新时间: 2026-10-11 00:13:57

TagValuePageResponse

标签值分页返回VO

被如下接口引用:DescribeBaseTagValuePage

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 总条数
示例值:
List 是 否 String 标签值列表
示例值:

DistributionItem

impala query 分布对象

被如下接口引用:DescribeImpalaQueryDistribution

名称 必选 允许NULL 类型 描述
Name 是 否 String 名字
示例值:
Value 是 否 Float 值
示例值:
Count 是 是 Int64 可为空,表示数量
示例值:

ConfCategory

组件配置类别(配置管理)

被如下接口引用:ListConfLogs

名称 必选 允许NULL 类型 描述
CategoryKey 是 否 String 配置类别key
示例值:
CategoryName 是 否 String 配置类别名称
示例值:
Id 是 是 Int64 id号
示例值:
ServiceName 是 是 String 服务
示例值:
Valid 是 是 Int64 状态
示例值:
CreateTime 是 是 String 创建时间
示例值:
UpdateTime 是 是 String 更新时间
示例值:

OptimizeInfo

数据优化详情

被如下接口引用:DescribeCatalog、DescribeTable

名称 必选 允许NULL 类型 描述
ResourceName 是 是 String 表优化资源名
示例值:
FileMergeInfo 是 是 FileMergeInfo 文件合并信息
示例值:查看
FileCleanInfo 是 是 FileCleanInfo 文件清理信息
示例值:查看

ExportOriginalConf

原集群配置

被如下接口引用:DescribeExportConfs

名称 必选 允许NULL 类型 描述
ServiceNameAndVersion 是 否 String 服务名字和版本
示例值: ""
ExportOriginalConfFileList 是 否 Array of ExportOriginalConfFile 原集群配置文件列表
示例值:查看

HealthStatus

进程健康状态

被如下接口引用:DescribeServiceComponentInfos、DescribeServiceNodeInfos、DescribeServicePodNodeInfos

名称 必选 允许NULL 类型 描述
Code 是 否 Int64 运行正常
示例值:
Text 是 否 String 运行正常
示例值:
Desc 是 否 String 运行正常
示例值:

TimeLineItem

TimeLine每个阶段的描述对象

被如下接口引用:DescribeImpalaQueryOverview

名称 必选 允许NULL 类型 描述
Name 是 否 String 阶段名字
示例值:
Duration 是 否 String 阶段时间(展示用)
示例值:
StartTime 是 否 Float 阶段起始时间(单位ms)
示例值:
EndTime 是 否 Float 阶段结束时间(单位ms)
示例值:
StartTimeDesc 是 否 String 阶段起始时间(展示用)
示例值:
EndTimeDesc 是 否 String 阶段结束时间(展示用)
示例值:

DescribeCertainEventListItem

某个确定的事件列表项

被如下接口引用:DescribeCertainEventList

名称 必选 允许NULL 类型 描述
TimeStamp 是 否 String 日期时间字符串
示例值: 2025-09-16 22:20:26
Detail 是 否 String 事件详情
示例值: [HBASE - Overview] dead RegionServers number >= 1 in 60 seconds
Service 是 否 String 服务名
示例值: HBASE
Role 是 否 String 角色名
示例值: HMaster
IsSupportMonitor 是 否 Bool 是否支持服务监控
示例值: true

FieldItem

字段信息

被如下接口引用:DescribeFields

名称 必选 允许NULL 类型 描述
Name 是 否 String 名称
示例值:
FieldType 是 否 String 字段类型
示例值:
Comment 否 是 String 字段描述
示例值:
FieldParam 否 是 String 字段额外参数,比如struct 类型的额外信息
示例值:

HdfsFile

HdfsFile

被如下接口引用:DescribeHDFSFolderFiles

名称 必选 允许NULL 类型 描述
Path 是 否 String 文件路径(全路径)
示例值:
Length 是 否 Int64 文件大小,单位: Byte
示例值:
IsDir 是 否 Bool 是否目录, true: 是目录
示例值:
ModificationTime 是 否 Int64 修改时间, 毫秒的时间戳
示例值:
Permission 是 否 String 文件权限
示例值:
Owner 是 否 String 文件所有者
示例值:
Group 是 否 String 文件所属组
示例值:
HasSubDir 是 否 Bool 是否还有子目录
示例值:
Prefix 是 否 String hdfs集群的目录前缀
示例值:

NodeSelectorRequirement

Pod节点选择项

被如下接口引用:DescribeServiceComponentInfos、ModifyComponentResource

名称 必选 允许NULL 类型 描述
Key 否 否 String 节点选择项Key值
示例值:
Operator 否 否 String 节点选择项Operator值,支持In, NotIn, Exists, DoesNotExist. Gt, and Lt.
示例值:
Values 否 否 Array of String 节点选择项Values值
示例值:

ResourceAuthorizationPageResponse

资源授权分页列表VO

被如下接口引用:DescribeResourceAuthorizationPage

名称 必选 允许NULL 类型 描述
List 是 否 Array of ResourceAuthorizationResponse 授权资源列表
示例值:查看
TotalCount 是 否 Int64 总数
示例值:

ConfigFileInfo

组件的配置文件信息

被如下接口引用:DescribeComponentConfigFileInfo

名称 必选 允许NULL 类型 描述
FileContent 是 是 String 文件内容,比如core-site.xml 的文件内容
示例值:
Err 是 是 String 错误描述
示例值:
FileMode 是 是 String 文件权限,读取情况下不用关注
示例值:
GenFile 是 是 Bool 是否支持下发,读取情况下不用关注
示例值:
SupportSerial 是 是 Bool 是否支持串行下发,读取情况下不用关注
示例值:
User 是 是 String 下发时对应的用户,读取情况下不用关注
示例值:
UserGroup 是 是 String 下发时对应的用户组,读取情况下不用关注
示例值:

RangerServiceResult

ranger service返回体

被如下接口引用:DescribeRangerServices

名称 必选 允许NULL 类型 描述
InstanceId 否 是 String 集群id
示例值:
ServiceName 否 是 String ranger ServiceName
示例值:
Service 否 是 String 服务名
示例值:

ConfGroupInfo

配置组信息

被如下接口引用:DescribeConfigGroup

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群实例Id
示例值:
ServiceType 是 否 Int64 服务类型
示例值:
ConfGroupId 是 否 Int64 配置组ID
示例值:
ConfGroupName 是 否 String 配置组名称
示例值:
ConfGroupDesc 是 否 String 配置组描述
示例值:
NodesInfo 是 是 Array of ConfGroupNodeInfo 配置组包含节点信息
示例值:查看
ConfGroupType 是 是 Int64 配置组类型,0:默认组,1:其他组
示例值:
NodeType 是 是 String 配置组节点类型
示例值:

NamespaceQuotaInfo

NamespaceQuotaInfo

被如下接口引用:DescribeCloudInstance

名称 必选 允许NULL 类型 描述
UsedCPULimit 否 是 Float 已使用的CPU
示例值:
UsedCPURequest 否 是 Float 已使用的CPU
示例值:
UsedMemLimit 否 是 Int64 已使用的内存
示例值:
UsedMemRequest 否 是 Int64 已使用的内存
示例值:
CPULimit 否 是 Float CPU限制
示例值:
CPURequest 否 是 Float CPU请求
示例值:
MemLimit 否 是 Int64 内存限制
示例值:
MemRequest 否 是 Int64 内存请求
示例值:
StorageRequest 否 是 Int64 存储请求
示例值:
UsedStorageRequest 否 是 Int64 已使用存储
示例值:

AuthResultItem

授权结果

被如下接口引用:IssueMaskRulesSTD

名称 必选 允许NULL 类型 描述
Item 否 是 String 此处为资源路径的 qualifiedName, catalog.schema.table
示例值:
Result 否 是 Bool 授权是否成功
示例值:
Reason 否 是 String 若是创建失败, 提供失败原因
示例值:
PolicyId 否 是 String 如果支持PolicyId,在此处提供
示例值:
PolicyService 否 是 String 如果支持 PolicyService,在此处提供
示例值:
PolicyName 否 是 String 如果支持 PolicyName,在此处提供
示例值:
BatchResults 否 是 Array of Bool 是否有权限,按照请求的权限的次序返回
示例值:

HeatMapMetricItem

集群主机聚合维度指标信息

被如下接口引用:DescribeHeatMapMetricList

名称 必选 允许NULL 类型 描述
MetricName 是 否 String 请求集群聚合指标接口的指标名
示例值:
Type 是 否 String 指标的type
示例值:
MetricNameCh 是 否 String 指标中文名
示例值:
Unit 是 否 String 单位
示例值:
MetricNameHost 是 否 String 请求数据拉取V4接口的指标名
示例值:
Tag 是 否 TagItem 指标描述
示例值:查看

MetricValue

impala query节点指标对象描述

被如下接口引用:DescribeImpalaQueryNodeMetrics

名称 必选 允许NULL 类型 描述
Host 是 否 String 节点IP
示例值:
Value 是 否 Float 值
示例值:
ValueDesc 是 否 String 值(展示用)
示例值:

NodeMetric

impala query 节点指标描述

被如下接口引用:DescribeImpalaQueryNodeMetrics

名称 必选 允许NULL 类型 描述
Title 是 否 String 指标名
示例值:
MetricValues 是 否 Array of MetricValue MetricValue数组
示例值:查看
Unit 是 是 String 单位
示例值:

PageResult

分页结果

被如下接口引用:DescribeAlarmHistoryList

名称 必选 允许NULL 类型 描述
CurrentPageNo 是 是 Int64 当前页码
示例值:
TotalCount 是 是 Int64 总数
示例值:
TotalPage 是 是 Int64 总页数
示例值:

OveviewRow

Hbase的TableMetric Overview返回

被如下接口引用:DescribeHBaseTableOverview

名称 必选 允许NULL 类型 描述
Table 是 否 String 表名字
示例值:
ReadRequestCount 是 否 Float 读请求次数
示例值:
WriteRequestCount 是 否 Float 写请求次数
示例值:
MemstoreSize 是 否 Float 当前memstore的size
示例值:
StoreFileSize 是 否 Float 当前region中StroreFile的size
示例值:
Operation 是 否 String regions,点击可跳转
示例值:

TableIdentity

表名称信息

被如下接口引用:DescribeFields、DescribePartitions、DescribeTable

名称 必选 允许NULL 类型 描述
CatalogName 是 否 String catalog 名称
示例值:
SchemaName 是 否 String 数据库名称
示例值:
TableName 是 否 String 表名称
示例值:

InstanceFamily

CVM/BMS的实例类型信息

被如下接口引用:DescribeTceInstanceConfigInfos

名称 必选 允许NULL 类型 描述
Family 是 否 String 实例族类型
示例值: 无
FamilyName 是 否 String 实例类型名称
示例值: 无

SupportMonitorRole

支持监控角色

被如下接口引用:DescribeEMRHostOverview

名称 必选 允许NULL 类型 描述
ProcessName 是 是 String 进程名
示例值:
ProcessNodeType 是 是 Int64 角色id
示例值:
ServiceName 是 是 String 服务名称
示例值:
IsSupportMonitor 是 是 Bool 是否支持监控
示例值:

AppAnalysisResult

应用洞察结果

被如下接口引用:DescribeAppAnalysisResults

名称 必选 允许NULL 类型 描述
Name 是 否 String 分析规则名
示例值:
Severity 是 否 Int64 // 严重4,警告3,一般2, 建议1
示例值:
Explain 是 否 String 分析规则解释
示例值:
Suggestion 是 是 String 建议
示例值:
Details 是 是 Array of String 详情
示例值:

PersistentVolumeContext

Pod PVC存储方式描述

被如下接口引用:ScaleOutInstance

名称 必选 允许NULL 类型 描述
DiskSize 否 是 Int64 磁盘大小,单位为GB。
示例值:
DiskType 否 是 String 磁盘类型。CLOUD_PREMIUM;CLOUD_SSD
示例值:
DiskNum 否 是 Int64 磁盘数量
示例值:

CdbInfo

出参

被如下接口引用:DescribeClusterNodes

名称 必选 允许NULL 类型 描述
InstanceName 是 是 String 数据库实例
示例值:
Ip 是 是 String 数据库IP
示例值:
Port 是 是 Int64 数据库端口
示例值:
MemSize 是 是 Int64 数据库内存规格
示例值:
Volume 是 是 Int64 数据库磁盘规格
示例值:
Service 是 是 String 服务标识
示例值:
ExpireTime 是 是 String 过期时间
示例值:
ApplyTime 是 是 String 申请时间
示例值:
PayType 是 是 Int64 付费类型
示例值:
ExpireFlag 是 是 Bool 过期标识
示例值:
Status 是 是 Int64 数据库状态
示例值:
IsAutoRenew 是 是 Int64 续费标识
示例值:
SerialNo 是 是 String 数据库字符串
示例值:
ZoneId 是 是 Int64 ZoneId
示例值:
RegionId 是 是 Int64 RegionId
示例值:

UserGroupResponse

用户组VO

被如下接口引用:CreateUserGroup、DescribePolicyUserGroupPage、DescribeRoleUserGroupPage、DescribeUserGroup、DescribeUserGroupPage

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 用户组id
示例值:
Name 是 否 String 用户组名称
示例值:
AppId 是 是 String 租户AppId
示例值:
Remark 是 是 String 用户组描述
示例值:
Scope 是 是 String 范围,system 内置 / custom 自定义
示例值:
CamGroupId 是 否 Int64 cam用户组id
示例值:
LdapGroupName 是 是 String ldap用户组名称
示例值:
CreateTime 是 是 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
示例值:

ExternalCertification

外部企业认证

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
KdcServer 是 否 String KdcServer
示例值:
Realm 是 否 String Realm
示例值:
Encryption 否 否 String 加密方式
示例值:
KAdminServer 是 否 String KAdminServer
示例值:
KAdminPrincipal 是 否 String KAdminPrincipal
示例值:
KAdminPassword 是 否 String KAdminPassword
示例值:

TopologyInfo

集群节点拓扑信息

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
ZoneId 否 是 Int64 可用区ID
示例值:
Zone 否 是 String 可用区信息
示例值:
SubnetInfoList 否 是 Array of SubnetInfo 子网信息
示例值:查看
NodeInfoList 否 是 Array of ShortNodeInfo 节点信息
示例值:查看

ClusterExternalServiceInfo

当前集群共用组件与集群对应关系

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
DependType 是 是 Int64 依赖关系,0:被其他集群依赖,1:依赖其他集群
示例值:
Service 是 是 String 共用组件
示例值:
ClusterId 是 是 String 共用集群
示例值:
ClusterStatus 是 是 Int64 共用集群状态
示例值:

OrderPair

排序字段集合

被如下接口引用:DescribeServiceComponentInfos、DescribeServiceNodeInfos、DescribeServicePodNodeInfos

名称 必选 允许NULL 类型 描述
Field 是 否 String 排序字段
示例值:
Asc 是 否 Bool 为true表示正序,false为逆序
示例值:

AuthDataMaskPolicy

数据脱敏策略

被如下接口引用:DescribeMaskRulesSTD、IssueMaskRulesSTD

名称 必选 允许NULL 类型 描述
Resource 是 是 AuthResource Resource
示例值:查看
DataMaskPolicyItems 是 是 Array of DataMaskPolicyItem 数据脱敏策略 ITEM
示例值:查看
PolicyPriority 否 是 Int64 策略优先级, 0 或者 1, 1 > 0
示例值:

SchedulerTaskInfo

yarn资源调度历史

被如下接口引用:DescribeYarnScheduleHistory

名称 必选 允许NULL 类型 描述
SchedulerName 是 否 String 调度器类型
示例值:
OperatorName 是 否 String 操作类型
示例值:
CreateTime 是 是 String 开始时间
示例值:
EndTime 是 是 String 结束时间
示例值:
State 是 是 Int64 状态
示例值:
Details 是 是 Array of SchedulerTaskDetail 详情
示例值:查看

NodeSelectorTerm

Pod节点选择项集合

被如下接口引用:DescribeServiceComponentInfos、ModifyComponentResource

名称 必选 允许NULL 类型 描述
MatchExpressions 否 否 Array of NodeSelectorRequirement 节点选择项表达式集合
示例值:查看

ServiceRole

服务和其下角色

被如下接口引用:DescribeGcServiceRole

名称 必选 允许NULL 类型 描述
Service 是 否 String 服务名
示例值:
Roles 是 否 Array of String 角色数组
示例值:

StageInfoDetail

任务步骤详情

被如下接口引用:DescribeFlowStatus

名称 必选 允许NULL 类型 描述
Stage 是 否 String 步骤id
示例值:
Name 是 是 String 步骤名
示例值:
IsShow 是 否 Bool 是否展示
示例值:
IsSubFlow 是 否 Bool 是否子流程
示例值:
SubFlowFlag 是 是 String 子流程标签
示例值:
Status 是 否 Int64 步骤运行状态:0:未开始 1:进行中 2:已完成 3:部分完成  -1:失败
示例值:
Desc 是 是 String 步骤运行状态描述
示例值:
Progress 是 是 Float 运行进度
示例值:
Starttime 是 是 String 开始时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
示例值:
Endtime 是 是 String 结束时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
示例值:
HadWoodDetail 是 是 Bool 是否有详情信息
示例值:
WoodJobId 是 是 Int64 Wood子流程Id
示例值:
LanguageKey 是 是 String 多语言版本Key
示例值:
FailedReason 是 是 String 如果stage失败,失败原因
示例值:
IsEmrccSubFlow 是 是 Bool 是否有emrcc的子流
示例值:

SubnetInstance

子网列表

被如下接口引用:DescribeCloudInstance

名称 必选 允许NULL 类型 描述
SubnetName 是 否 String 无
示例值:
SubnetId 是 否 String 无
示例值:
CidrBlock 是 否 String 无
示例值:
IsDefault 是 否 Bool 无
示例值:
Zone 是 否 String 无
示例值:
AvailableIpAddressCount 是 否 Int64 无
示例值:
TotalIpAddressCount 是 否 Int64 无
示例值:
Type 是 否 Int64 无
示例值:

InstanceServiceRoleTableFilterItem

服务概览页 角色表 过滤条件

被如下接口引用:DescribeInstanceServiceRoleTable

名称 必选 允许NULL 类型 描述
Field 是 否 String 过滤字段名称
示例值:
Value 是 否 String 过滤字段取值
示例值:

ResourceAuthorizationResponse

资源授权VO

被如下接口引用:DescribeResourceAuthorizationPage

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 资源授权id
示例值:
TargetType 是 否 String 授权对象类型
示例值:
TargetId 是 否 Int64 授权对象id
示例值:
TargetName 是 否 String 授权对象名称
示例值:
ClusterId 是 否 String 集群id
示例值:
ClusterName 是 是 String 集群名称
示例值:
ResourceType 是 否 String 资源类型
示例值:
ResourceName 是 否 String 资源名称
示例值:
ResourcePath 是 是 String 资源路径
示例值:
AuthType 是 否 String 授权类型
示例值:
IsRecursive 是 是 Bool 是否recursive
示例值:
CreateTime 是 否 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
示例值:
AppId 是 是 String 租户AppId
示例值:
NameService 是 是 String 集群的NameService
示例值:

PropertyItem

属性信息

被如下接口引用:DescribeTable

名称 必选 允许NULL 类型 描述
Key 是 否 String 属性key
示例值:
Value 是 否 String 属性值
示例值:
ReadOnly 否 否 Bool 是否只读,只用于出参
示例值:

YarnScheduleBaseInfo

YarnScheduleBaseInfo

被如下接口引用:DescribeYarnScheduleBaseInfos

名称 必选 允许NULL 类型 描述
QueueName 是 否 String 队列名称
示例值:
IsRootQueue 是 否 Bool 是否为根队列
示例值:
Capacity 是 是 Float 调度类型为capacityScheduler时,涉及该值
示例值:
MaxCapacity 是 是 Float 调度类型为capacityScheduler时,涉及该值
示例值:
MaxApps 是 是 Int64 调度类型为fairScheduler时,涉及该值
示例值:
DWeight 是 是 Int64 调度类型为fairScheduler时,涉及该值
示例值:
FullQueueName 是 是 String 完整的层级队列名称
示例值:
MinResources 是 是 ScheduleResources 队列最小资源
示例值:查看
MaxResources 是 是 ScheduleResources 队列最大资源
示例值:查看

DataMaskInfo

脱敏信息对象

被如下接口引用:DescribeMaskRulesSTD、IssueMaskRulesSTD

名称 必选 允许NULL 类型 描述
DataMaskType 是 否 String 脱敏类型
示例值:
ValueExpr 否 是 String 值表达式
示例值:

HostNodeBaseInfo

主机管理-主机基本信息

被如下接口引用:AddHostNodes

名称 必选 允许NULL 类型 描述
Hostname 是 否 String 主机名称
示例值: 无
Ipv4 否 是 String 主机ipv4,ipv4和ipv6必须至少选择一个填写
示例值: 无
Ipv6 否 是 String 主机ipv6,ipv4和ipv6必须至少选择一个填写
示例值: 无
Username 是 是 String 登录主机的用户名
示例值: 无
SshPort 是 是 Uint64 登录主机的端口
示例值: 无
Password 是 是 String 机器密码
示例值: 无
MachineType 是 否 String 机型,名称校验规则:^[a-zA-Z0-9-/]{1,64}$,总长度≤64,仅允许包含字符集[a-zA-Z0-9-/]
示例值: 无
Rack 是 否 String 机架,名称校验规则:^/[a-zA-Z0-9-/]{0,63}[^/]$,以斜杠开头,不以斜杠结尾,且总长度≤64,仅允许包含字符集[a-zA-Z0-9-/],机架名必填默认为 default-rack
示例值: 无
Arch 是 否 String 架构信息
示例值: 无
OrderNo 否 否 String 主机ID,TCE场景下使用
示例值: 无

TagPageResponse

标签分页列表返回VO

被如下接口引用:DescribeBaseTagPage

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 总条数
示例值:
List 是 否 Array of TagResponse 标签列表
示例值:查看

ConfGroupNodeInfo

配置组节点信息

被如下接口引用:DescribeConfigGroup

名称 必选 允许NULL 类型 描述
SerialNo 是 否 String 节点序列号
示例值:
Ip 是 否 String 节点IP
示例值:
Spec 是 否 String 节点规格
示例值:
CpuNum 是 否 Int64 Cpu核数
示例值:
NameTag 是 否 String 节点描述
示例值:
StorageType 是 否 Int64 磁盘类型
示例值:
ChargType 是 否 Int64 付费类型
示例值:
HwDiskSize 是 否 Int64 硬盘容量
示例值:
HwDiskSizeDesc 是 否 String 硬盘容量描述
示例值:
HwMemSize 是 否 Int64 内存容量
示例值:
HwMemSizeDesc 是 否 String 内存容量描述
示例值:
ResourceId 是 否 String 节点资源ID
示例值:
MCMultiDisk 是 否 Array of MultiDiskMC 多云盘信息
示例值:查看
Rack 是 是 String 机架信息
示例值:
Arch 是 是 String 架构信息
示例值:
Tags 是 是 Array of Tag 标签
示例值:查看
MachineType 是 是 String 机器类型
示例值:
Hostname 是 是 String 主机名
示例值:
HostId 是 是 Uint64 主机的自增ID
示例值:

ServiceMetricRoleTableItem

监控 服务概览页 角色表数据
一条表示某一行数据

被如下接口引用:DescribeInstanceServiceRoleTable

名称 必选 允许NULL 类型 描述
Row 是 否 Array of String 每个string表示一个field的值
示例值:

ServiceConfItem

配置项列表(配置管理页)

被如下接口引用:DescribeServiceConfsNew

名称 必选 允许NULL 类型 描述
ItemKVList 否 否 Array of ConfigurationItem 配置项key value列表
示例值:查看
ConfItemAttribute 否 否 String 配置项属性
示例值:
FileProperty 否 否 String 配置文件属性
示例值:

TableSimpleInfo

表简单信息

被如下接口引用:DescribeTable、DescribeTables

名称 必选 允许NULL 类型 描述
TableName 是 否 String 名称
示例值: table1
Desc 是 是 String 描述
示例值: null
CreateTime 是 是 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
示例值: 2025-09-10 15:25:46
CreateUser 是 是 String 创建人
示例值: jack
OptimizationType 否 是 Uint64 Iceberg 类型的表独有字段,表优化类型,0: 禁用、1: 默认、2: 自定义
示例值: 1

ColumnInfo

表动态列的详细信息

被如下接口引用:DescribeDynamicTableMeta

名称 必选 允许NULL 类型 描述
ColumnId 是 否 String 列Id
示例值:
ColumnNameCn 是 否 String 列中文名
示例值:
ColumnNameEn 是 否 String 列英文名
示例值:
Action 是 否 Int64 0-nothing; 1-sort; 2-filter
示例值:
IsShow 是 否 Int64 0-不展示,1-展示,-1 展示且不能关闭
示例值:
FilterList 是 是 Array of String 当action为2时,FilterList为可以选择的过滤值
示例值:
ColumnName 是 否 String 展示的列名
示例值:
Width 是 否 Int64 列宽度
示例值:
FilterArrays 是 是 Array of FilterRange 范围筛选数组
示例值:查看
Unit 是 是 String action为3时,筛选区间的单位
示例值:

ESDictInfo

ES词典信息,包括ES词典和ES插件词典

被如下接口引用:DescribeESDicts

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 词典ID
示例值:
Name 是 否 String 词典名称
示例值:
Status 是 否 Int64 词典状态
示例值:
Size 是 否 Int64 词典大小,单位为Byte
示例值:
Type 是 否 Int64 词典类型
示例值:
SubType 是 否 Int64 词典子类型
示例值:
StorageAddress 是 否 String 存储地址
示例值:
CreateUser 是 否 String 创建用户
示例值:
CreateTime 是 否 String 创建时间
示例值:
UpdateTime 是 否 String 更新时间
示例值:

ResourceAuthRequest

资源授权信息

被如下接口引用:CreateResourceAuthorization

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群id
示例值:
ResourceName 是 否 String 资源名称
示例值:
ResourceType 是 否 String 资源类型
示例值:
ResourcePath 否 否 String 资源路径
示例值:
AuthType 是 否 String 授权类型
示例值:
IsRecursive 否 否 Bool 是否recursive
示例值:
NameService 否 否 String 集群nameservice
示例值:

AbstractItems

角色基本信息

被如下接口引用:DescribeInstanceServiceBasicInfo

名称 必选 允许NULL 类型 描述
ItemKey 是 否 String 基本信息key
示例值:
ItemValue 是 否 String 基本信息value
示例值:
Title 是 否 String 标题
示例值:

CbsConfigQuotaInfo

磁盘信息

被如下接口引用:DescribeCloudServiceMeta

名称 必选 允许NULL 类型 描述
Available 是 是 Int64 售卖状态
示例值:
DiskType 是 是 String 磁盘类型;CLOUD_PREMIUM;CLOUD_SSD
示例值:
MaxiDiskSize 是 是 Int64 磁盘最大值
示例值:
MiniDiskSize 是 是 Int64 磁盘最小值
示例值:
PayMode 是 是 String 付费类型
示例值:
StorageType 是 是 String 存储类型
示例值:
StorageTypeName 是 是 String 存储类型名称
示例值:
DiskCnt 是 是 Int64 磁盘数量
示例值:
DeviceClass 是 是 String 设备类型
示例值:
CanDeleteFlag 是 是 Bool 本地盘可否删除
示例值:

ComponentPodSetting

容器集群组件Pod推荐规格设置

被如下接口引用:DescribeCloudServiceMeta

名称 必选 允许NULL 类型 描述
ServiceName 否 是 String 服务名称,如RSS、HIVE等
示例值:
ComponentName 否 是 String 角色名称,如ShuffleServer、HiveServer2
示例值:
PodSetting 否 是 ComponentPodDefaultSetting Pod规格推荐设置
示例值:查看
ComponentNum 否 是 Int64 角色编号
示例值:
ComponentAlias 否 是 String 角色别名
示例值:
SupportExternalAccess 否 是 Bool 角色是否支持设置外部访问
示例值:

TceHostBaseInfo

从TCE中拉取的CVM/BMS实例信息

被如下接口引用:DescribeTceHostInfos

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 自增id
示例值: 1
AppId 是 否 Uint64 租户ID
示例值: 1234567
InstanceId 是 否 String 主机实例ID
示例值: ins-xxxxx
Arch 是 否 String 主机架构
示例值: x86_64
Cpu 否 是 Uint64 CPU核数
示例值: 1
DataDisks 否 是 String 数据盘信息json,包含多个数据盘,保存每个数据盘的DiskSize和DiskType信息
示例值: 无
Ipv6 否 是 String ipv6地址
示例值: 无
ImageId 否 是 String 镜像Id,记录CVM主机的ImageId、bms主机的OperatingSystem信息
示例值: 无
Ipv4 否 是 String ipv4地址
示例值: 无
InstanceClass 否 是 String 主机实例机型
示例值: 无
InstanceFamily 否 是 String 主机实例类型
示例值: 无
InstanceName 是 否 String 主机实例名
示例值: 无
Hostname 否 是 String 主机名
示例值: 无
ZoneName 是 否 String 可用区名称
示例值: 无
SystemDiskSize 是 否 Uint64 系统盘大小,单位GB
示例值: 无
SystemDiskType 是 否 String 系统盘类型
示例值: 无
Uuid 是 否 String 主机的uuid
示例值: 无
Mem 否 是 Uint64 内存大小,单位G
示例值: 无
VpcId 是 否 String 私有网络id
示例值: 无
VpcName 否 是 String 私有网络名称
示例值: 无
SubnetId 是 否 String 子网ID
示例值: 无
SubnetName 否 是 String 子网名称
示例值: 无
CreateTime 是 否 String 创建时间
示例值: 无
UpdateTime 否 是 String 更新时间
示例值: 无
Tags 否 是 Array of Tag 标签,调用平台接口获取
示例值:查看

ModifyRacks

主机管理-修改机架信息

被如下接口引用:ModifyHostNodes

名称 必选 允许NULL 类型 描述
Rack 是 否 String 要修改的机架信息
示例值:
Ids 是 否 Array of Uint64 集群ID列表
示例值:

HostNodeDetails

主机管理-主机详情信息

被如下接口引用:DescribeHostNodes

名称 必选 允许NULL 类型 描述
Id 是 否 Uint64 主机自增ID
示例值: 无
AppId 是 否 Uint64 appid,主机是租户隔离的
示例值: 无
Hostname 是 否 String 主机名称
示例值: 无
OrderNo 是 否 String 资源id,添加后自动生成主机唯一标识资源 ID(规则为:tbds-开头,后续跟10个随机字符,同集群名称
示例值: 无
SerialNo 是 否 String 主机的uuid
示例值: 无
InitStatus 是 否 Int64 初始化状态,包含:0-未初始化、1-初始化中、2-已初始化、-1-初始化失败、-2-已删除
示例值: 无
Ipv4 是 是 String 主机ipv4
示例值: 无
Ipv6 是 是 String 主机ipv6
示例值: 无
Username 是 是 String 登录主机的用户名
示例值: 无
SshPort 是 是 Uint64 登录主机的端口
示例值: 无
Password 是 是 String 机器密码
示例值: 无
ClusterName 是 是 String 集群名字
示例值: 无
MachineType 是 否 String 机型,名称校验规则:^[a-zA-Z0-9-/]{1,64}$,总长度≤64,仅允许包含字符集[a-zA-Z0-9-/]
示例值: 无
Rack 是 否 String 机架,名称校验规则:^/[a-zA-Z0-9-/]{0,63}[^/]$,以斜杠开头,不以斜杠结尾,且总长度≤64,仅允许包含字符集[a-zA-Z0-9-/],机架名必填默认为 default-rack
示例值: 无
Arch 是 否 String 架构信息
示例值: 无
CreateTime 是 否 String 创建时间
示例值: 无
UpdateTime 是 否 String 更新时间
示例值: 无
ClusterId 是 是 String 集群ID,创建集群时,根据集群id填写
示例值: 无
OnlineStatus 是 否 Int64 在线状态,包括离线和在线,0-离线、1-在线
示例值: 无
Disk 是 是 String 磁盘信息:系统盘、数据盘信息,由bootstrap上报上来,对应disk
示例值: 无
CpuNum 是 是 Uint64 cpu信息,由bootstrap上报上来,对应cpunum字段
示例值: 无
Mem 是 是 Uint64 mem信息,由bootstrap上报上来,对应mem字段
示例值: 无
Os 是 是 String 操作系统,由bootstrap上报上来,对应Os字段
示例值: 无
LastHeartTime 是 是 String 最后心跳时间,由bootstrap上报上来,对应updatetime字段
示例值: 无
Tags 是 是 Array of Tag 标签,调用平台接口获取
示例值:查看
ClusterType 是 是 String 集群类型,0-一体化集群、1-物理化公共集群,多个集群使用逗号分隔
示例值: 无
ZoneName 否 是 String 可用区
示例值: az
VpcId 否 是 String 私有网络id
示例值: 无
SubnetId 否 是 String 子网ID
示例值: 无

VPCSettings

VPC 参数

被如下接口引用:DescribeServiceComponentInfos

名称 必选 允许NULL 类型 描述
VpcId 是 否 String VPC ID
示例值:
SubnetId 是 否 String Subnet ID
示例值:

SchemaSimpleInfo

数据库信息

被如下接口引用:DescribeSchemas

名称 必选 允许NULL 类型 描述
SchemaName 是 否 String 数据库名称
示例值:
Desc 是 是 String 数据库描述信息
示例值:
CreateTime 是 是 String 创建时间
示例值:
CreateUser 是 是 String 创建人
示例值:

TagKeyPageResponse

标签键分页返回VO

被如下接口引用:DescribeBaseTagKeyPage

名称 必选 允许NULL 类型 描述
TotalCount 是 否 Uint64 总条数
示例值:
List 是 否 String 标签键列表
示例值:

Namespace

监控命名空间分类

被如下接口引用:DescribeMetricMeta

名称 必选 允许NULL 类型 描述
Name 是 是 String 名称
示例值:
Groups 是 是 Array of Group 监控组列表
示例值:查看

ScheduleResources

调度资源

被如下接口引用:DescribeYarnScheduleBaseInfos

名称 必选 允许NULL 类型 描述
Memory 是 否 Int64 内存
示例值:
Vcores 是 否 Int64 核数
示例值:

OpScope

操作范围

被如下接口引用:RestartService、StartStopServiceOrMonitor

名称 必选 允许NULL 类型 描述
ServiceInfoList 否 是 Array of ServiceBasicRestartInfo 操作范围,要操作的服务信息
示例值:查看
NodeIdList 否 是 Array of Int64 操作范围,要操作的Node信息
示例值:
UuidList 否 是 Array of String 操作范围,要操作的节点信息
示例值:

Api3Filter

云api筛选配置

被如下接口引用:DescribeBaseResourceTagPage、DescribeBaseTagPage、DescribeBaseTagResourcePage、DescribeBaseTagValuePage、DescribeHDFSFolderFiles、DescribePolicyUserGroupPage、DescribePolicyUserPage、DescribeResourceAuthorizationPage、DescribeResourceGroupPage、DescribeResourceGroupRelationPage、DescribeRoleUserGroupPage、DescribeRoleUserPage、DescribeUserGroupPage、DescribeUserGroupRelationPage、DescribeUserPage

名称 必选 允许NULL 类型 描述
Name 是 否 String 筛选名称
示例值:
Values 是 否 Array of String 筛选值集合
示例值:

DataMaskPolicyItem

数据脱敏策略 ITEM

被如下接口引用:DescribeMaskRulesSTD、IssueMaskRulesSTD

名称 必选 允许NULL 类型 描述
Groups 否 是 Array of String 用户组名称
示例值:
Users 否 是 Array of String 用户名称
示例值:
Roles 否 是 Array of String 角色名称
示例值:
DataMaskInfo 否 是 DataMaskInfo 脱敏信息对象
示例值:查看

DeviceVO

磁盘块设备

被如下接口引用:DescribeAvailableDisks

名称 必选 允许NULL 类型 描述
DeviceName 是 否 String 磁盘设备名;eg:vda、vda1
示例值:
FileSystem 是 否 String 文件系统名;eg:xfs
示例值:
Capacity 否 否 String 磁盘设备容量;eg:500G
示例值:
DeviceType 否 否 String 磁盘设备类型;eg:park、disk
示例值:
UUID 否 否 String 磁盘唯一标识;eg:39c25fa5-02e8-4f22-a682-9f0c5267d0f
示例值:
MountPoint 是 否 String 磁盘挂载点;eg:/data
示例值:
Status 是 否 Int64 磁盘状态;eg:0:正常,1:掉盘,2:只读
示例值:

InstallClientInfo

安装客户端

被如下接口引用:DescribeInstallClient

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 id
示例值:
ClusterId 是 否 String 集群id
示例值:
SerialNo 是 否 String 主机id
示例值:
Ip 是 否 String 主机ip
示例值:
Ipv6 是 否 String 主机ipv6
示例值:
Port 是 否 Int64 端口
示例值:
User 是 否 String 用户名
示例值:
Password 是 否 String 密码
示例值:
AddMode 是 否 String 添加方式
示例值:
InstallPath 是 否 String 安装路径
示例值:
TbdsVersion 是 否 String tbds版本
示例值:
Arch 是 否 String 机器架构
示例值:
Status 是 否 Int64 安装状态: 1 安装中,2 安装成功, 3 安装失败 4 卸载中 5 卸载成功 6 卸载失败
示例值:
ConfigStatus 是 否 Int64 配置状态 已同步:1 配置过期:0
示例值:
CreateTime 是 否 String 创建时间
示例值:
UpdateTime 是 否 String 更新时间
示例值:
Stdout 是 否 String 输出
示例值:
Stderr 是 否 String 输出错误
示例值:
Md5Sum 是 否 String MD5值 (保留字段,当前版本暂未支持)
示例值:
ServiceList 是 是 Array of String 安装的组件列表
示例值:

PartitionItem

分区信息

被如下接口引用:DescribePartitions

名称 必选 允许NULL 类型 描述
Name 是 否 String 名称
示例值:
TransformStrtegy 否 是 String 分区转换策略
示例值:
TransformParam 否 是 Array of String 分区转换参数
示例值:
FieldType 否 是 String 分区字段类型,只针对于hive填写
示例值:
FieldParam 否 是 String 字段配置
示例值:

ScriptInfo

主机管理-添加主机时使用的脚本信息

被如下接口引用:InitHostNodes

名称 必选 允许NULL 类型 描述
Scripts 是 是 Array of Script 脚本信息
示例值:查看
WhenRun 是 否 String 脚本的运行时机,before表示前置脚本;after表示后置脚本
示例值:

ConfigModifyInfo

资源调度 - 队列修改信息

被如下接口引用:ModifyYarnQueue

名称 必选 允许NULL 类型 描述
Config 是 否 String // 配置集
示例值:
ParentId 否 是 String 新建资源池 传root的MyId;新建子池 传 选中队列的 myId;克隆 要传 选中队列 parentId
示例值:
MyId 否 是 String 编辑、删除、克隆 传 选中队列的 myId
示例值:
Name 是 否 String 队列名称
示例值:
LabelParams 否 是 Array of ItemSeq 标签信息
示例值:查看
BasicParams 否 是 ItemSeq 基础配置信息
示例值:查看
OpType 是 是 Int64 0表示新建资源池,1是编辑,2是新建子池,3是删除,4是克隆
示例值:

MetricMetaGroup

监控组

被如下接口引用:DescribeEmrMetricMeta、DescribeEmrMetricMetaNew

名称 必选 允许NULL 类型 描述
Title 是 否 String 组名
示例值:
MetricMetas 是 否 Array of MetricMeta 组内元数据
示例值:查看

ApplicationStatics

yarn application 统计信息

被如下接口引用:DescribeApplicationStatics

名称 必选 允许NULL 类型 描述
Queue 是 否 String 队列名
示例值:
User 是 否 String 用户名
示例值:
ApplicationType 是 否 String 作业类型
示例值:
SumMemorySeconds 是 否 Int64 SumMemorySeconds含义
示例值:
SumVCoreSeconds 是 否 Int64 SumVCoreSeconds含义
示例值:
SumHDFSBytesWritten 是 否 String SumHDFSBytesWritten(带单位)
示例值:
SumHDFSBytesRead 是 否 String SumHDFSBytesRead(待单位)
示例值:
CountApps 是 否 Int64 作业数
示例值:

ComponentWithService

DescribeNodeComponent返回参数

被如下接口引用:DescribeNodeComponent

名称 必选 允许NULL 类型 描述
ServiceComponent 是 否 String 服务组件名称
示例值:
ServiceState 是 否 Int64 服务组件状态
示例值:

GroupMetaDelta

修改监控元数据时 描述用户所选择的指标信息

被如下接口引用:ModifyMetricMetaPerInstanceNew

名称 必选 允许NULL 类型 描述
Title 是 否 String 名称
示例值:
MetricNames 是 否 Array of String 指标列表
示例值:

UserGroupRelationPageResponse

用户组绑定关系分页列表

被如下接口引用:DescribeUserGroupRelationPage

名称 必选 允许NULL 类型 描述
List 是 否 Array of UserGroupRelationResponse 用户组绑定关系列表
示例值:查看
TotalCount 是 否 Int64 总数
示例值:

ResourceGroupQuotaRemainResponse

资源组剩余可配置资源

被如下接口引用:DescribeResourceGroupQuotaRemain

名称 必选 允许NULL 类型 描述
CpuRemain 是 否 Int64 剩余Cpu
示例值:
MemoryRemain 是 否 Int64 剩余内存
示例值:

ExportConfContext

指定要导出配置的上下文结构

被如下接口引用:DescribeExportConfs

名称 必选 允许NULL 类型 描述
ServiceType 是 否 Int64 服务配置
示例值:
FileName 是 否 String 文件名
示例值:

AuthResource

资源对象

被如下接口引用:DescribeMaskRulesSTD、IssueMaskRulesSTD

名称 必选 允许NULL 类型 描述
Catalog 否 是 String Catalog
示例值:
Metalake 否 是 String Metalake
示例值:
Schema 否 是 String Schema
示例值:
Database 否 是 String Database
示例值:
Table 否 是 String Table
示例值:
ColumnFamily 否 是 String ColumnFamily
示例值:
Column 否 是 String Column
示例值:
Topic 否 是 String kafka 专用字段
示例值:
Path 否 是 String Path
示例值:
Namespace 否 是 String 命名空间
示例值:
Row 否 是 String Row
示例值:
ColumnQualifier 否 是 String ColumnQualifier
示例值:
Cell 否 是 String Cell
示例值:
NameService 否 是 String HDFS 的 nameService
示例值:

ServiceDependencyInfo

服务的依赖项信息

被如下接口引用:DescribeServiceDependency

名称 必选 允许NULL 类型 描述
ServiceName 是 否 String 服务名
示例值:
DependsOn 是 是 Array of String 依赖的服务名列表
示例值:

CloudService

CloudService

被如下接口引用:DescribeCloudInstanceService

名称 必选 允许NULL 类型 描述
ClusterId 否 是 Int64 集群号
示例值:
ServiceType 否 是 Int64 服务类别
示例值:
ServiceLayer 否 是 String 服务层级
示例值:
Status 否 是 Int64 服务状态
示例值:
Soft 否 是 String 服务信息
示例值:
UserName 否 是 String 用户
示例值:
UserGroup 否 是 String 组
示例值:
PathsInfo 否 是 String 路径
示例值:
AddTime 否 是 String 添加时间
示例值:
InternalService 否 是 Array of String 内部服务地址
示例值:
ExternalService 否 是 Array of String 外部服务地址
示例值:
IsExternal 否 是 Int64 是否外部服务
示例值:
DisPlay 否 是 Bool 是否展示
示例值:
SoftName 否 是 String soft名称
示例值:
DependentClusterId 否 是 String 服务所依赖的外部集群Id
示例值:
ExternalServiceIpv4 否 是 Array of String 外部服务地址
示例值:
DependentClusterIsEmrContainerCluster 否 是 Int64 关联依赖集群类型
示例值:
RunningNums 否 是 Int64 运行中数量
示例值:
ErrorNums 否 是 Int64 错误数量
示例值:

StoreStrategyInfo

存储策略信息

被如下接口引用:DescribeStoreStrategy

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 策略ID
示例值:
StrategyName 是 否 String 策略名
示例值:
StrategyType 是 否 String 策略类型(配额策略、存储策略)
示例值:
TypeId 是 否 String 冷热温策略ID
示例值:
UpdateTime 是 否 String 策略最后修改时间,年⽉⽇时分秒ISO型字符串:eg: 2014-08-12T12:00:00+08:00
示例值:
Path 是 否 String 策略所在的HDFS路径
示例值:
StrategyDetail 是 否 String 策略详情描述
示例值:
UsedFileSum 是 否 Int64 已用文件数量
示例值:
UsedStoreSum 是 否 Int64 已用存储容量(GB)
示例值:
TimeRule 是 否 Int64 时间规则
示例值:
MoveFailPaths 是 否 Array of String 转储失败的路径
示例值:
StorageFailPaths 是 否 Array of String 策略设置失败的路径
示例值:
Status 是 否 Int64 此策略状态为正常还是异常
示例值:
CatalogName 是 是 String Catalog名称
示例值:
DisplayPath 是 是 String 用于展示拼接了nameservice的path
示例值:

WebUIInfo

WebUI访问信息

被如下接口引用:DescribeServiceComponentInfos

名称 必选 允许NULL 类型 描述
Url 否 是 String 访问地址,可能为空
示例值:
WebUIStatus 否 是 Int64 WebUI状态包括:
-1表示当前服务没有WebUI;
0表示当前服务有WebUI,但是没有安装KNOX服务;
1表示当前服务有WebUI并安装有KNOX服务,但是KNOX没有开启公网访问;
2表示,当前服务有WebUI,安装有KNOX服务且已开启公网访问。
示例值:

LinkRssInfo

LinkRssInfo关联rss信息

被如下接口引用:DescribeCloudInstance

名称 必选 允许NULL 类型 描述
IsLinkRss 否 是 Bool 是否关联
示例值:
LinkedRssCluster 否 是 String 关联的rss集群
示例值:

PatchableClusterList

可以打补丁的集群

被如下接口引用:DescribeClustersForFederation、PatchableClusters

名称 必选 允许NULL 类型 描述
Id 否 是 Int64 集群id
示例值:
ClusterId 否 是 String 集群id
示例值:
ClusterName 否 是 String 集群名称
示例值:

UserRequest

用户信息入参

被如下接口引用:CreateUser

名称 必选 允许NULL 类型 描述
Name 否 否 String 用户名,导入时无需填写,新建时必须填写
示例值:
Remark 否 否 String 用户备注
示例值:
CamUin 否 否 Int64 cam用户id,新建时无需填写,导入时必须填写
示例值:
Phone 否 否 String 手机号,导入时无需填写,新建时必须填写
示例值:
Email 否 否 String 邮箱地址,导入时无需填写,新建时必须填写
示例值:
CountryCode 否 否 String 国际冠码
示例值:

EmrListInstance

集群列表返回示例

被如下接口引用:DescribeInstancesList

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
示例值: "tbds-q543m13q"
StatusDesc 是 是 String 状态描述
示例值: "集群运行中"
ClusterName 是 否 String 集群名字
示例值: "50节点集群"
ZoneId 是 否 Int64 集群地域
示例值: 0
AppId 是 否 Int64 用户APPID
示例值: 1255000002
AddTime 是 否 String 创建时间
示例值: "2025-05-24 15:25:07"
RunTime 是 否 String 运行时间
示例值: "1天19小时40分钟0秒"
MasterIp 是 否 String 集群IP
示例值: "10.206.20.41"
EmrVersion 是 否 String 集群版本
示例值: "5.3.1.5"
ChargeType 是 否 Int64 集群计费类型
示例值: 0
Id 是 否 Int64 emr ID
示例值: 78000003
ProductId 是 是 Int64 产品ID
示例值: 70
ProjectId 是 是 Int64 项目ID
示例值: 0
RegionId 是 是 Int64 区域
示例值: 1
SubnetId 是 是 Int64 子网ID
示例值: 0
VpcId 是 是 Int64 网络ID
示例值: 0
Zone 是 是 String 地区
示例值: ""
Status 是 是 Int64 状态码
示例值: 2
Tags 是 是 Array of Tag 实例标签
示例值:查看
AlarmInfo 是 是 String 告警信息
示例值: ""
IsWoodpeckerCluster 是 是 Int64 是否是woodpecker集群
示例值: 1
VpcName 是 是 String Vpc中文
示例值: ""
SubnetName 是 是 String 子网中文
示例值: ""
UniqVpcId 是 是 String 字符串VpcId
示例值: ""
UniqSubnetId 是 是 String 字符串子网
示例值: ""
ClusterClass 是 是 String 集群类型
示例值: "Hadoop"
IsMultiZoneCluster 是 是 Bool 是否为跨AZ集群
示例值: false
IsHandsCluster 是 是 Bool 是否手戳集群
示例值: true
OutSideSoftInfo 是 是 Array of SoftDependInfo 体外客户端组件信息
示例值:查看
IsSupportOutsideCluster 否 是 Bool 当前集群的应用场景是否支持体外客户端
示例值: []
RegionName 是 是 String 地域名称
示例值: "bj"
SecurityClusterInfo 是 是 SecurityClusterInfo 安全集群服务信息
示例值:查看
Uin 是 是 String 用户uin
示例值: "110000000000"
CorednsAddress 是 是 String Coredns地址信息
示例值: ""
HdfsClusterInfo 是 是 HdfsClusterInfo hdfs集群信息
示例值:查看

PreExecuteFileSettings

预执行脚本配置

被如下接口引用:ScaleOutInstance

名称 必选 允许NULL 类型 描述
Path 否 否 String 脚本在COS上路径,已废弃
示例值:
Args 否 否 Array of String 执行脚本参数
示例值:
Bucket 否 否 String COS的Bucket名称,已废弃
示例值:
Region 否 否 String COS的Region名称,已废弃
示例值:
Domain 否 否 String COS的Domain数据,已废弃
示例值:
RunOrder 否 否 Int64 执行顺序
示例值:
WhenRun 否 否 String resourceAfter 或 clusterAfter
示例值:
CosFileName 否 否 String 脚本文件名,已废弃
示例值:
CosFileURI 否 否 String 脚本的cos地址
示例值:
CosSecretId 否 否 String cos的SecretId
示例值:
CosSecretKey 否 否 String Cos的SecretKey
示例值:
AppId 否 否 String cos的appid,已废弃
示例值:

SearchItem

搜索字段

被如下接口引用:DescribeClusterNodes

名称 必选 允许NULL 类型 描述
SearchType 是 否 String 支持搜索的类型
示例值:
SearchValue 是 否 String 支持搜索的值
示例值:

GcListColumn

Gc列表列信息

被如下接口引用:DescribeGcList

名称 必选 允许NULL 类型 描述
ColumnId 是 否 String 列Id
示例值:
Name 是 否 String 列名
示例值:
Action 是 否 Int64 0-nothing; 1-sort; 2-filter; 3-sort & filter
示例值:
IsShow 是 否 Int64 0-不展示,1-展示,-1 展示且不能关闭,-2 不展示且不能关闭
示例值:
FilterList 是 否 Array of String 不为空时支持筛选
示例值:
FilterArrays 是 否 Array of FilterRange 不为空时支持范围筛选
示例值:查看
Width 是 否 Int64 200,单位px
示例值:

ResourceGroupQuotaRequest

资源组资源配额传参

被如下接口引用:CreateResourceGroup、ModifyResourceGroup

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群id
示例值:
ResourceName 是 否 String 资源名称
示例值:
ResourceType 是 否 String 资源类型
示例值:
ResourcePath 是 否 String 资源路径
示例值:
ResourceQuota 否 否 String 资源配额
示例值:
NameService 否 否 String 集群nameservice名称
示例值:

ESPluginInfo

ES插件信息

被如下接口引用:DescribeESPlugins

名称 必选 允许NULL 类型 描述
Id 是 否 Int64 插件ID
示例值:
Name 是 否 String 插件名称
示例值:
Type 是 否 Int64 插件类型,0-系统内置,1-自定义
示例值:
Status 是 否 Int64 插件状态
示例值:
Description 是 否 String 插件描述
示例值:
SupportOperations 是 否 Array of String 支持的操作数组
示例值:
CreateUser 是 否 String 创建用户
示例值:
CreateTime 是 否 String 创建时间
示例值:
UpdateTime 是 否 String 更新时间
示例值:

PodSpec

扩容容器资源时的资源描述

被如下接口引用:ScaleOutInstance

名称 必选 允许NULL 类型 描述
ResourceProviderIdentifier 是 否 String 外部资源提供者的标识符,例如"cls-a1cd23fa"。
示例值:
ResourceProviderType 是 否 String 外部资源提供者类型,例如"tke",当前仅支持"tke"。
示例值:
NodeType 是 否 String 资源的用途,即节点类型,当前仅支持"TASK"。
示例值:
Cpu 是 否 Int64 CPU核数。
示例值:
Memory 是 否 Int64 内存大小,单位为GB。
示例值:
DataVolumes 否 否 Array of String 资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用。弃用
示例值:
CpuType 否 否 String Eks集群-CPU类型,当前支持"intel"和"amd"
示例值:
PodVolumes 否 否 Array of PodVolume Pod节点数据目录挂载信息。
示例值:查看
IsDynamicSpec 否 否 Int64 是否浮动规格,1是,0否
示例值:
DynamicPodSpec 否 是 DynamicPodSpec 浮动规格
示例值:查看
VpcId 否 是 String 代表vpc网络唯一id
示例值:
SubnetId 否 是 String 代表vpc子网唯一id
示例值:
PodName 否 是 String pod name
示例值:

RestartPolicy

组件重启策略

被如下接口引用:DescribeServiceGroups、DescribeServiceNodeInfos

名称 必选 允许NULL 类型 描述
Name 是 否 String 重启策略名。
示例值:
DisplayName 是 否 String 策略展示名称。
示例值:
Describe 是 否 String 策略描述。
示例值:
BatchSizeRange 是 否 Array of Int64 批量重启节点数可选范围。
示例值:
IsDefault 是 否 String 是否是默认策略。
示例值:

CheckHostResult

主机管理-校验主机的结果信息

被如下接口引用:CheckHost

名称 必选 允许NULL 类型 描述
IP 是 是 String 主机的ipv4
示例值:
IPV6 是 是 String 主机的ipv6
示例值:
Status 是 否 Int64 主机的检查状态,-1-检查异常;0-已忽略;1-可添加
示例值:
Message 是 是 String 检查信息
示例值:
Arch 是 是 String 主机架构
示例值:

LdapInfo

ldap信息

被如下接口引用:GetComponentProperties

名称 必选 允许NULL 类型 描述
Credentials 是 是 String Credentials
示例值:
Url 是 是 String url
示例值:
JnsGatewayUrl 是 是 String TCE集成,ldap映射的jnsGatewayUrl
示例值:
Ipv6Url 是 是 String Ipv6Url
示例值:

HostWithRackInfo

机架信息

被如下接口引用:ModifyRackInfo

名称 必选 允许NULL 类型 描述
Uuid 是 否 String 机器uuid
示例值:
Rack 是 否 String 机架信息
示例值:

InstalledClusterList

已打某一个补丁的集群列表

被如下接口引用:InstalledClusters

名称 必选 允许NULL 类型 描述
Id 否 是 Int64 id
示例值:
ClusterId 否 是 String 集群id
示例值:
ClusterName 否 是 String 集群名称
示例值:
CreateTime 否 是 String 时间
示例值:
Operator 否 是 String 操作人
示例值:
OperatorUin 否 是 String 操作人uin
示例值:

EmrCloudInstanceInfo

容器集群集群列表返回示例

被如下接口引用:DescribeCloudInstancesList

名称 必选 允许NULL 类型 描述
ClusterId 是 否 String 集群ID
示例值:
Class 是 否 String 集群类型, 因Java SDK中获取Class属性的⽅法getClass()⽅法和Object的getClass()⽅法冲突, 因此Java SDK中改成了getClusterClass()⽅法⽤于获取Class属性的值
示例值:
StatusDesc 是 否 String 状态描述
示例值:
RegionId 是 否 Int64 4552
示例值:
AppId 是 否 Int64 用户APPID
示例值:
ProjectId 是 否 Int64 项目ID
示例值:
VpcId 是 否 Int64 网络ID
示例值:
SubnetId 是 否 Int64 子网ID
示例值:
Status 是 否 Int64 状态码
示例值:
AddTime 是 否 String 创建时间
示例值:
RunTime 是 否 String 运行时间
示例值:
IsWoodpeckerCluster 是 否 Int64 是否是woodpecker集群
示例值:
ResourceUsage 是 否 Usage 资源使用量
示例值:查看
Soft 是 否 Array of String 软件信息
示例值:
Id 是 否 Int64 EMRID
示例值:
ClusterName 是 否 String 集群名称
示例值:
EmrVersion 否 是 String 集群产品版本
示例值:
Tags 否 是 Array of Tag 集群标签
示例值:查看
ChargeType 否 是 Int64 计费类型。0表示按量计费,1表示包年包月
示例值:
AlarmInfo 否 是 String 集群错误信息
示例值:
TkeClusterId 是 是 String tke集群id
示例值:
IsPermission 是 是 Bool 用户是否有权限 针对公共集群使用
示例值:

ConfSubmissionLog

配置下发记录结构

被如下接口引用:ListConfLogs

名称 必选 允许NULL 类型 描述
Id 否 是 Int64 配置下发日志ID
示例值:
ClusterId 是 否 Int64 集群ID
示例值:
ServiceType 是 否 Int64 组件类型
示例值:
ServiceName 是 否 String 组件名
示例值:
Detail 是 否 String 详细信息
示例值:
Remark 是 否 String 备注信息
示例值:
SubTime 是 否 String 下发时间
示例值:
IsValidity 是 否 Int64 是否有效
示例值:
OperationFlag 是 否 Int64 操作标志,0:不支持回滚 1:支持回滚 2:已回滚
示例值:
ConfIdList 是 否 String 配置文件ID
示例值:
ConfLogType 是 否 Int64 配置下发方式,0:集群下发  1:节点下发
示例值:
Ips 是 是 Array of String 相关IP
示例值:
FileConf 是 否 String 配置文件名
示例值:
ConfGroupName 是 否 String 配置组名
示例值:

FolderFilesResponse

hdfs目录下的文件列表

被如下接口引用:DescribeHDFSFolderFiles

名称 必选 允许NULL 类型 描述
Data 是 是 Array of HdfsFile 文件列表
示例值:查看
TotalCount 是 否 Int64 符合条件的全部文件数
示例值:

ProcessDesc

缺失进程、非法进程描述

被如下接口引用:DescribeEMRNodeOverview

名称 必选 允许NULL 类型 描述
ProcessName 是 否 String 进程名
示例值:
Ips 是 否 Array of String Ip数组
示例值:
Count 是 否 Int64 确实进程的Ip数量
示例值:

ServiceProcessFunctionInfo

进程检测信息

被如下接口引用:DescribeServiceNodeInfos

名称 必选 允许NULL 类型 描述
DetectAlert 是 是 String 探测告警级别
示例值:
DetetcFunctionKey 是 是 String 探测功能描述
示例值:
DetetcFunctionValue 是 是 String 探测功能结果
示例值:
DetetcTime 是 是 String 探测结果
示例值:

CorednsAddress

Coredns地址信息

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
Address 是 是 String ipv4地址
示例值:
AddressIpv6 是 是 String ipv6地址
示例值:

FileMergeInfo

文件合并信息

被如下接口引用:DescribeCatalog、DescribeTable

名称 必选 允许NULL 类型 描述
MaxFileSize 否 是 Int64 文件目标大小
示例值:

Meta

监控元数据,对应一个服务

被如下接口引用:DescribeMetricMeta

名称 必选 允许NULL 类型 描述
ServiceName 是 是 String 监控服务名称
示例值:
Namespace 是 是 Array of Namespace 命名空间列表
示例值:查看

FilterField

过滤

被如下接口引用:DescribeHostNodes、DescribeInstanceOplog、DescribeTceHostInfos、ExDescribeInstanceOplog、ExportInstanceAuditLog

名称 必选 允许NULL 类型 描述
Name 是 否 String 过滤名称
示例值:
Values 是 否 Array of String 过滤值
示例值:

OpenTsdbFilter

opentsdb filter

被如下接口引用:DescribeEmrMetricData

名称 必选 允许NULL 类型 描述
Type 是 否 String filter类型,例如iwildcard
示例值:
Tagk 是 否 String 维度名,例如host,命名遵循开源软件OpenTSDB规范
示例值:
Filter 是 否 String 维度值,例如*
示例值:
GroupBy 否 否 Bool 匹配多个维度时是否group by
示例值:

Tag

标签

被如下接口引用:CreateBaseTag、DescribeCloudInstance、DescribeCloudInstancesList、DescribeClusterNodes、DescribeConfigGroup、DescribeHostNodes、DescribeInstances、DescribeInstancesList、DescribeTceHostInfos、ScaleOutInstance

名称 必选 允许NULL 类型 描述
TagKey 否 否 String 标签键
示例值:
TagValue 否 否 String 标签值
示例值:

ClusterClientQueryInfoFilter

过滤条件

被如下接口引用:DescribeClusterClients

名称 必选 允许NULL 类型 描述
ConfStatusList 否 是 Array of Int64 配置状态
示例值:
RoleList 否 是 Array of String 节点类型
示例值:

CustomServiceTopoInfo

服务自定义topo信息

被如下接口引用:ScaleOutInstance

名称 必选 允许NULL 类型 描述
DeployedServiceInfo 否 是 String 部署topo, 该数据需填经过deflate压缩后的值, 例如pVDLCsIwEPyXPWtrVQR70/agKApVvIiHUqMGYzZsUkGk/+5G6uuiB8lpHjvDZH0FK+gsCzHWO4T4CSGGxXKQZfNksoDGg10JshI1i52gw3TJPINDvkU0jPeEpXkn6rsRnnxiWFoKFRa5CmshtC4nwuJoX+YE9S6V9NtvSCJJd4G4XT2vZ7gVU2kdxOsrSHPuck7UCvyLWn2+Yq7H3HvfyaAW2vnNHJ/5+KFgQ/FQlvn+U2xGUDX+yic88t996bgbfM/mY1sqlHD1Ql0qVW1u为[{"serviceInfo":{"service":"STARROCKS","serviceVersion":"3.3","user":"hadoop","group":"hadoop","serviceHome":"/usr/local/service/starrocks","serviceConfDir":"/usr/local/service/starrocks","priority":2},"serviceNodeList":[{"ipv4":"10.0.0.109","ipv6":"","serviceComponent":"StarRocksBe","componentTag":"StarRocksBe-1"},{"ipv4":"10.0.0.109","ipv6":"","serviceComponent":"StarRocksBroker","componentTag":"StarRocksBroker-1"}],"serviceNodeDeleteList":null}]的deflate压缩值
示例值: 1
HostRoleMap 否 是 String 选择的机器,角色对应的机器IP, 该数据需填经过deflate压缩后的值, 例如q1ZKzi9KVbKKrlbyLCgzUbJSMjTQA0FDA0slHZCYGVAMyAotzUxBla2NrQUA为{"core":[{"Ipv4":"10.0.0.109","Ipv6":"","Uuid":"10.0.0.109"}]}的deflate压缩值
示例值: 1

ClusterNameInfo

查询日志出参

被如下接口引用:DescribeInstanceOpType

名称 必选 允许NULL 类型 描述
ClusterId 是 是 String 集群ID
示例值:
ClusterName 是 是 String 集群名称
示例值:
Id 是 是 Int64 集群表id
示例值:

ServiceBasicRestartInfo

操作的服务范围

被如下接口引用:RestartService、StartStopServiceOrMonitor

名称 必选 允许NULL 类型 描述
ServiceName 否 否 String 服务名,必填,如HDFS
示例值:
ComponentInfoList 否 否 Array of ComponentBasicRestartInfo 如果没传,则表示所有进程
示例值:查看

HostVolumeContext

Pod HostPath挂载方式描述

被如下接口引用:ScaleOutInstance

名称 必选 允许NULL 类型 描述
VolumePath 是 是 String Pod挂载宿主机的目录。资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用
示例值:

AlertInfo

警报信息

被如下接口引用:DescribeAlarmHistoryList

名称 必选 允许NULL 类型 描述
AlarmContent 是 是 String 报警内容
示例值:
AlarmObject 是 是 String 报警对象
示例值:
CurrentLevel 是 是 String 当前级别
示例值:
FirstTime 是 是 String 开始时间
示例值:
LastTime 是 是 String 结束时间
示例值:
Strategy 是 是 String 策略
示例值:
Status 是 是 String 状态
示例值:

NodeHardwareInfo

节点硬件信息

被如下接口引用:DescribeClusterNodes

名称 必选 允许NULL 类型 描述
AppId 否 是 Int64 用户APPID
示例值:
SerialNo 否 是 String 序列号
示例值:
OrderNo 否 是 String 机器实例ID
示例值:
WanIp 否 是 String master节点绑定外网IP
示例值:
Flag 否 是 Int64 节点类型。0:common节点;1:master节点
;2:core节点;3:task节点
示例值:
Spec 否 是 String 节点规格
示例值:
CpuNum 否 是 Int64 节点核数
示例值:
MemSize 否 是 Int64 节点内存
示例值:
MemDesc 否 是 String 节点内存描述
示例值:
RegionId 否 是 Int64 节点所在region
示例值:
ZoneId 否 是 Int64 节点所在Zone
示例值:
ApplyTime 否 是 String 申请时间
示例值:
FreeTime 否 是 String 释放时间
示例值:
DiskSize 否 是 String 硬盘大小
示例值:
NameTag 否 是 String 节点描述
示例值:
Services 否 是 String 节点部署服务
示例值:
StorageType 否 是 Int64 磁盘类型
示例值:
RootSize 否 是 Int64 系统盘大小
示例值:
ChargeType 否 是 Int64 付费类型
示例值:
CdbIp 否 是 String 数据库IP
示例值:
CdbPort 否 是 Int64 数据库端口
示例值:
HwDiskSize 否 是 Int64 硬盘容量
示例值:
HwDiskSizeDesc 否 是 String 硬盘容量描述
示例值:
HwMemSize 否 是 Int64 内存容量
示例值:
HwMemSizeDesc 否 是 String 内存容量描述
示例值:
ExpireTime 否 是 String 过期时间
示例值:
EmrResourceId 否 是 String 节点资源ID
示例值:
IsAutoRenew 否 是 Int64 续费标志
示例值:
DeviceClass 否 是 String 设备标识
示例值:
Mutable 否 是 Int64 支持变配
示例值:
MCMultiDisk 否 是 Array of MultiDiskMC 多云盘
示例值:查看
CdbNodeInfo 否 是 CdbInfo 数据库信息
示例值:查看
Ip 否 是 String 内网IP
示例值:
Destroyable 否 是 Int64 此节点是否可销毁,1可销毁,0不可销毁
示例值:
Tags 否 是 Array of Tag 节点绑定的标签
示例值:查看
AutoFlag 否 是 Int64 是否是自动扩缩容节点,0为普通节点,1为自动扩缩容节点。
示例值:
HardwareResourceType 否 是 String 资源类型, host/pod
示例值:
IsDynamicSpec 否 是 Int64 是否浮动规格,1是,0否
示例值:
DynamicPodSpec 否 是 String 浮动规格值json字符串
示例值:
SupportModifyPayMode 否 是 Int64 是否支持变更计费类型 1是,0否
示例值:
RootStorageType 否 是 Int64 系统盘类型
示例值:
Zone 否 是 String 可用区信息
示例值:
SubnetInfo 否 是 SubnetInfo 子网
示例值:查看
Clients 否 是 String 客户端
示例值:
CurrentTime 否 是 String 系统当前时间
示例值:
IsFederation 否 是 Int64 是否用于联邦 ,1是,0否
示例值:
DeviceName 否 是 String 设备名称
示例值:
ServiceClient 否 是 String 服务
示例值:
DisableApiTermination 否 是 Bool 该实例是否开启实例保护,true为开启 false为关闭
示例值:
TradeVersion 否 是 Int64 0表示老计费,1表示新计费
示例值:
FaultType 是 是 Array of Int64 节点故障类型:
101:实例运行隐患
102:实例运行异常
103:实例硬盘异常
104:实例网络连接异常
105:实例运行预警
106:实例硬盘预警
107:实例维护升级
示例值:
SupportRepairDisk 是 是 Int64 0:不支持、1:支持
示例值:
Ipv6 是 是 String ipv6字段
示例值:
HostName 是 是 String 主机名
示例值:
Arch 是 是 String 机器架构信息
示例值:
RoleExtTag 是 是 String 机器的标签信息
示例值:
InstanceId 是 是 String 集群id
示例值:
Rack 是 是 String 机架信息
示例值:
MachineType 是 是 String 机型信息
示例值:

CLBSetting

容器集群Pod服务CLB设置

被如下接口引用:DescribeServiceComponentInfos

名称 必选 允许NULL 类型 描述
CLBType 否 否 String CLB类型,PUBLIC_IP表示支持公网CLB和INTERNAL_IP表示支持内网CLB字段 
示例值:
VPCSettings 否 否 VPCSettings Vpc和子网信息设置
示例值:查看

PatchedInfoSoftList

升级信息预览

被如下接口引用:DescribePatchedInfo、PatchedReport

名称 必选 允许NULL 类型 描述
SoftName 否 是 String 组件名称
示例值:
SoftVersion 否 是 String 组件版本
示例值:
ServiceDetectStatus 否 是 Int64 组件状态
示例值:
IsInstall 否 是 Int64 是否安装
示例值:
SourceVersion 否 是 String 原版本
示例值:
TargetVersion 否 是 String 目标版本
示例值:
UpgradeType 否 是 String 升级类型
示例值:
ReleaseNotes 否 是 String 发行说明
示例值:

InstanceSpecLimitInfo

实例规格限制信息

被如下接口引用:DescribeTceInstanceConfigInfos

名称 必选 允许NULL 类型 描述
MinCpu 否 否 Int64 最小CPU限制
示例值: 8
MinMem 否 否 Int64 最小内存限制
示例值: 32
MinSysDiskSize 否 否 Int64 最小系统盘限制
示例值: 150
CVMImageNames 否 否 Array of String CVM支持的镜像名称列表
示例值: 无
BmsImageNames 否 否 Array of String BMS支持的镜像名称列表
示例值: 无

SecurityClusterInfo

安全集群服务信息

被如下接口引用:DescribeInstancesList

名称 必选 允许NULL 类型 描述
SecurityClusterId 是 是 String 安全集群的ID
示例值:
SecurityServices 是 是 Array of String 安全服务列表
示例值:

Script

脚本信息

被如下接口引用:InitHostNodes

名称 必选 允许NULL 类型 描述
Name 是 否 String 脚本名称
示例值:
Args 否 否 Array of String 脚本参数
示例值:
Type 是 否 Int64 脚本类型,0表示自定义、1表示内置
示例值:

UserResponse

TBDS用户出参

被如下接口引用:CreateUser、DescribeLoginUser、DescribePolicyUserPage、DescribeRoleUserPage、DescribeUser、DescribeUserByName、DescribeUserPage

名称 必选 允许NULL 类型 描述
Id 是 是 Int64 用户id
示例值:
Name 是 否 String 用户名称
示例值:
AppId 是 是 String 租户AppId
示例值:
Scope 是 是 String 范围,system 内置 / custom 自定义
示例值:
Remark 是 是 String 用户备注
示例值:
CamUin 是 否 Int64 cam用户uin
示例值:
CamUid 是 是 Int64 cam用户uid
示例值:
Phone 是 是 String 用户手机
示例值:
Email 是 是 String 用户邮箱
示例值:
CreateTime 是 是 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
示例值:
SupportModify 是 是 Bool 该TBDS用户是否支持编辑
示例值:
SupportDelete 是 是 Bool 该TBDS用户是否支持删除
示例值:
SupportDownLoadKeyTab 是 是 Bool 该TBDS用户是否支持下载当前用户的KeyTab文件
示例值:
SupportModifyPwd 是 是 Bool 该TBDS用户是否支持修改当前用户的集群密码
示例值:
SupportModifyKeyTabExpireTime 是 是 Bool 该TBDS用户是否支持修改当前用户的keytab有效期
示例值:
KeyTabExpireTime 是 是 String KeyTab过期时间
示例值:
KeyTabStatus 是 是 String KeyTab状态,normal 正常/ warning 即将过期/ expired 已过期
示例值:
TBDSPolicies 是 是 Array of String 该用户包含的TBDS策略名称列表,包含间接方式获取的,比如属于某个拥有TBDS策略用户组下,则也会拥有该TBDS策略。
示例值:
DownloadUrl 是 是 String keytab下载地址
示例值:
CountryCode 是 是 String 手机号国际冠码
示例值:

TopNHostMetrics

监控概览页主机维度topn监控数据

被如下接口引用:DescribeTopNByHost

名称 必选 允许NULL 类型 描述
NodeType 是 是 String MASTER/CORE/COMMON
示例值:
Ip 是 否 String ip
示例值:
Id 是 否 Int64 id
示例值:
Score 是 否 Float 分数
示例值:

DiskInfo

磁盘挂盘信息

被如下接口引用:InitHostNodes

名称 必选 允许NULL 类型 描述
Devname 否 否 String 磁盘名称
示例值:
Mountpoint 否 否 String 挂载点
示例值:
Filesystem 否 否 String 文件系统
示例值:
EnableMount 否 否 Bool 是否启用挂盘
示例值:
EnableFormat 否 否 Bool 是否启用格式化
示例值:

FilterRange

快捷分组范围

被如下接口引用:DescribeDynamicTableMeta、DescribeGcList

名称 必选 允许NULL 类型 描述
Value 是 否 String 范围(数值)
示例值:
ValueDesc 是 否 String 范围展示值
示例值:

SubnetInfo

子网信息

被如下接口引用:DescribeClusterNodes、DescribeInstances

名称 必选 允许NULL 类型 描述
SubnetName 否 是 String 子网信息(名字)
示例值:
SubnetId 否 是 String 子网信息(ID)
示例值:

ExportConfMeta

导出配置结构体

被如下接口引用:DescribeExportConfs

名称 必选 允许NULL 类型 描述
ServiceName 是 是 String 组件名称
示例值: "FILEBEAT"
Classification 是 是 String 文件名
示例值: "filebeat.yml"
ServiceVersion 是 是 String 组件版本
示例值: "7.2.0"
Properties 是 是 String 导出配置参数,base64格式
示例值: "eyJhcHBJZCI6IjEyNTUwMDAwMDIiLCJjbHVzdGVySWQiOiIxNDI2NSIsImNsdXN0ZXJUeXBlIjoiaGFkb29wIiwiaG9zdElwIjoiZW1yLWRlZmF1bHQiLCJpbnN0YW5jZUlkIjoidGJkcy1udTdja20zZyIsImxvZ3N0YXNoSG9zdHMiOiIxMC40LjIuODM6ODA4NCIsIm1vbml0b3JQb3J0IjoiMTM3OCIsInJlZ2lvbiI6Imd6In0="

ClusterClientQueryInfo

客户端信息

被如下接口引用:DescribeClusterClients

名称 必选 允许NULL 类型 描述
Service 否 是 String 服务
示例值:
Ip 否 是 String IP信息
示例值:
Role 否 是 String 节点类型
示例值:
ConfGroup 否 是 String 配置组名字
示例值:
ConfStatus 否 是 Int64 配置状态
示例值:

ClusterInstancesInfo

集群实例信息

被如下接口引用:DescribeInstances

名称 必选 允许NULL 类型 描述
Id 是 是 Int64 ID号
示例值:
ClusterId 是 是 String 集群ID
示例值:
Ftitle 是 是 String 标题
示例值:
ClusterName 是 是 String 集群名
示例值:
RegionId 是 是 Int64 地域ID
示例值:
ZoneId 是 是 Int64 地区ID
示例值:
AppId 是 是 Int64 用户APPID
示例值:
Uin 是 是 String 用户UIN
示例值:
ProjectId 是 是 Int64 项目Id
示例值:
VpcId 是 是 Int64 集群VPCID
示例值:
SubnetId 是 是 Int64 子网ID
示例值:
Status 是 是 Int64 实例的状态码。取值范围:
  • 2:表示集群运行中。
  • 3:表示集群创建中。
  • 4:表示集群扩容中。
  • 5:表示集群增加router节点中。
  • 6:表示集群安装组件中。
  • 7:表示集群执行命令中。
  • 8:表示重启服务中。
  • 9:表示进入维护中。
  • 10:表示服务暂停中。
  • 11:表示退出维护中。
  • 12:表示退出暂停中。
  • 13:表示配置下发中。
  • 14:表示销毁集群中。
  • 15:表示销毁core节点中。
  • 16:销毁task节点中。
  • 17:表示销毁router节点中。
  • 18:表示更改webproxy密码中。
  • 19:表示集群隔离中。
  • 20:表示集群冲正中。
  • 21:表示集群回收中。
  • 22:表示变配等待中。
  • 23:表示集群已隔离。
  • 24:表示缩容节点中。
  • 33:表示集群等待退费中。
  • 34:表示集群已退费。
  • 301:表示创建失败。
  • 302:表示扩容失败。

  • 示例值:
    AddTime 是 是 String 添加时间
    示例值:
    RunTime 是 是 String 已经运行时间
    示例值:
    Config 是 是 EmrProductConfigOutter 集群产品配置信息
    示例值:查看
    MasterIp 是 是 String 主节点外网IP
    示例值:
    EmrVersion 是 是 String EMR版本
    示例值:
    ChargeType 是 是 Int64 收费类型
    示例值:
    TradeVersion 是 是 Int64 交易版本
    示例值:
    ResourceOrderId 是 是 Int64 资源订单ID
    示例值:
    IsTradeCluster 是 是 Int64 是否计费集群
    示例值:
    AlarmInfo 是 是 String 集群错误状态告警信息
    示例值:
    IsWoodpeckerCluster 是 是 Int64 是否采用新架构
    示例值:
    MetaDb 是 是 String 元数据库信息
    示例值:
    Tags 是 是 Array of Tag 标签信息
    示例值:查看
    HiveMetaDb 是 是 String Hive元数据信息
    示例值:
    ServiceClass 是 是 String 集群类型:EMR,CLICKHOUSE,DRUID
    示例值:
    AliasInfo 是 是 String 集群所有节点的别名序列化
    示例值:
    ProductId 是 是 Int64 集群版本Id
    示例值:
    Zone 是 是 String 地区ID
    示例值:
    SceneName 是 是 String 场景名称
    示例值:
    SceneServiceClass 是 是 String 场景化集群类型
    示例值:
    SceneEmrVersion 是 是 String 场景化EMR版本
    示例值:
    DisplayName 是 是 String 场景化集群类型
    示例值:
    VpcName 是 是 String vpc name
    示例值:
    SubnetName 是 是 String subnet name
    示例值:
    ClusterExternalServiceInfo 是 是 Array of ClusterExternalServiceInfo 集群依赖关系
    示例值:查看
    UniqVpcId 是 是 String 集群vpcid 字符串类型
    示例值:
    UniqSubnetId 是 是 String 子网id 字符串类型
    示例值:
    TopologyInfoList 是 是 Array of TopologyInfo 节点信息
    示例值:查看
    IsMultiZoneCluster 是 是 Bool 是否是跨AZ集群
    示例值:
    IsCvmReplace 是 是 Bool 是否开通异常节点自动补偿
    示例值:
    ExtMetaInfo 是 是 String 扩展元数据信息
    示例值:
    SharedKerberos 是 是 Int64 是否共享kdc,物理化公共集群使用
    示例值:
    CorednsAddress 是 是 CorednsAddress Coredns地址信息
    示例值:查看
    ExternalCertification 是 是 ExternalCertification 共享kdc的信息,物理化公共集群开启共享kdc后使用
    示例值:查看

    NodeArrCommon

    配置导出查询ip返回类型

    被如下接口引用:DescribeFileIps

    名称 必选 允许NULL 类型 描述
    Ip 是 否 String 节点IP
    示例值: "10.4.2.120"
    Flag 是 否 Int64 节点类型,1表示master,2表示core,3表示task,4表示common -99表示all,-1表示router
    示例值: 0
    NodeFlagFilter 是 是 String 节点过滤标识,master core task common  router all,默认为all
    示例值: "master&core"
    DeployServiceTypeList 是 是 Array of Int64 服务对应标识数组
    示例值: []
    Rack 是 是 String 机架信息
    示例值: "/rack1"

    Filters

    Emr集群列表实例自定义查询过滤

    被如下接口引用:ClustersUpgradeList、DescribeCloudInstancesList、DescribeESPlugins、DescribeFlowStatus、DescribeInstallClient、DescribeInstancesList、DescribeServiceComponentInfos、DescribeServicePodNodeInfos、ListPatch

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 字段名称
    示例值:
    Values 是 否 Array of String 过滤字段值
    示例值:

    OutterResource

    资源详情

    被如下接口引用:DescribeInstances

    名称 必选 允许NULL 类型 描述
    Spec 是 是 String 规格
    示例值:
    SpecName 是 是 String 规格名
    示例值:
    StorageType 是 是 Int64 硬盘类型
    示例值:
    DiskType 是 是 String 硬盘类型
    示例值:
    RootSize 是 是 Int64 系统盘大小
    示例值:
    MemSize 是 是 Int64 内存大小
    示例值:
    Cpu 是 是 Int64 CPU个数
    示例值:
    DiskSize 是 是 Int64 硬盘大小
    示例值:
    InstanceType 是 是 String 规格
    示例值:

    WeightConfig

    权重配置

    被如下接口引用:CreateServiceResourceConfig、DescribeServiceResourceConfig、ModifyServiceResourceConfig

    名称 必选 允许NULL 类型 描述
    Service 否 是 String 服务名
    示例值:
    CPULimit 否 是 Float 核数限制百分比
    示例值:
    CPUShare 否 是 Float 单核抢占时的百分比
    示例值:
    BlkIO 否 是 Float 磁盘IO百分比
    示例值:
    ServiceComponents 否 是 Array of String 涉及的组件列表
    示例值:

    PodNodeDetailInfo

    集群pod节点详情信息

    被如下接口引用:DescribeServicePodNodeInfos

    名称 必选 允许NULL 类型 描述
    PodName 是 否 String pod名称
    示例值:
    HealthStatus 是 是 HealthStatus 健康状态
    示例值:查看
    PodIp 是 是 String pod ip
    示例值:
    PodStatus 是 是 String pod状态
    示例值:
    RestartCount 是 是 Int64 重启次数
    示例值:
    LastRestartTime 是 是 String 最后重启时间
    示例值:

    ServiceLayerIn

    ServiceLayerIn

    被如下接口引用:DescribeCloudInstanceService

    名称 必选 允许NULL 类型 描述
    ServiceLayer 否 是 String 服务层级
    示例值:
    CloudServices 否 是 Array of CloudService 服务信息
    示例值:查看

    ImpalaQueryMetric

    impala query 指标元数据

    被如下接口引用:DescribeImpalaQueryMetricsMeta

    名称 必选 允许NULL 类型 描述
    Id 是 否 Int64 指标id
    示例值:
    Title 是 否 String 指标title
    示例值:
    MetricName 是 否 String 指标名
    示例值:
    IsSelected 是 否 Bool 是否选中
    示例值:

    FlowParamsDesc

    任务参数描述

    被如下接口引用:DescribeFlowStatus

    名称 必选 允许NULL 类型 描述
    PKey 是 否 String 参数key
    示例值:
    PValue 是 是 String 参数value
    示例值:

    SchedulerTaskDetail

    调度任务详情

    被如下接口引用:DescribeYarnScheduleHistory

    名称 必选 允许NULL 类型 描述
    Step 是 是 String 步骤
    示例值:
    Progress 是 是 String 进度
    示例值:
    FailReason 是 是 String 失败信息
    示例值:
    JobId 是 是 Int64 任务id
    示例值:

    Label

    yarn的标签信息

    被如下接口引用:DescribeYarnLastestLabels、ModifyOldLabelConfig、ModifyYarnLabels

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 标签名称
    示例值:
    LabelState 否 否 Int64 只有值为0才在资源池显示
    示例值:
    UnDeletable 是 否 Bool true不可以删除
    示例值:
    Exclusive 是 否 Bool 是否排他
    示例值:
    Nodes 否 是 Array of String 节点的ip列表
    示例值:
    CanNotChangeExclusive 否 是 Bool true表示不可以编辑exclusive
    示例值:

    Usage

    资源用量

    被如下接口引用:DescribeCloudInstance、DescribeCloudInstancesList

    名称 必选 允许NULL 类型 描述
    Cpu 是 是 String cpu用量
    示例值:
    Mem 是 是 String 内存用量
    示例值:

    YarnResourceResponse

    yarn资源VO返回

    被如下接口引用:DescribeYarnResourceList

    名称 必选 允许NULL 类型 描述
    ResourceGroupId 是 否 Int64 资源组id
    示例值:
    ResourceGroupName 是 否 String 资源组名称
    示例值:
    ResourceName 是 否 String 资源名称
    示例值:
    ResourcePath 是 否 String 资源路径
    示例值:
    CpuMax 是 否 Int64 最大CPU
    示例值:
    CpuMin 是 否 Int64 最小CPU
    示例值:
    MemoryMax 是 否 Float 最大内存
    示例值:
    MemoryMin 是 否 Float 最小内存
    示例值:

    ResourceGroupResponse

    资源组VO

    被如下接口引用:CreateResourceGroup、DescribeResourceGroup、DescribeResourceGroupPage、ModifyResourceGroup

    名称 必选 允许NULL 类型 描述
    Id 是 否 Int64 资源组id
    示例值:
    Name 是 否 String 资源组名称
    示例值:
    Remark 是 是 String 资源组描述
    示例值:
    Scope 是 否 String 资源组范围
    示例值:
    CreateTime 是 否 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    Status 是 否 String 资源组状态
    示例值:
    ErrorMessage 是 否 String 错误信息
    示例值:
    ClusterId 是 否 String 集群id
    示例值:
    Type 是 否 String 资源组类型
    示例值:
    CpuQuota 是 是 Int64 Cpu配额
    示例值:
    MemoryQuota 是 是 Int64 内存配额
    示例值:
    Resources 是 是 Array of ResourceGroupQuotaResponse 绑定资源列表
    示例值:查看
    QuotaSummary 是 是 ResourceGroupQuotaSummaryResponse 资源组配额总览
    示例值:查看
    ClusterName 是 是 String 集群名称
    示例值:
    AppId 是 是 String 租户AppId
    示例值:

    InitHostNodeInfo

    主机管理-重置主机的信息,包括磁盘和id信息

    被如下接口引用:InitHostNodes

    名称 必选 允许NULL 类型 描述
    Id 是 否 Uint64 节点ID
    示例值:
    DiskInfo 否 否 Array of DiskInfo 主机的挂盘信息
    示例值:查看

    ResourceGroupPageResponse

    资源组分页列表出参

    被如下接口引用:DescribeResourceGroupPage

    名称 必选 允许NULL 类型 描述
    List 是 否 Array of ResourceGroupResponse 资源组列表
    示例值:查看
    TotalCount 是 否 Int64 总条数
    示例值:

    ServerInfo

    机器信息

    被如下接口引用:CheckHost

    名称 必选 允许NULL 类型 描述
    IP 是 否 String 机器IP
    示例值:
    Port 是 否 Int64 ssh端口
    示例值:
    Username 是 否 String 用户名
    示例值:
    Password 是 否 String 密码
    示例值:
    IPV6 否 否 String 机器IPv6
    示例值:

    ClientInfo

    客户端

    被如下接口引用:DescribeOperatingClients

    名称 必选 允许NULL 类型 描述
    Id 是 否 Int64 id
    示例值: 7
    ClusterId 是 否 String 集群id
    示例值: "tbds-6a3xe37g"
    SerialNo 是 否 String 主机id
    示例值: ""
    Ip 是 否 String 主机ip
    示例值: "10.0.0.139"
    Ipv6 是 否 String 主机ip
    示例值: ""
    AddMode 是 否 String 添加方式
    示例值: "手动安装"
    DownloadPath 是 否 String 下载路径
    示例值: "/data/tbdsClient"
    TbdsVersion 是 否 String tbds版本
    示例值: "TBDS-5.3.1.5"
    Arch 是 否 String 机器架构
    示例值: "x86_64"
    Status 是 否 Int64 状态
    示例值: -1
    CreateTime 是 否 String 创建时间
    示例值: "2025-09-09 15:51:29"
    UpdateTime 是 否 String 更新时间
    示例值: "2025-09-09 15:51:34"
    Stdout 是 否 String 输出
    示例值: ""
    Stderr 是 否 String 输出错误
    示例值: ""
    Md5Sum 是 否 String MD5值
    示例值: ""
    User 是 否 String 用户名
    示例值: "root"
    Password 是 否 String 密码
    示例值: "password"
    Port 是 否 Int64 端口
    示例值: 22

    DefaultConfMeta

    默认配置项信息

    被如下接口引用:DescribeDefaultFileConfig

    名称 必选 允许NULL 类型 描述
    Id 否 是 Int64 id
    示例值:
    ServiceName 否 是 String 服务
    示例值:
    Classification 否 是 String 配置名
    示例值:
    ServiceVersion 否 是 String 服务版本
    示例值:
    FieldName 否 是 String 配置项
    示例值:
    FieldValue 否 是 String 配置值
    示例值:
    Description 否 是 String 描述
    示例值:
    Valid 否 是 Uint64 是否有效
    示例值:
    ClassName 否 是 String 集群类型
    示例值:
    ProductId 否 是 Int64 产品id
    示例值:
    Type 否 是 String 值类型
    示例值:
    Range 否 是 Array of String 取值范围
    示例值:

    SchemaIdenty

    schema 名称信息

    被如下接口引用:DescribeTables

    名称 必选 允许NULL 类型 描述
    CatalogName 是 否 String catalog 名字
    示例值:
    SchemaName 是 否 String 数据库名称
    示例值:

    RequestFilter

    请求过滤器

    被如下接口引用:DescribeCatalogList、DescribeFields、DescribePartitions、DescribeSchemas、DescribeTables

    名称 必选 允许NULL 类型 描述
    Name 否 否 String 过滤字段名
    示例值:
    Values 否 否 Array of String 过滤值
    示例值:

    Api3Order

    API3.0规范通用列表查询排序条件

    被如下接口引用:DescribeHDFSFolderFiles、DescribeMaskRulesSTD、DescribeResourceAuthorizationPage、DescribeResourceGroupPage、DescribeResourceGroupRelationPage、DescribeStoreStrategy、DescribeUserGroupPage、DescribeUserGroupRelationPage、DescribeUserPage

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 排序参数名称
    示例值:
    Direction 是 否 String 排序参数顺序 ASC 

    ServiceNodeDetailInfo

    服务进程信息

    被如下接口引用:DescribeServiceNodeInfos

    名称 必选 允许NULL 类型 描述
    Ip 是 否 String 进程所在节点IP
    示例值: "10.4.2.120"
    NodeType 是 否 Int64 进程类型
    示例值: 1
    NodeName 是 否 String 进程名称
    示例值: "NameNode"
    ServiceStatus 是 否 Int64 服务组件状态
    示例值: 1
    MonitorStatus 是 否 Int64 进程监控状态
    示例值: 1
    Status 是 否 Int64 服务组件状态
    示例值: 1
    PortsInfo 是 否 String 进程端口信息
    示例值: ""
    LastRestartTime 是 否 String 最近重启时间
    示例值: "2025-05-19 04:00:37"
    Flag 是 否 Int64 节点类型
    示例值: -99
    ConfGroupId 是 否 Int64 配置组ID
    示例值: 27029
    ConfGroupName 是 否 String 配置组名称
    示例值: "hdfs-master,core-defaultGroup"
    ConfStatus 是 否 Int64 节点是否需要重启
    示例值: -1
    ServiceDetectionInfo 是 是 Array of ServiceProcessFunctionInfo 进程探测信息
    示例值:查看
    NodeFlagFilter 是 是 String 节点类型
    示例值: "master&core"
    HealthStatus 是 是 HealthStatus 进程健康状态
    示例值:查看
    IsSupportRoleMonitor 是 是 Bool 角色是否支持监控
    示例值: true
    StopPolicies 是 是 Array of RestartPolicy 暂停策略
    示例值:查看
    HAState 是 是 String 测试环境api强校验,现网没有,emrcc接口返回有。不加会报错
    示例值: ""
    Ipv6 是 是 String 进程所在节点的ipv6
    示例值: ""

    SchemaResponse

    数据管理-查询具体数据库的返回信息

    被如下接口引用:DescribeSchema

    名称 必选 允许NULL 类型 描述
    Location 是 否 String 数据存储目录,当前仅支持 HDFS 类型
    示例值:
    Desc 是 是 String 数据库描述信息
    示例值:

    TenantGroupResponse

    租户权限组VO

    被如下接口引用:DescribeTenantList

    名称 必选 允许NULL 类型 描述
    Id 是 是 Int64 权限组id
    示例值:
    Name 是 是 String 权限组名称
    示例值:
    TenantId 是 是 Int64 所属租户id
    示例值:
    Remark 是 是 String 权限组描述
    示例值:
    CreateTime 是 是 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:

    ResourceGroup

    luoshu资源组

    被如下接口引用:DescribeResourceGroups

    名称 必选 允许NULL 类型 描述
    Container 是 是 String Container名
    示例值:
    Name 是 是 String 资源组名
    示例值:
    Properties 是 是 String 实际为Map<string,string>
    示例值:

    PreferredSchedulingTerm

    Pod容忍调度节点选择项

    被如下接口引用:DescribeServiceComponentInfos、ModifyComponentResource

    名称 必选 允许NULL 类型 描述
    Weight 否 否 Int64 权重,范围1-100
    示例值:
    Preference 否 否 NodeSelectorTerm 节点选择表达式
    示例值:查看

    MetricItem

    指标k-v对象

    被如下接口引用:DescribeImpalaQueryOverview

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 指标名
    示例值:
    Value 是 否 String 指标值
    示例值:

    TmpCredential

    临时凭据

    被如下接口引用:DescribeFileTmpToken

    名称 必选 允许NULL 类型 描述
    SecretId 是 否 String Secret Id
    示例值:
    SecretKey 是 否 String Secret Key
    示例值:
    Token 是 否 String 临时Token凭证(保留字段,当前版本暂未支持)
    示例值:

    BeatInfo

    beat的信息

    被如下接口引用:EsDownload

    名称 必选 允许NULL 类型 描述
    Id 是 否 Int64 自增ID
    示例值:
    ArmfilePath 是 是 String arm架构物料下载地址
    示例值:
    BeatName 是 否 String beat物料名称
    示例值:
    Description 是 否 String 物料简介
    示例值:
    DocumentationPath 是 是 String 物料说明文件下载地址
    示例值:
    X86filePath 是 是 String x86架构物料下载地址
    示例值:
    Type 是 否 String beat的类型
    示例值:

    ServiceMetricAbstractOverviewItem

    服务概览页 摘要数据
    每条记录代表一条摘要数据

    被如下接口引用:DescribeInstanceServiceAbstract

    名称 必选 允许NULL 类型 描述
    Key 是 否 String 摘要项 字段名称
    示例值:
    Value 是 否 String 摘要项 字段取值
    示例值:

    DescribeTableResult

    表详情

    被如下接口引用:DescribeTable

    名称 必选 允许NULL 类型 描述
    TableSimpleInfo 是 否 TableSimpleInfo 表基础信息
    示例值:查看
    TableFormat 是 是 String 表格式
    示例值:
    PropertyList 是 是 Array of PropertyItem 属性列表
    示例值:查看
    CreateTableWay 是 是 String 创建方式,页面可视化创建为VISUAL,其它地方创建的为OTHER
    示例值:
    FieldSize 是 是 Int64 字段数
    示例值:
    OptimizationType 是 是 Int64 数据优化类型,0 关闭 1 默认 2 自定义
    示例值:
    OptimizeInfo 是 是 OptimizeInfo 表优化信息
    示例值:查看
    OpenOptimization 是 是 Int64 是否开启表优化: 0 未开启; 1开启
    示例值:

    Group

    监控组

    被如下接口引用:DescribeMetricMeta

    名称 必选 允许NULL 类型 描述
    Title 是 是 String 组名
    示例值: ZooKeeper
    MetricMetas 是 是 Array of MMeta 组内元数据
    示例值:查看
    MetricMetasNew 是 是 Array of MMeta 组内元数据
    示例值:查看

    HostPathVolumeSource

    主机路径

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    Path 否 否 String 主机路径
    示例值:
    Type 否 否 String 主机路径类型,当前默认DirectoryOrCreate
    示例值:

    MetricMetaNamespace

    监控命名空间分类

    被如下接口引用:DescribeEmrMetricMeta、DescribeEmrMetricMetaNew

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 名称
    示例值:
    Groups 是 否 Array of MetricMetaGroup 监控组列表
    示例值:查看

    ServiceAndNodeType

    配置组过滤条件(配置管理)

    被如下接口引用:DescribeConfigGroupList

    名称 必选 允许NULL 类型 描述
    ServiceName 是 否 String 组件名
    示例值:
    NodeType 是 否 String 节点类型
    示例值:

    TkeProductInfo

    用于容器集群购买页描述Tke集群信息和EMR版本产品信息

    被如下接口引用:DescribeCloudServiceMeta

    名称 必选 允许NULL 类型 描述
    TkeClusterId 否 是 String Tke集群Id
    示例值:
    ProductId 否 是 Int64 EMR容器集群产品版本信息
    示例值:
    Platform 否 是 String Tke集群类别,tke表示TKE标准集群;eks表示TKE Serverless集群
    示例值:
    Zone 否 是 String 可用区 暂不使用
    示例值:

    ServicePodSetting

    容器集群服务Pod规格推荐设置

    被如下接口引用:DescribeCloudServiceMeta

    名称 必选 允许NULL 类型 描述
    ServiceName 否 是 String 服务名称,如RSS、HIVE
    示例值:
    ComponentPodSettings 否 是 Array of ComponentPodSetting 角色Pod规格推荐设置
    示例值:查看
    SupportExternalService 否 是 Bool 服务是否支持设置外部服务
    示例值:
    SupportSelected 否 是 Bool 服务是否支持被选择
    示例值:
    SoftInfo 否 是 String 服务版本信息
    示例值:
    SuggestContext 否 是 String 服务不可选时的建议内容
    示例值:

    ConfigInfo

    配置信息

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    FileName 是 是 String 文件名称
    示例值:
    FileContent 是 是 String 文件内容
    示例值:

    RegionServerTableRow

    HBase RegionServer列表的字段

    被如下接口引用:DescribeHBaseRegionServerList

    名称 必选 允许NULL 类型 描述
    RegionServer 是 否 String RegionServer,格式ip
    示例值:
    GetTimeTp99 是 否 Float Get请求tp99时延
    示例值:
    ScanTimeTp99 是 否 Float Scan请求tp99时延
    示例值:
    PutTimeTp99 是 否 Float Put请求tp99时延
    示例值:
    IncrementTimeTp99 是 否 Float Increment请求tp99时延
    示例值:
    AppendTimeTp99 是 否 Float Append请求tp99时延
    示例值:
    DeleteTimeTp99 是 否 Float Delete请求tp99时延
    示例值:

    TableSchemaItem

    表格schema信息

    被如下接口引用:DescribeHBaseRegionList、DescribeHBaseRegionServerList、DescribeHBaseTableOverview、DescribeInstanceServiceRoleTable

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 列标识
    示例值:
    Sortable 是 否 Bool 是否可按该列排序
    示例值:
    WithFilter 是 否 Bool 是否可筛选
    示例值:
    Candidates 是 是 Array of String 筛选的候选集
    示例值:
    Clickable 是 是 Bool 是否可点击
    示例值:
    Title 是 是 String 展示的名字
    示例值:

    ComponentPodDefaultSetting

    容器集群组件Pod规格推荐设置

    被如下接口引用:DescribeCloudServiceMeta、DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    MinCpu 否 是 Int64 Pod允许请求的最小Cpu核数
    示例值:
    MinMem 否 是 Int64 Pod允许请求的最小内存,单位GB
    示例值:
    MaxCpu 否 是 Int64 Pod允许请求的最大Cpu核数
    示例值:
    MaxMem 否 是 Int64 Pod允许请求的最大内存,单位GB
    示例值:
    MinPodNum 否 是 Int64 Pod允许请求的最小数量
    示例值:
    MaxPodNum 否 是 Int64 Pod允许请求的最小数量
    示例值:
    PodNumRule 否 是 String Pod数量规则限制,ALL->可奇可偶,ODD->奇数, EVEN->偶数
    示例值:
    SupportDataDiskTypes 否 是 String 支持的数据盘类型,用逗号隔开
    示例值:
    MinDataDiskSize 否 是 Int64 支持的数据盘最小容量。
    示例值:
    MaxPodNumDefault 否 是 Int64 Pod定义的最大Pod数量
    示例值:
    VolumeType 否 是 Array of String 支持的数据存储方式。主机路径->HOST_PATH和新建PVC->NEW_PVC;若为空表示都支持
    示例值:

    RegionTableRow

    HBase Region列表的字段

    被如下接口引用:DescribeHBaseRegionList

    名称 必选 允许NULL 类型 描述
    RegionName 是 否 String region名字
    示例值:
    RegionServer 是 否 String RegionServer,格式ip:port
    示例值:
    StartKey 是 否 String StartKey
    示例值:
    EndKey 是 否 String EndKey
    示例值:
    ReadRequest 是 否 Float 读请求量
    示例值:
    WriteRequest 是 否 Float 写请求量
    示例值:

    ServiceNode

    服务节点

    被如下接口引用:DescribeServiceGroups

    名称 必选 允许NULL 类型 描述
    NodeType 是 是 Int64 节点类型
    示例值:
    NodeName 是 是 String 节点名称
    示例值:
    CoreDeploy 是 是 Int64 Core节点部署
    示例值:
    CoreNecessary 是 是 Int64 Core节点必须
    示例值:
    TaskDeploy 是 是 Int64 Task节点部署
    示例值:
    TaskNecessary 是 是 Int64 Task节点必须
    示例值:
    RestartPolicies 是 是 Array of RestartPolicy 组件重启策略
    示例值:查看

    HeatMapItem

    热力图返回值

    被如下接口引用:DescribeHeatMapDistribution

    名称 必选 允许NULL 类型 描述
    Ip 是 否 String ip
    示例值:
    Value 是 否 String 字符串类型值
    示例值:
    Color 是 否 Int64 表示颜色范围,取值0-4,0表示颜色最浅
    示例值:
    Selected 是 否 Int64 1-选中;0-未选中
    示例值:

    NodeAffinity

    节点亲和性设置

    被如下接口引用:DescribeServiceComponentInfos、ModifyComponentResource

    名称 必选 允许NULL 类型 描述
    RequiredDuringSchedulingIgnoredDuringExecution 否 否 NodeSelector 节点亲和性-强制调度设置
    示例值:查看
    PreferredDuringSchedulingIgnoredDuringExecution 否 否 Array of PreferredSchedulingTerm 节点亲和性-容忍调度
    示例值:查看

    ClustersUpgradeList

    集群升级记录列表

    被如下接口引用:ClustersUpgradeList

    名称 必选 允许NULL 类型 描述
    Id 否 是 Int64 id
    示例值:
    ClusterId 否 是 String 集群id
    示例值:
    ClusterName 否 是 String 集群名称
    示例值:
    TbdsVersion 否 是 String 集群版本
    示例值:
    PatchedCount 否 是 Int64 补丁次数
    示例值:
    LastPatchedTime 否 是 String 补丁升级时间
    示例值:
    LastUpgradeClusterTime 否 是 String 集群升级时间
    示例值:

    ComponentInfo

    容器集群角色管理

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    ComponentName 是 是 String 角色名称
    示例值:
    ServiceType 是 是 Int64 角色编号
    示例值:
    Status 是 是 Int64 启动失败:-1
    未知:       0
    运行中:   1
    重启中:   2
    扩容中:   3
    缩容中:   4
    等待运行:5
    示例值:
    Num 是 是 String 当前数量/期望数量
    示例值:
    CpuInfo 是 是 String cpu请求范围
    示例值:
    MemInfo 是 是 String 内存请求范围
    示例值:
    DiskInfo 是 是 String 云硬盘请求信息
    示例值:
    ConfState 是 是 Int64 配置过期标识:1表示已同步,-1表示配置过期
    示例值:
    ComponentResource 是 是 CloudResource 角色请求资源
    示例值:查看
    LastRestartTime 否 是 String 最近重启时间
    示例值:
    VolumeDir 否 是 String 数据卷目录, NEW_PVC表示新建PVC;HOST_PATH表示主机路径
    示例值:
    HealthStatus 否 是 HealthStatus 健康状态:Code为1表示正常,为0表示异常
    示例值:查看
    NetworkAccess 否 是 EndpointAccessInfo 网络访问信息
    示例值:查看
    PodSetting 否 是 ComponentPodDefaultSetting Pod推荐规格范围
    示例值:查看

    FilePropertyDescription

    配置文件属性(配置管理)

    被如下接口引用:DescribeConfFileList、ListConfLogs

    名称 必选 允许NULL 类型 描述
    Editable 否 否 Bool 是否可编辑
    示例值:
    Display 是 否 Bool 是否可展示
    示例值:
    Type 是 否 String 文件类型,KeyValue/Customize
    示例值:
    FileOwner 是 否 String 文件owner
    示例值:

    OrderField

    排序字段

    被如下接口引用:DescribeCatalogList、DescribeESPlugins、DescribeFields、DescribeHostNodes、DescribeInstallClient、DescribeInstanceOplog、DescribeInstancesList、DescribePartitions、DescribeSchemas、DescribeTables、DescribeTceHostInfos、ExDescribeFtpInfo、ExDescribeInstanceOplog、ExportInstanceAuditLog

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 排序名
    示例值:
    Direction 是 否 String ASC正排,DESC反排
    示例值:

    LogServices

    存储日志服务的服务角色名

    被如下接口引用:DescribeLogMeta

    名称 必选 允许NULL 类型 描述
    ServiceName 是 否 String 服务名
    示例值:
    Roles 是 否 Array of String 角色列表
    示例值:

    ServiceGroup

    服务组

    被如下接口引用:DescribeServiceGroups

    名称 必选 允许NULL 类型 描述
    ClusterId 是 是 Int64 集群实例ID
    示例值: 14265
    ServiceType 是 是 Int64 服务类型
    示例值: 0
    Status 是 是 Int64 状态
    示例值: 0
    SoftName 是 是 String 软件名
    示例值: "ZOOKEEPER"
    SoftVersion 是 是 String 软件版本
    示例值: "3.7.2"
    VAddress 是 是 String V地址
    示例值: “”
    UserName 是 是 String 用户名
    示例值: "tbds"
    UserGroup 是 是 String 用户组
    示例值: "tbds"
    PathsInfo 是 是 String 路径信息
    示例值: "/usr/local/service/zookeeper"
    AddTime 是 是 String 添加时间
    示例值: "2025-05-23 18:12:42"
    AccessInfo 是 是 String 接入信息
    示例值: "QuorumPeerMain IPC:10.4.2.98:2181;10.4.2.127:2181;10.4.2.91:2181\n"
    ServiceNodeList 是 是 Array of ServiceNode 服务节点列表
    示例值:查看
    ExitInvalidParam 是 是 Bool 退出无效参数
    示例值: false
    IsSupportReStart 是 是 Bool 是否支持重启
    示例值: true
    IsSupportSubmitConf 是 是 Bool 是否支持配置下发
    示例值: true
    WebUiUrl 是 是 String WebUI地址
    示例值: ""
    IsSupportMonitor 是 是 Bool 是否支持监控
    示例值: true
    IsSupportDataMove 是 是 Bool 是否支持数据迁移
    示例值: false
    ServiceDetectStatus 是 是 Int64 服务状态
    示例值: 0
    WebUiDetectStatus 是 是 Int64 webui状态
    示例值: 0
    IsSupportFederation 是 是 Bool 是否支持联邦管理
    示例值: false
    CmdServiceOpsInfo 是 是 Array of ServiceOpsInfo 指令操作
    示例值:查看
    IsExternal 是 是 Bool 是否为共用组件
    示例值: false
    IsSupportServiceUpdate 是 是 Bool 是否支持服务版本升级
    示例值: false
    DisPlayHiveProfileEnabled 是 是 Bool 是否支持查询页面
    示例值: true
    IsSupportApplicationAnalysis 是 是 Bool emrcc有返回,测试环境强校验
    示例值: false
    IsSupportSQLAnalysis 是 是 Bool emrcc有返回,测试环境强校验
    示例值: false
    IsSupportClientManager 是 是 Bool 是否为客户端管理
    示例值: true
    DisPlay 是 是 Bool 是否展示
    示例值: true
    ConfStatus 是 是 Int64 配置状态
    示例值: 1
    IsSupportUninstall 是 是 Bool 是否支持卸载
    示例值: false
    IsSupportLog 是 是 Bool TCE集成,公共集群的组件是否支持日志搜索
    示例值: false
    IsSupportGCAnalyze 是 是 Bool TCE集成,公共集群的组件是否支持GC分析
    示例值: false
    AccessIpv6Info 是 是 String ipv6接入信息
    示例值: "QuorumPeerMain IPC:\n"
    IsSupportRack 是 是 Bool 是否支持机架策略
    示例值: false
    ComponentUiUrlList 是 是 Array of ComponentUiUrl 角色ui列表
    示例值:查看

    HostInfo

    HostInfo

    被如下接口引用:DescribeSrJdbcInfo

    名称 必选 允许NULL 类型 描述
    Ip 是 否 String 主机IP
    示例值:
    UserName 是 否 String 主机登陆用户名
    示例值:
    Password 是 否 String 主机登陆密码
    示例值:
    Port 是 否 Int64 端口
    示例值:
    Arch 否 否 String 机器架构
    示例值:
    Ipv6 否 否 String 主机IPv6
    示例值:
    HostName 否 否 String 主机名
    示例值:
    EsNodeRoles 否 否 Array of String ES标签
    示例值:
    MachineType 否 否 String 机型
    示例值:
    Rack 否 否 String 机架
    示例值:
    Disk 否 否 String 磁盘信息
    示例值:
    CpuNum 否 否 Uint64 cpu信息
    示例值:
    Mem 否 否 Uint64 mem信息
    示例值:
    OrderNo 否 否 String 资源ID
    示例值:
    SerialNo 否 否 String 主机uuid
    示例值:

    FlowStatus

    任务运行进度详情

    被如下接口引用:DescribeFlowStatus

    名称 必选 允许NULL 类型 描述
    StageDetails 是 是 Array of StageInfoDetail 任务步骤详情
    示例值:查看
    Processname 是 否 String 任务名
    示例值:
    Status 是 否 Int64 任务状态:0未开始 1运行中 2运行结束 -1运行失败
    示例值:
    Progress 是 是 Float 进度百分比
    示例值:
    Addtime 是 否 String 开始时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    FlowDesc 是 是 Array of FlowParamsDesc 任务参数
    示例值:查看
    Endtime 是 是 String 结束时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    FlowId 是 是 Int64 任务Id
    示例值:
    CanBeCancelled 是 否 Bool 任务是否能取消
    示例值:
    InstanceId 是 是 String 集群id
    示例值:
    ClusterName 是 是 String 集群名称
    示例值:
    ClusterType 否 是 String 集群类型: EMR on CVM和EMR on TKE
    示例值:

    UserAndGroup

    容器集群用户组信息

    被如下接口引用:ModifyUserKeytabExpireManager

    名称 必选 允许NULL 类型 描述
    UserName 是 是 String 用户名
    示例值:
    UserGroup 是 是 String 用户组
    示例值:

    ServiceFile

    服务和文件

    被如下接口引用:DescribeDefaultFileConfig

    名称 必选 允许NULL 类型 描述
    ServiceName 否 是 String 服务名
    示例值:
    Classifications 否 是 Array of String 文件集合
    示例值:

    InstanceNodeItem

    描述节点信息

    被如下接口引用:DescribeInstanceNodes

    名称 必选 允许NULL 类型 描述
    Host 是 否 String ip
    示例值:
    EmrNodeType 是 否 String 节点类型 mater\core等
    示例值:
    CpuUsedRatio 是 否 Float CPU使用率
    示例值:
    MemoryUsedRatio 是 否 Float 内存使用率
    示例值:
    DiskUsedRatio 是 否 Float 磁盘使用率
    示例值:
    AgentStatus 是 是 Int64 agent状态,-1:离线,1:在线 ,不筛选前端可不传默认是0
    示例值:
    LastHeartbeat 是 是 String 最近心跳
    示例值:
    HostName 是 是 String 主机名称
    示例值:

    ResourceGroupQuotaSummaryResponse

    资源组资源配额总览

    被如下接口引用:CreateResourceGroup、DescribeResourceGroup、DescribeResourceGroupPage、ModifyResourceGroup

    名称 必选 允许NULL 类型 描述
    CpuTotal 是 否 Int64 Cpu总额
    示例值:
    MemoryTotal 是 否 Float 内存总额
    示例值:
    DiskTotal 是 否 Int64 存储总额
    示例值:
    CpuRemain 是 是 Int64 Cpu剩余
    示例值:
    MemoryRemain 是 是 Float 内存剩余
    示例值:
    DiskRemain 是 是 Int64 存储剩余
    示例值:

    ServiceResourceConfig

    资源隔离配置的基本信息

    被如下接口引用:DescribeServiceResourceConfig

    名称 必选 允许NULL 类型 描述
    Id 否 是 Int64 配置组ID
    示例值:
    InstanceId 否 是 String 集群ID
    示例值:
    ConfigName 否 是 String 配置组名称
    示例值:
    Description 否 是 String 配置组描述信息
    示例值:
    ScheduleType 否 是 Int64 调度重复策略,0表示非重复策略,1表示每天,2表示每周,3表示每月
    示例值:
    ScheduleDays 否 是 String 各重复策略对应日期
    示例值:
    WeightConfigs 否 是 Array of WeightConfig 服务的资源权重配置
    示例值:查看
    ScheduleStarttime 否 是 String 调度开始时间
    示例值:
    ScheduleEndtime 否 是 String 调度结束时间
    示例值:

    PatchesList

    补丁信息

    被如下接口引用:ListPatch

    名称 必选 允许NULL 类型 描述
    PatchId 否 是 Int64 补丁id
    示例值:
    PatchName 否 是 String 补丁名称
    示例值:
    Status 否 是 Int64 补丁状态
    示例值:
    TbdsVersion 否 是 String 支持集群版本
    示例值:
    IncludedSoft 否 是 Array of String 包含的组件列表
    示例值:
    PatchVersion 否 是 String 补丁版本
    示例值:
    InstalledCount 否 是 Int64 安装次数
    示例值:
    PatchSize 否 是 Float 补丁大小
    示例值:
    AddTime 否 是 String 创建时间
    示例值:
    Message 否 是 String 消息信息
    示例值:
    ProductVersionName 否 是 String 产品市场产品版本
    示例值:
    SolutionVersionName 否 是 String 解决方案版本
    示例值:

    CatalogResponse

    catalog详情返回信息

    被如下接口引用:DescribeCatalog

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群id
    示例值:
    OptimizationType 是 否 Int64 0: 未开启数据优化; 1: 开启了默认优化; 2: 开启了自定义优化
    示例值:
    CatalogName 是 否 String catalog名
    示例值:
    Desc 是 是 String catalog描述信息
    示例值:
    OptimizeInfo 是 是 OptimizeInfo 优化信息
    示例值:查看
    Location 是 否 String hdfs的location地址
    示例值:

    NodeFilter

    节点过滤器

    被如下接口引用:DescribeNodeList

    名称 必选 允许NULL 类型 描述
    ComponentList 否 否 Array of String 进程列表
    示例值:
    ServiceList 否 否 Array of String 服务列表
    示例值:
    HostRoleList 否 否 Array of String 角色列表
    示例值:
    Ipv4List 否 否 Array of String ip列表
    示例值:
    UuidList 否 否 Array of String uuid列表
    示例值:
    PageNo 否 否 Int64 page number
    示例值:
    PageSize 否 否 Int64 page size
    示例值:

    UserPageResponse

    用户分页列表返回VO

    被如下接口引用:DescribePolicyUserPage、DescribeRoleUserPage、DescribeUserPage

    名称 必选 允许NULL 类型 描述
    List 是 否 Array of UserResponse 用户列表
    示例值:查看
    TotalCount 是 否 Int64 总数
    示例值:

    ExportConf

    导出配置文件标识信息

    被如下接口引用:ExDescribeExportConfsList

    名称 必选 允许NULL 类型 描述
    ServiceType 是 是 Int64 组件类型
    示例值:
    ServiceName 是 是 String 组件名称
    示例值:
    Classification 是 是 String 文件名称
    示例值:

    EmrProductConfigOutter

    EMR产品配置

    被如下接口引用:DescribeInstances

    名称 必选 允许NULL 类型 描述
    SoftInfo 是 是 Array of String 软件信息
    示例值:
    MasterNodeSize 是 是 Int64 Master节点个数
    示例值:
    CoreNodeSize 是 是 Int64 Core节点个数
    示例值:
    TaskNodeSize 是 是 Int64 Task节点个数
    示例值:
    ComNodeSize 是 是 Int64 Common节点个数
    示例值:
    MasterResource 是 是 OutterResource Master节点资源
    示例值:查看
    CoreResource 是 是 OutterResource Core节点资源
    示例值:查看
    TaskResource 是 是 OutterResource Task节点资源
    示例值:查看
    ComResource 是 是 OutterResource Common节点资源
    示例值:查看
    OnCos 是 是 Bool 是否使用COS
    示例值:
    ChargeType 是 是 Int64 收费类型
    示例值:
    RouterNodeSize 是 是 Int64 Router节点个数
    示例值:
    SupportHA 是 是 Bool 是否支持HA
    示例值:
    SecurityOn 是 是 Bool 是否支持安全模式
    示例值:
    SecurityGroup 是 是 String 安全组名称
    示例值:
    CbsEncrypt 是 是 Int64 是否开启Cbs加密
    示例值:
    ApplicationRole 是 是 String 自定义应用角色。
    示例值:
    SecurityGroups 是 是 Array of String 安全组
    示例值:
    PublicKeyId 是 是 String SSH密钥Id
    示例值:
    Principal 是 是 String SecurityOn为true时返回默认Principal
    示例值:
    IpStack 是 是 String 集群网络协议ipv4、ipv6、 DoubleStack
    示例值:

    DynamicPodSpec

    POD浮动规格

    被如下接口引用:ScaleOutInstance

    名称 必选 允许NULL 类型 描述
    RequestCpu 否 否 Float 需求最小cpu核数
    示例值:
    LimitCpu 否 否 Float 需求最大cpu核数
    示例值:
    RequestMemory 否 否 Float 需求最小memory,单位MB
    示例值:
    LimitMemory 否 否 Float 需求最大memory,单位MB
    示例值:

    PodParameter

    POD自定义权限和自定义参数

    被如下接口引用:ScaleOutInstance

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String TKE或EKS集群ID
    示例值:
    Config 是 否 String 自定义权限
    如:
    {
      "apiVersion": "v1",
      "clusters": [
        {
          "cluster": {
            "certificate-authority-data": "xxxxxx==",
            "server": "https://xxxxx.com"
          },
          "name": "cls-xxxxx"
        }
      ],
      "contexts": [
        {
          "context": {
            "cluster": "cls-xxxxx",
            "user": "100014xxxxx"
          },
          "name": "cls-a44yhcxxxxxxxxxx"
        }
      ],
      "current-context": "cls-a4xxxx-context-default",
      "kind": "Config",
      "preferences": {},
      "users": [
        {
          "name": "100014xxxxx",
          "user": {
            "client-certificate-data": "xxxxxx",
            "client-key-data": "xxxxxx"
          }
        }
      ]
    }
    示例值:
    Parameter 是 否 String 自定义参数
    如:
    {
        "apiVersion": "apps/v1",
        "kind": "Deployment",
        "metadata": {
          "name": "test-deployment",
          "labels": {
            "app": "test"
          }
        },
        "spec": {
          "replicas": 3,
          "selector": {
            "matchLabels": {
              "app": "test-app"
            }
          },
          "template": {
            "metadata": {
              "annotations": {
                "your-organization.com/department-v1": "test-example-v1",
                "your-organization.com/department-v2": "test-example-v2"
              },
              "labels": {
                "app": "test-app",
                "environment": "production"
              }
            },
            "spec": {
              "nodeSelector": {
                "your-organization/node-test": "test-node"
              },
              "containers": [
                {
                  "name": "nginx",
                  "image": "nginx:1.14.2",
                  "ports": [
                    {
                      "containerPort": 80
                    }
                  ]
                }
              ],
              "affinity": {
                "nodeAffinity": {
                  "requiredDuringSchedulingIgnoredDuringExecution": {
                    "nodeSelectorTerms": [
                      {
                        "matchExpressions": [
                          {
                            "key": "disk-type",
                            "operator": "In",
                            "values": [
                              "ssd",
                              "sas"
                            ]
                          },
                          {
                            "key": "cpu-num",
                            "operator": "Gt",
                            "values": [
                              "6"
                            ]
                          }
                        ]
                      }
                    ]
                  }
                }
              }
            }
          }
        }
      }
    示例值:

    ModifyMachineType

    主机管理-修改机型信息

    被如下接口引用:ModifyHostNodes

    名称 必选 允许NULL 类型 描述
    MachineType 是 否 String 要修改的机型名称
    示例值:
    Id 否 否 Uint64 主机ID
    示例值:
    Ipv4 否 否 String 主机IPv4
    示例值:
    Ipv6 否 否 String 主机Ipv6
    示例值:

    ConfFile

    配置文件及属性(配置管理)

    被如下接口引用:DescribeConfFileList、ListConfLogs

    名称 必选 允许NULL 类型 描述
    FileName 否 否 String 文件名
    示例值:
    FileProperty 是 否 FilePropertyDescription 文件属性
    示例值:查看

    GcInfoRow

    GC信息

    被如下接口引用:DescribeGcList

    名称 必选 允许NULL 类型 描述
    GcTime 是 否 String GC时间
    示例值:
    Service 是 否 String 服务名
    示例值:
    Role 是 否 String 角色名
    示例值:
    Host 是 否 String IP
    示例值:
    GcType 是 否 String GC类型
    示例值:
    GcReason 是 否 String GC原因
    示例值:
    GcCostTime 是 否 String GC时长
    示例值:
    GcPauseTime 是 否 String GC暂停时间
    示例值:
    GcWorkerNum 是 否 Int64 GC线程数
    示例值:
    AppliedHeapSize 是 否 String 申请的堆内存
    示例值:
    ReleasedHeapSize 是 否 String 释放的堆内存
    示例值:
    HeapSizeBeforeGc 是 否 String GC前堆内存大小
    示例值:
    HeapSizeAfterGc 是 否 String GC后堆内存大小
    示例值:
    ReleasedEdenSize 是 否 String 释放的Eden区大小
    示例值:
    ReleasedSurvivorSize 是 否 String 释放的Survivor区大小
    示例值:

    InstanceTypeInfo

    CVM/BMS的实例机型信息

    被如下接口引用:DescribeTceInstanceConfigInfos

    名称 必选 允许NULL 类型 描述
    Type 是 否 String 实例机型
    示例值: 无
    TypeName 是 否 String 实例机型名
    示例值: 无
    Families 否 是 Array of InstanceFamily 实例类型列表
    示例值:查看

    TenantResponse

    租户VO

    被如下接口引用:DescribeTenantList

    名称 必选 允许NULL 类型 描述
    Id 是 是 Int64 租户id
    示例值:
    Name 是 是 String 租户名称
    示例值:
    Remark 是 是 String 租户描述
    示例值:
    Groups 是 是 Array of TenantGroupResponse 权限组集合
    示例值:查看
    CreateTime 是 是 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    Identification 是 是 String 租户标识
    示例值:

    ModifyHostnames

    要修改的主机信息

    被如下接口引用:ModifyHostNodes

    名称 必选 允许NULL 类型 描述
    Hostname 是 否 String 主机名
    示例值:
    Id 否 否 Uint64 主机id
    示例值:
    Ipv4 否 否 String 主机的ipv4
    示例值:
    Ipv6 否 否 String 主机的ipv6
    示例值:

    ResourceTagPageResponse

    资源绑定的标签分页列表返回VO

    被如下接口引用:DescribeBaseResourceTagPage

    名称 必选 允许NULL 类型 描述
    TotalCount 是 否 Uint64 总条数
    示例值:
    List 是 否 Array of ResourceTagResponse 资源绑定标签列表
    示例值:查看

    Disk

    磁盘信息

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    DiskType 否 是 String 数据盘类型
    示例值:
    DiskCapacity 否 是 Int64 单块大小GB
    示例值:
    DiskNumber 否 是 Int64 数据盘数量
    示例值:

    FtpInfo

    ftp设置信息

    被如下接口引用:ExAddFtpInfo、ExDescribeFtpInfo

    名称 必选 允许NULL 类型 描述
    Url 否 是 String ip:port ftp地址
    示例值:
    UploadPath 否 是 String 上传路径
    示例值:
    User 否 是 String 用户
    示例值:
    Password 否 是 String 密码
    示例值:
    IsStorage 否 是 Bool 是否转储
    示例值:
    StorageType 否 是 String 转储类型
    示例值:
    LifeCycle 否 是 Int64 生命周期
    示例值:
    StorageTime 否 是 Int64 转储时间
    示例值:
    StorageLogNum 否 是 Int64 转储日志数量
    示例值:
    CreatTime 否 是 String 创建时间
    示例值:
    AuditType 否 是 Int64 操走日志类型
    示例值:
    FtpName 否 是 String 转储名称
    示例值:
    Id 否 是 Int64 转储设置自增ID
    示例值:

    HdfsResourceResponse

    hdfs资源返回

    被如下接口引用:DescribeHdfsResourceList

    名称 必选 允许NULL 类型 描述
    ResourceName 是 否 String 资源名称
    示例值:
    ResourcePath 是 否 String 资源路径
    示例值:
    ResourceGroupId 是 是 Int64 资源组id
    示例值:
    ResourceGroupName 是 是 String 资源组名称
    示例值:
    HasSubDirectory 是 否 Bool 是否还有子目录
    示例值:

    Item

    代表一个kv结构

    被如下接口引用:ModifyYarnQueue

    名称 必选 允许NULL 类型 描述
    Key 是 否 String 健值
    示例值:
    Value 是 否 String 值
    示例值:

    MultiDiskMC

    多云盘参数

    被如下接口引用:DescribeClusterNodes、DescribeConfigGroup

    名称 必选 允许NULL 类型 描述
    Type 否 是 Int64 磁盘类型
    示例值:
    Volume 否 是 Int64 云盘大小
    示例值:
    Count 是 是 Int64 该类型云盘个数
    示例值:
    Path 否 是 String 挂载路径,路径为/时表示系统盘,为/data时表示数据盘
    示例值:

    ResourceGroupRelationPageResponse

    资源组绑定关系出参

    被如下接口引用:DescribeResourceGroupRelationPage

    名称 必选 允许NULL 类型 描述
    List 是 否 Array of ResourceGroupRelationResponse 资源组绑定关系列表
    示例值:查看
    TotalCount 是 否 Int64 总数
    示例值:

    MetricMeta

    监控元数据

    被如下接口引用:DescribeEmrMetricMeta、DescribeEmrMetricMetaNew

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 监控指标名称
    示例值:
    Unit 是 否 String 监控指标单位
    示例值:
    Desc 是 否 String 指标展示名称
    示例值:
    Selected 是 否 Bool 是否选中
    示例值:
    Tags 是 是 Array of TagItem 指标tags信息
    示例值:查看

    NodeOverviewInfoItem

    节点按类型整体状态描述

    被如下接口引用:DescribeEMRNodeOverview

    名称 必选 允许NULL 类型 描述
    EmrNodeTypeName 是 否 String 节点类型(Master、Core)
    示例值:
    ProcessNames 是 否 Array of String 应该部署的进程
    示例值:
    NodeNum 是 是 Int64 该类型的节点数量
    示例值:
    MissedProcesses 是 是 Array of ProcessDesc 缺失进程
    示例值:查看
    IllegalProcesses 是 是 Array of ProcessDesc 非法进程
    示例值:查看

    PodVolume

    Pod的存储设备描述信息。

    被如下接口引用:ScaleOutInstance

    名称 必选 允许NULL 类型 描述
    VolumeType 是 是 String 存储类型,可为"pvc","hostpath"。
    示例值:
    PVCVolume 否 是 PersistentVolumeContext 当VolumeType为"pvc"时,该字段生效。
    示例值:查看
    HostVolume 否 是 HostVolumeContext 当VolumeType为"hostpath"时,该字段生效。
    示例值:查看

    SoftDependInfo

    体外客户端组件依赖信息

    被如下接口引用:DescribeInstancesList

    名称 必选 允许NULL 类型 描述
    SoftName 是 否 String 组件名称
    示例值:
    Required 是 否 Bool 是否必选
    示例值:

    StorageInfo

    云原生集群的存储类型

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    Type 是 是 String 存储类型,包括HDFS、COS等
    示例值:
    Path 是 是 String 存储路径
    示例值:
    InstanceId 是 是 String 存储集群
    示例值:

    BasicInfo

    集群基本信息

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    ClusterId 是 是 String 集群Id
    示例值:
    Region 是 是 String 地域
    示例值:
    ClusterType 是 是 String 集群类型
    示例值:
    SoftInfo 是 是 String 软件信息
    示例值:
    PLatFormType 是 是 String 平台类型
    示例值:
    ContainerNetwork 是 是 ContainerNetwork 容器网络
    示例值:查看
    CosBucket 是 是 String cos桶
    示例值:
    ResourceUsage 是 是 Usage 资源用量
    示例值:查看
    WebUi 是 是 String WebUi地址
    示例值:
    AddTime 是 是 String AddTime时间
    示例值:
    IsCosAuth 是 是 Bool cos授权
    示例值:
    RegionId 是 是 Int64 地区id
    示例值:
    ClusterName 是 是 String 集群名称
    示例值:
    Status 是 是 Int64 集群状态
    示例值:
    ApplicationRole 是 是 String 集群角色
    示例值:
    Namespace 是 是 String 名称空间
    示例值:
    LinkRssInfo 是 是 LinkRssInfo 关联的rss信息
    示例值:查看
    SgId 是 是 String 安全组Id
    示例值:
    MetaDb 否 是 String 数据库信息
    示例值:
    HiveMetaDb 否 是 String Hive元数据信息
    示例值:
    EmrVersion 否 是 String EMR产品版本
    示例值:
    ChargeType 否 是 Int64 计费类型,0按量计费,1包年包月
    示例值:
    Tags 否 是 Array of Tag 集群标签信息
    示例值:查看
    Zone 否 是 String 可用区编码
    示例值:
    ZoneId 否 是 Int64 可用区Id
    示例值:
    SoftInfos 否 是 Array of SoftInfos 已安装软件
    示例值:查看
    Id 否 是 Int64 集群数字Id
    示例值:
    AppId 否 是 Int64 集群AppId信息
    示例值:
    ProductId 否 是 Int64 集群产品版本编号
    示例值:
    TkeClusterId 否 是 String 所依赖的TKE集群id
    示例值:
    EnableUserManagement 否 是 Bool 是否支持用户管理
    示例值:
    SecurityOn 是 是 Bool Kerberos开关
    示例值:
    Principal 是 是 String SecurityOn为true时返回默认Principal
    示例值:
    StorageInfo 是 是 StorageInfo 云原生集群的关联存储类型
    示例值:查看

    MMeta

    监控元数据

    被如下接口引用:DescribeMetricMeta

    名称 必选 允许NULL 类型 描述
    Name 是 是 String 监控指标名称
    示例值:
    Unit 是 是 String 监控指标单位
    示例值:
    Desc 是 是 String 指标展示名称
    示例值:
    Tags 是 是 Array of TagItem 指标的标签
    示例值:查看

    EmrMetricMeta

    监控元数据,对应一个服务

    被如下接口引用:DescribeEmrMetricMeta、DescribeEmrMetricMetaNew

    名称 必选 允许NULL 类型 描述
    ServiceName 是 否 String 监控服务名称
    示例值:
    Namespace 是 否 Array of MetricMetaNamespace 命名空间列表
    示例值:查看

    ResourceTagResponse

    资源关联的标签列表返回的信息

    被如下接口引用:DescribeBaseResourceTagPage

    名称 必选 允许NULL 类型 描述
    ResourceId 是 是 String 资源id
    示例值:
    TagKey 是 是 String 标签键
    示例值:
    TagValue 是 是 String 标签值
    示例值:
    ServiceType 是 是 String 服务类型
    示例值:

    ContainerNetwork

    容器网络

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    VPCId 是 是 String vpc信息
    示例值:
    SubnetId 是 是 String 子网信息
    示例值:
    OptionSubnets 否 是 VpcIdAttribution 可选子网信息
    示例值:查看

    HDFSSpace

    HDFS集群存储空间信息

    被如下接口引用:DescribeHDFSSpaces

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群id
    示例值:
    TotalSpace 是 否 Int64 总空间(单位:字节)
    示例值:
    UsedSpace 是 否 Int64 已使用空间(单位:字节)
    示例值:
    RemainingSpace 是 否 Int64 可用空间(单位:字节)
    示例值:
    Result 是 否 Bool 查询结果是否成功: true 为成功; false为失败, 失败则其他空间信息全部返回-1
    示例值:
    Msg 是 是 String 查询失败时返回的错误信息
    示例值:
    TotalFileCount 是 是 Int64 总文件数容量
    示例值:
    UsedFileCount 是 是 Int64 已使用文件数
    示例值:
    RemainingFileCount 是 是 Int64 可用文件数
    示例值:
    CatalogName 是 是 String Catalog名称
    示例值:

    ItemSeq

    键值对组成的列表

    被如下接口引用:ModifyYarnQueue

    名称 必选 允许NULL 类型 描述
    Items 是 是 Array of Item 标签名称
    示例值:查看

    NodeSelector

    Pod强制调度节点选择条件

    被如下接口引用:DescribeServiceComponentInfos、ModifyComponentResource

    名称 必选 允许NULL 类型 描述
    NodeSelectorTerms 否 否 Array of NodeSelectorTerm Pod强制调度节点选择条件
    示例值:查看

    ComponentBasicRestartInfo

    操作的进程范围

    被如下接口引用:RestartService、StartStopServiceOrMonitor

    名称 必选 允许NULL 类型 描述
    ComponentName 否 是 String 进程名,必填,如NameNode
    示例值:
    IpList 否 是 Array of String 操作的IP列表
    示例值:
    UuidList 否 是 Array of String 操作的UUID列表
    示例值:

    EndpointAccessInfo

    网络访问信息

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    EnableNetworkAccess 否 是 Int64 当前外部网络访问限制。-1表示不支持开启外部网络访问;1表示网络访问处于开启状态;0表示网络访问处于关闭状态
    示例值:
    InternalService 否 是 Array of String 集群内部访问信息
    示例值:
    ExternalService 否 是 Array of String 集群外部访问信息
    示例值:
    InternalExtendedInfo 是 是 Array of String 集群内部访问扩展信息
    示例值:
    ExternalExtendedInfo 是 是 Array of String 集群外部访问扩展信息
    示例值:

    ResourceGroupQuotaResponse

    资源组资源返回VO

    被如下接口引用:CreateResourceGroup、DescribeResourceGroup、DescribeResourceGroupPage、ModifyResourceGroup

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群id
    示例值:
    ResourceName 是 否 String 资源名称
    示例值:
    ResourceType 是 否 String 资源类型,枚举值: yarn,hdfs,vc,namespace
    示例值:
    ResourcePath 是 否 String 资源路径
    示例值:
    ResourceQuota 是 是 String 资源配额
    示例值:
    ResourceStatus 是 是 String 资源状态,枚举值:enabled 可用,disabled 不可用
    示例值:
    Id 是 否 String 资源绑定id
    示例值:
    AppId 是 是 String 租户AppId
    示例值:
    CreateTime 是 是 Datetime 资源绑定时间
    示例值:
    TargetType 是 是 String 绑定对象类型,枚举值:resourceGroup 资源组,user 用户,userGroup 用户组
    示例值:
    TargetId 是 是 Uint64 绑定对象id
    示例值:
    TargetName 是 是 String 绑定对象名称
    示例值:
    AuthType 是 是 String 授权权限
    示例值:
    NameService 是 是 String 集群NameService
    示例值:
    IsRecursive 是 是 Bool 该资源授权是否为递归授权
    示例值:

    NodeInfo

    节点信息

    被如下接口引用:DescribeNodeList

    名称 必选 允许NULL 类型 描述
    HostRole 是 是 String 机器角色
    示例值:
    Ipv4 是 是 String 机器IPv4
    示例值:
    ServiceList 是 是 Array of String 服务列表
    示例值:
    ComponentList 是 是 Array of String 进程列表
    示例值:
    Uuid 是 是 String 机器uuid
    示例值:

    OperationLog

    操作日志描述

    被如下接口引用:DescribeInstanceOplog、ExDescribeInstanceOplog、ExportInstanceAuditLog

    名称 必选 允许NULL 类型 描述
    InstanceId 是 是 Int64 EMR实例ID
    示例值:
    Operation 是 是 String 操作名称
    示例值:
    OperationType 是 是 Int64 操作类型
    示例值:
    UserType 是 是 Int64 用户类型
    示例值:
    Operator 是 是 String 操作者
    示例值:
    CreateTime 是 是 String 操作时间
    示例值:
    Operand 是 是 String 操作对象
    示例值:
    OperationDesc 是 是 String 操作详情
    示例值:
    SecurityLevel 是 是 String 安全级别
    示例值:
    OperatorUin 是 是 String 操作者Uin
    示例值:
    ClusterId 是 是 String 集群ID
    示例值:
    ClusterName 是 是 String 集群名称
    示例值:
    ClusterType 是 是 Int64 集群类型 0一体化集群,1公共集群,2虚拟集群   3 云原生集群
    示例值:

    CatalogSimpleInfo

    catalog信息

    被如下接口引用:DescribeCatalogList

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群id
    示例值:
    ClusterName 是 否 String 集群名
    示例值:
    CatalogName 是 否 String catalog 名
    示例值:
    Desc 是 否 String 描述信息
    示例值:
    CreateTime 是 否 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    CreateUser 是 否 String 创建用户
    示例值:
    CatalogType 是 否 String catalog 类型
    示例值:
    OptimizationType 是 是 Int64 0: 未开启数据优化; 1: 开启了默认优化; 2: 开启了自定义优化
    示例值:

    TopNMeta

    topn元数据信息

    被如下接口引用:DescribeTopNMeta

    名称 必选 允许NULL 类型 描述
    MetricsName 是 否 String 指标名
    示例值:
    MetricsId 是 否 Int64 指标id
    示例值:
    Desc 是 否 String 描述信息
    示例值:

    ExportOriginalConfFile

    原集群配置文件

    被如下接口引用:DescribeExportConfs

    名称 必选 允许NULL 类型 描述
    FileName 是 否 String 文件名字
    示例值: ""
    FileContent 是 否 String 文件内容
    示例值: ""

    TagResourceRelationResponse

    标签绑定的资源VO

    被如下接口引用:DescribeBaseTagResourcePage

    名称 必选 允许NULL 类型 描述
    TagKey 是 是 String 标签键
    示例值:
    TagValue 是 是 String 标签值
    示例值:
    ResourceId 是 是 String 资源id
    示例值:
    ServiceType 是 是 String 服务类型
    示例值:
    ResourceRegion 是 是 String 资源地域
    示例值:
    ResourcePrefix 是 是 String 资源前缀
    示例值:

    UserGroupPageResponse

    用户组分页列表VO

    被如下接口引用:DescribePolicyUserGroupPage、DescribeRoleUserGroupPage、DescribeUserGroupPage

    名称 必选 允许NULL 类型 描述
    List 是 否 Array of UserGroupResponse 用户组列表
    示例值:查看
    TotalCount 是 否 Int64 总数
    示例值:

    UserGroupRelationResponse

    用户组绑定关系VO

    被如下接口引用:DescribeUserGroupRelationPage

    名称 必选 允许NULL 类型 描述
    Id 是 否 Int64 用户组绑定关系id
    示例值:
    UserId 是 否 Int64 用户id
    示例值:
    UserName 是 否 String 用户名称
    示例值:
    UserGroupId 是 否 Int64 用户组id
    示例值:
    UserGroupName 是 否 String 用户组名称
    示例值:
    CreateTime 是 否 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    AppId 是 是 String 租户AppId
    示例值:

    ServiceComponentType

    组件角色编码别名

    被如下接口引用:ListConfLogs

    名称 必选 允许NULL 类型 描述
    ComponentScopeNumber 是 否 Int64 角色编码
    示例值:
    ComponentAlias 是 是 String 角色别名
    示例值:

    CloudResource

    容器集群Pod请求资源信息

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    ComponentName 是 否 String 组件角色名
    示例值:
    PodNumber 是 否 Int64 pod请求数量
    示例值:
    CpuType 否 否 String Cpu类型
    示例值:
    RequestCpu 否 否 Int64 Cpu请求数量最小值
    示例值:
    LimitCpu 是 否 Int64 Cpu请求数量最大值
    示例值:
    RequestMemory 否 否 Int64 内存请求数量最小值
    示例值:
    LimitMemory 是 否 Int64 内存请求数量最大值
    示例值:
    DiskType 否 否 String 云硬盘类型,高性能云盘/SSD云硬盘
    示例值:
    DiskCapacity 否 否 Int64 单个云磁盘容量
    示例值:
    DiskNumber 否 否 Int64 云硬盘请求数量
    示例值:
    Service 否 是 String 服务名称,如HIVE
    示例值:
    VolumeDir 否 是 VolumeSetting 数据卷目录设置
    示例值:查看
    ExternalAccess 否 是 ExternalAccess 组件外部访问设置
    示例值:查看
    Affinity 否 是 NodeAffinity 节点亲和性设置
    示例值:查看
    Disks 否 是 Array of Disk 所选数据盘信息
    示例值:查看

    LogSearchRespItem

    日志搜索返回内容

    被如下接口引用:DescribeLogContent、DescribeLogDetail

    名称 必选 允许NULL 类型 描述
    Host 是 否 String 节点ip
    示例值:
    Role 是 否 String 角色
    示例值:
    FileName 是 否 String 文件名
    示例值:
    TimeStamp 是 否 String 时间戳
    示例值:
    Content 是 否 String 日志内容
    示例值:
    UniqueId 是 否 String 唯一id
    示例值:
    Level 是 否 String 日志级别
    示例值:
    IsSupportMonitor 是 否 Bool 角色是否支持服务监控
    示例值:

    TagResourceRelationPageResponse

    标签绑定的资源分页列表VO

    被如下接口引用:DescribeBaseTagResourcePage

    名称 必选 允许NULL 类型 描述
    TotalCount 是 是 Uint64 总条数
    示例值:
    List 是 是 Array of TagResourceRelationResponse 标签关联资源信息列表
    示例值:查看

    ConsoleSupportOperation

    容器集群控制台支持操作

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    IsSupportDashBoard 否 是 Bool 是否支持DashBoard
    示例值:
    IsSupportReStart 否 是 Bool 是否支持角色管理
    示例值:
    IsSupportSubmitConf 否 是 Bool 是否支持配置下发
    示例值:
    IsSupportShowLog 否 是 Bool 是否支持日志查询
    示例值:
    IsSupportJavaAnalysis 否 是 Bool 是否支持Java分析
    示例值:
    IsSupportJobManagement 否 是 Bool 是否支持作业管理
    示例值:

    ErrorListResponse

    错误信息列表

    被如下接口引用:CreateUser

    名称 必选 允许NULL 类型 描述
    ErrorItem 是 否 String 错误对象名称
    示例值:
    ErrorCode 是 否 String 错误码
    示例值:
    ErrorMessage 是 否 String 错误信息,json序列化格式
    示例值:

    VpcIdAttribution

    vpc属性信息

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    VpcName 是 否 String 无
    示例值:
    VpcId 是 否 String 无
    示例值:
    CidrBlock 是 否 String 无
    示例值:
    IsDefault 是 否 Bool 无
    示例值:
    SubnetList 是 否 Array of SubnetInstance 无
    示例值:查看

    DiskInfoItem

    具体磁盘的信息

    被如下接口引用:DescribeDiskInfo

    名称 必选 允许NULL 类型 描述
    DeviceName 是 否 String 盘符
    示例值:
    MountPoint 是 否 String 挂载点
    示例值:
    UsedCapacity 是 否 Float 使用量
    示例值:
    TotalCapacity 是 否 Float 总量
    示例值:
    UsedRatio 是 否 Float 使用率
    示例值:
    DiskIoRateRead 是 否 Float 磁盘读速率
    示例值:
    DiskIoRateWrite 是 否 Float 磁盘写速率
    示例值:
    Ipv4 是 否 String Ipv4地址
    示例值:
    Ipv6 是 否 String Ipv6地址
    示例值:

    ServiceOpsInfo

    服务运维操作,包含复杂与指令的

    被如下接口引用:DescribeServiceGroups

    名称 必选 允许NULL 类型 描述
    OpsName 是 是 String 前端展示用,操作展示名称
    示例值:
    ActionName 是 是 String 该操作的id,提交表单是要带
    示例值:
    InterfaceName 是 是 String 扩展用,表示提交表单时提交给后端的接口
    示例值:

    ResourceGroupRelationResponse

    资源组绑定关系VO

    被如下接口引用:DescribeResourceGroupRelationPage

    名称 必选 允许NULL 类型 描述
    Id 是 否 Int64 资源组绑定关系id
    示例值:
    UserId 是 否 Int64 用户id
    示例值:
    UserName 是 否 String 用户名称
    示例值:
    ResourceGroupId 是 否 Int64 资源组id
    示例值:
    ResourceGroupName 是 否 String 资源组名称
    示例值:
    CreateTime 是 否 String 创建时间,年⽉⽇时分秒型字符串:eg: 2014-08-12 12:00:00
    示例值:
    AppId 是 是 String 租户AppId
    示例值:

    ServiceCheckResult

    服务校验结果

    被如下接口引用:ScaleInNodeCheck

    名称 必选 允许NULL 类型 描述
    ServiceName 是 否 String 服务名称
    示例值:
    Result 是 否 Bool 校验结果
    示例值:
    RuleDesc 是 否 String 校验规则描述
    示例值:
    RuleId 是 否 Int64 校验规则ID
    示例值:
    RuleName 是 是 String 规则名
    示例值:
    ResultMessage 是 是 String 验证结果信息
    示例值:

    RoleInfo

    角色信息

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    RoleName 是 是 String 角色名称
    示例值:
    Num 是 是 String 角色数量
    示例值:

    StrategyConfig

    重启/停止/启动服务/监控的配置

    被如下接口引用:StartStopServiceOrMonitor

    名称 必选 允许NULL 类型 描述
    RollingRestartSwitch 否 是 Int64 0:关闭滚动重启
    1:开启滚动启动
    示例值:
    BatchSize 否 是 Int64 滚动重启每批次的重启数量
    示例值:
    TimeWait 否 是 Int64 滚动重启每批停止等待时间 ,最大重启台数为 99999 台,最大间隔为 5 分钟 单位是秒
    示例值:
    StopPolicy 否 是 String 重启/停止服务策略,"safe"安全重启,"default"
    示例值:
    DealOnFail 否 是 Int64 操作失败处理策略,0:失败阻塞, 1:失败自动跳过
    示例值:

    FileCleanInfo

    文件清理信息

    被如下接口引用:DescribeCatalog、DescribeTable

    名称 必选 允许NULL 类型 描述
    SnapshotExpireTime 否 是 Int64 快照过期时间
    示例值:
    IsolateFileRunCycle 否 是 Int64 清理孤立文件执行周期
    示例值:

    TagResponse

    标签返回VO

    被如下接口引用:DescribeBaseTagPage

    名称 必选 允许NULL 类型 描述
    Id 是 是 String 标签id
    示例值:
    TagKey 是 是 String 标签键
    示例值:
    TagValue 是 是 String 标签值
    示例值:
    CanDelete 是 是 Uint64 是否可删除
    示例值:
    ResourceNum 是 是 Uint64 绑定资源数量
    示例值:

    VolumeSetting

    数据卷目录设置

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    VolumeType 否 是 String 数据卷类型,HOST_PATH表示支持本机路径和NEW_PVC表示新建PVC
    示例值:
    HostPath 否 是 HostPathVolumeSource 主机路径信息
    示例值:查看

    ComponentUiUrl

    角色ui列表

    被如下接口引用:DescribeServiceGroups

    名称 必选 允许NULL 类型 描述
    ComponentName 否 否 String 角色名
    示例值: "Hue"
    ComponentTag 否 否 String 角色tag
    示例值: "Hue-2"
    Ipv4 否 否 String Ipv4
    示例值: "10.0.0.44"
    WebUiUrl 否 否 String webui
    示例值: "http://10.0.0.44:13000/hue/home"
    Ipv6 否 是 String Ipv6
    示例值: ""

    ClusterPatchedList

    某一个集群的打补丁记录

    被如下接口引用:ClusterPatchedList

    名称 必选 允许NULL 类型 描述
    Id 否 是 Int64 id
    示例值:
    TargetVersion 否 是 String 目标版本
    示例值:
    SourceVersion 否 是 String 原版本
    示例值:
    State 否 是 Int64 状态
    示例值:
    CreateTime 否 是 String 创建时间
    示例值:
    Operator 否 是 String 操作人
    示例值:
    OperatorUin 否 是 String 操作人uin
    示例值:
    Type 否 是 Int64 类型
    示例值:

    ConfigurationItem

    配置项(配置管理页)

    被如下接口引用:DescribeServiceConfsNew

    名称 必选 允许NULL 类型 描述
    Name 是 否 String 配置项名称
    示例值:
    Value 是 否 String 配置项值
    示例值:
    InFile 否 否 String 所在的配置文件名
    示例值:

    TagItem

    tag的含义和采集方式描述

    被如下接口引用:DescribeEmrMetricMeta、DescribeEmrMetricMetaNew、DescribeHeatMapMetricList、DescribeMetricMeta

    名称 必选 允许NULL 类型 描述
    TagName 是 否 String type名
    示例值:
    TagInfo 是 否 String 具体type的含义
    示例值:
    StatisticalMethod 是 否 String 采集方式
    示例值:

    HdfsClusterInfo

    hdfs集群信息

    被如下接口引用:DescribeInstancesList

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群Id
    示例值: "tbds-9d2w961k"
    Services 是 否 Array of String 服务列表
    示例值: ["hive-3.1.3"]

    ShortNodeInfo

    节点信息

    被如下接口引用:DescribeInstances

    名称 必选 允许NULL 类型 描述
    NodeType 否 是 String 节点类型,Master/Core/Task/Router/Common
    示例值:
    NodeSize 否 是 Int64 节点数量
    示例值:

    RangerInfo

    Ranger信息

    被如下接口引用:GetComponentProperties

    名称 必选 允许NULL 类型 描述
    Url 是 是 String url
    示例值:
    AdminPassword 是 是 String 密码
    示例值:
    JnsGatewayUrl 是 是 String TCE集成,ldap映射的jnsGatewayUrl
    示例值:
    Ipv6Url 是 是 String Ipv6Url
    示例值:

    ExternalAccess

    容器集群外部访问设置

    被如下接口引用:DescribeServiceComponentInfos

    名称 必选 允许NULL 类型 描述
    Type 否 否 String 外部访问类型,当前仅支持CLB字段
    示例值:
    CLBServer 否 否 CLBSetting CLB设置信息
    示例值:查看

    ConfFilterBase

    配置管理统一筛选器列表

    被如下接口引用:ListConfLogs

    名称 必选 允许NULL 类型 描述
    ConfCategoryFilterList 是 是 Array of ConfCategory 配置类别筛选列表
    示例值:查看
    ServiceComponentTypeFilterList 是 是 Array of ServiceComponentType 服务角色范围筛选列表
    示例值:查看
    ConfFileFilterList 是 是 Array of ConfFile 配置文件筛选列表
    示例值:查看

    SoftInfos

    容器集群集群服务基本信息

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    ServiceName 否 是 String 服务名称
    示例值:
    ConsoleSupportOperation 否 是 ConsoleSupportOperation 控制台服务支持的操作
    示例值:查看

    ClusterInfos

    容器集群信息

    被如下接口引用:DescribeCloudInstance

    名称 必选 允许NULL 类型 描述
    BasicInfo 是 是 BasicInfo 基础信息
    示例值:查看
    RoleInfo 是 是 Array of RoleInfo 组件信息
    示例值:查看
    ConfigInfo 是 是 Array of ConfigInfo 配置信息
    示例值:查看

    HDFSCluster

    HDFS集群信息

    被如下接口引用:DescribeHDFSClusters

    名称 必选 允许NULL 类型 描述
    ClusterId 是 否 String 集群id
    示例值:
    ClusterName 是 否 String 集群名
    示例值:
    CatalogName 是 是 String 文件管理Catalog名称
    示例值:
    NameserviceName 是 是 String Nameservice名称
    示例值:
    IsFederal 是 是 Bool 是否是多联邦的集群
    示例值:
    CreateTime 是 是 String 集群的创建时间
    示例值: