数据结构

最近更新时间:2026-04-30 01:51:58

我的收藏

AllNodeResourceSpec

资源描述

被如下接口引用:CreateCluster。

名称 类型 必选 描述
MasterResourceSpec NodeResourceSpec 描述Master节点资源
注意:此字段可能返回 null,表示取不到有效值。
CoreResourceSpec NodeResourceSpec 描述Core节点资源
注意:此字段可能返回 null,表示取不到有效值。
TaskResourceSpec NodeResourceSpec 描述Taskr节点资源
注意:此字段可能返回 null,表示取不到有效值。
CommonResourceSpec NodeResourceSpec 描述Common节点资源
注意:此字段可能返回 null,表示取不到有效值。
MasterCount Integer Master节点数量
示例值:1
CoreCount Integer Corer节点数量
示例值:1
TaskCount Integer Task节点数量
示例值:1
CommonCount Integer Common节点数量
示例值:1

ApplicationStatics

yarn application 统计信息

被如下接口引用:DescribeEmrApplicationStatics。

名称 类型 描述
Queue String 队列名
示例值:root.default
User String 用户名
示例值:hadoop
ApplicationType String 作业类型
示例值:MAPREDUCE
SumMemorySeconds Integer SumMemorySeconds含义
示例值:58250
SumVCoreSeconds Integer SumVCoreSeconds含义
示例值:33
SumHDFSBytesWritten String SumHDFSBytesWritten(带单位)
示例值:48 bytes
SumHDFSBytesRead String SumHDFSBytesRead(待单位)
示例值:269.1 MB
CountApps Integer 作业数
示例值:3

Arg

通用的参数

被如下接口引用:StartStopServiceOrMonitor。

名称 类型 必选 描述
Key String key
示例值:Threads
Values Array of String 值列表
注意:此字段可能返回 null,表示取不到有效值。
示例值:["0"]

AutoScaleGroupAdvanceAttrs

自动伸缩组高级设置

被如下接口引用:DescribeAutoScaleGroupGlobalConf。

名称 类型 必选 描述
ComputeResourceAdvanceParams ComputeResourceAdvanceParams 计算资源高级设置
注意:此字段可能返回 null,表示取不到有效值。

AutoScaleRecord

弹性扩缩容记录

被如下接口引用:DescribeAutoScaleRecords。

名称 类型 描述
StrategyName String 扩缩容规则名。
示例值:测试策略
ScaleAction String "SCALE_OUT"和"SCALE_IN",分别表示扩容和缩容。
示例值:SCALE_OUT
ActionStatus String 取值为"SUCCESS","FAILED","PART_SUCCESS","IN_PROCESS",分别表示成功、失败、部分成功和流程中。
示例值:IN_PROCESS
ActionTime String 流程触发时间。
示例值:2021-07-21 00:00:00
ScaleInfo String 扩缩容相关描述信息。
示例值:扩容成功5个
ExpectScaleNum Integer 只在ScaleAction为SCALE_OUT时有效。
示例值:1
EndTime String 流程结束时间。
示例值:2021-07-21 00:01:00
StrategyType Integer 策略类型,按负载或者按时间,1表示负载伸缩,2表示时间伸缩
示例值:1
SpecInfo String 扩容时所使用规格信息。
示例值:四核八G。
CompensateFlag Integer 补偿扩容,0表示不开启,1表示开启
示例值:0
CompensateCount Integer 补偿次数
示例值:0
RetryCount Integer 重试次数
示例值:0
RetryInfo String 重试信息
示例值:重试次数: 1, 重试结束时间: 2023-12-08 12:00:00, 重试原因: 资源不足
RetryEnReason String 重试英文描述
示例值:The scaling rule cannot be triggered because the elastic resource has reached the maximum node limit.
RetryReason String 重试描述
示例值:失败原因: 弹性资源已达到最大节点数限制,无法触发扩容,建议尝试调整最大节点数

AutoScaleResourceConf

弹性扩缩容规格配置

被如下接口引用:DescribeAutoScaleGroupGlobalConf。

名称 类型 必选 描述
Id Integer 配置ID。
示例值:1
ClusterId Integer 集群实例ID。
示例值:240143022
ScaleLowerBound Integer 自动扩缩容保留最小实例数。
示例值:0
ScaleUpperBound Integer 自动扩缩容最大实例数。
示例值:29
StrategyType Integer 扩容规则类型,1为按负载指标扩容规则,2为按时间扩容规则
示例值:1
NextTimeCanScale Integer 下次可扩容时间。
示例值:1726015182
GraceDownFlag Boolean 优雅缩容开关
示例值:true
HardwareType String "CVM"表示规格全部使用CVM相关类型,"POD"表示规格使用容器相关类型,默认为"CVM"。
示例值:HOST
PayMode String "POSTPAY"表示只使用按量计费,"SPOT_FIRST"表示竞价实例优先,只有HardwareType为"HOST"时支持竞价实例优先,"POD"只支持纯按量计费。
示例值:POSTPAY
PostPayPercentMin Integer 竞价实例优先的场景下,按量计费资源数量的最低百分比,整数
示例值:50
ChangeToPod Integer 预设资源类型为HOST时,支持勾选“资源不足时切换POD”;支持取消勾选;0表示默认不勾选(0),1表示勾选
示例值:0
GroupName String 伸缩组名
示例值:GroupName-test
YarnNodeLabel String 标签
示例值:node1
WarehouseName String 对应的计算组
示例值:test11
GroupStatus Integer 伸缩组状态
示例值:1
Parallel Integer 并行伸缩 0关闭;1开启
示例值:0
EnableMNode Integer 是否支持MNode
示例值:0
ExtraAdvanceAttrs AutoScaleGroupAdvanceAttrs 伸缩组更多设置
注意:此字段可能返回 null,表示取不到有效值。

BootstrapAction

引导脚本

被如下接口引用:RunJobFlow。

名称 类型 必选 描述
Path String 脚本位置,支持cos上的文件,且只支持https协议。
示例值:https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh
WhenRun String 执行时间。
resourceAfter 表示在机器资源申请成功后执行。
clusterBefore 表示在集群初始化前执行。
clusterAfter 表示在集群初始化后执行。
示例值:resourceAfter
Args Array of String 脚本参数
示例值:arg_test

CBSInstance

CBS实例信息

被如下接口引用:DescribeNodeDataDisks。

名称 类型 描述
DiskId String 云硬盘ID
示例值:disk-jcih4wxx
DiskUsage String 云硬盘类型
示例值:SYSTEM_DISK
DiskName String 云硬盘名称
示例值:emr-core1_系统盘
DiskSize Integer 云硬盘大小
示例值:50
DiskType String 云盘介质类型
示例值:CLOUD_PREMIUM
DeleteWithInstance Boolean 是否跟随实例删除
示例值:true
DiskChargeType String 云硬盘收费类型
示例值:PREPAID
DiskState String 云硬盘运行状态
示例值:ATTACHED
RenewFlag String 是否自动续费
示例值:DISABLE_NOTIFY_AND_MANUAL_RENEW
DeadlineTime String 到期时间
示例值:2021-07-24 11:37:30
Attached Boolean 云盘是否挂载到云主机上
示例值:true
DifferDaysOfDeadline Integer 当前时间距离盘到期的天数
示例值:10
InstanceIdList Array of String 该云盘当前被挂载到的CVM实例InstanceId
注意:此字段可能返回 null,表示取不到有效值。
示例值:["ins-1111111","ins-2222222"]
InstanceId String 云硬盘挂载的云主机ID
示例值:cbs-xxxxxxxx
Shareable Boolean 云盘是否为共享型云盘。
示例值:true
EmrResourceId String emr节点ID
示例值:emr-vm-rwxi34si
UnderwriteExpiredTime String 包销到期时间
示例值:2026-03-27 17:38:41
Tags Array of TagInfo 标签
ThroughputPerformance Integer 云硬盘额外性能值,单位:MB/s
示例值:10

CBSVolume

cbs 存储卷

被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

名称 类型 必选 描述
VolumeName String 存储卷名称
示例值:cbs-volume-1
DiskType String cbs 盘类型
示例值:高效云盘
DiskSize Integer cbs 大小(GB)
示例值:2
DiskCount Integer cbs 数量
示例值:3

CFSTurboVolume

cfs trubo 存储卷

被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

名称 类型 必选 描述
VolumeName String

存储卷名称


示例值:mock-cfs-turbo-volume
FileSystemId String

文件系统 id


示例值:cfs-turbo-mock-123
FSId String

CFSId


示例值:mock-fsid
Host String

挂载点 ip


示例值:10.0.0.1
SubPath String

cfs子目录


示例值:/
RootDir String

lustre挂载根目录,默认为/cfs


示例值:/cfs

CFSVolume

cfs 存储卷

被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

名称 类型 必选 描述
VolumeName String 存储卷名称
示例值:cfs-volume-1
FileSystemId String 文件系统 id
示例值:2feon2
FSId String CFSId
示例值:39h2lfi
Host String 挂载点 ip
示例值:129.0.1.2
SubPath String cfs子目录
示例值:/dev

CLBSetting

容器集群Pod服务CLB设置

被如下接口引用:CreateCloudInstance, InstallSoftware。

名称 类型 必选 描述
CLBType String CLB类型,PUBLIC_IP表示支持公网CLB和INTERNAL_IP表示支持内网CLB字段
示例值:PUBLIC_IP
VPCSettings VPCSettings Vpc和子网信息设置
注意:此字段可能返回 null,表示取不到有效值。

COSSettings

COS 相关配置

被如下接口引用:CreateInstance。

名称 类型 必选 描述
CosSecretId String COS SecretId
示例值:SecretId
CosSecretKey String COS SecrectKey
示例值:SecrectKey
LogOnCosPath String 日志存储在COS上的路径
示例值:cosn://ad-data-xxxxxx/data/logs/xxxxxxx

COSVolume

cos 存储卷

被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

名称 类型 必选 描述
VolumeName String 存储卷名称
示例值:cosVolume-1
Secret String 密钥名称
示例值:7324y98yf89hdifh
Region String cos桶所在地域
示例值:ap-guangzhou
Bucket String 存储桶名称
示例值:gzbucket-1
SubPath String cos 子目录
示例值:/dev

CapacityGlobalConfig

资源调度-容量调度器的全局设置

被如下接口引用:DescribeGlobalConfig。

名称 类型 描述
EnableLabel Boolean 是否开启了标签调度
示例值:true
LabelDir String 如果开启了标签调度,标签信息存放的路径
注意:此字段可能返回 null,表示取不到有效值。
示例值:hdfs:///yarn/node-labels/
QueueMappingOverride Boolean 是否覆盖用户指定队列,为true表示覆盖。
注意:此字段可能返回 null,表示取不到有效值。
示例值:false
DefaultSettings Array of DefaultSetting 高级设置
注意:此字段可能返回 null,表示取不到有效值。

CdbInfo

出参

被如下接口引用:DescribeClusterNodes。

名称 类型 描述
InstanceName String 数据库实例
示例值:cdb277780
Ip String 数据库IP
示例值:127.0.0.11
Port Integer 数据库端口
示例值:3306
MemSize Integer 数据库内存规格
示例值:4000
Volume Integer 数据库磁盘规格
示例值:100
Service String 服务标识
示例值:mysql
ExpireTime String 过期时间
示例值:2025-01-26 16:57:40
ApplyTime String 申请时间
示例值:2024-12-26 16:59:31
PayType Integer 付费类型
示例值:1
ExpireFlag Boolean 过期标识
示例值:false
Status Integer 数据库状态
示例值:3
IsAutoRenew Integer 续费标识
示例值:0
SerialNo String 数据库字符串
示例值:cdb-2h9w4413
ZoneId Integer ZoneId
示例值:800006
RegionId Integer RegionId
示例值:8

CloudResource

容器集群Pod请求资源信息

被如下接口引用:CreateCloudInstance, InstallSoftware。

名称 类型 必选 描述
ComponentName String

组件角色名


示例值:Coordinator
PodNumber Integer

pod请求数量


示例值:2
LimitCpu Integer

Cpu请求数量最大值


示例值:4
LimitMemory Integer

内存请求数量最大值


示例值:2048
Service String

服务名称,如HIVE


示例值:RSS
VolumeDir VolumeSetting

数据卷目录设置


注意:此字段可能返回 null,表示取不到有效值。
ExternalAccess ExternalAccess

组件外部访问设置


注意:此字段可能返回 null,表示取不到有效值。
Affinity NodeAffinity

节点亲和性设置


注意:此字段可能返回 null,表示取不到有效值。
Disks Array of Disk

所选数据盘信息


注意:此字段可能返回 null,表示取不到有效值。
Tolerations Array of Toleration

容忍


注意:此字段可能返回 null,表示取不到有效值。
PodAffinity PodAffinitySpec

pod亲和性

PodAntiAffinity PodAffinitySpec

pod反亲和性

TopologySpreadConstraints Array of TopologySpreadConstraint

拓扑分布约束

PodLabels Array of StringMap

pod标签

EnableDefaultRayCluster Boolean

是否创建默认raycluster


示例值:true

ClusterExternalServiceInfo

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

被如下接口引用:DescribeInstances。

名称 类型 描述
DependType Integer 依赖关系,0:被其他集群依赖,1:依赖其他集群
示例值:1
Service String 共用组件
示例值:zookeeper
ClusterId String 共用集群
示例值:emr-123
ClusterStatus Integer 共用集群状态
示例值:2

ClusterIDToFlowID

集群id与流程id的mapping

被如下接口引用:ModifyResourcesTags。

名称 类型 描述
ClusterId String 集群id
示例值:emr-2qhwmqln
FlowId Integer 流程id
示例值:79

ClusterInstancesInfo

集群实例信息

被如下接口引用:DescribeInstances。

名称 类型 描述
Id Integer ID号
示例值:13284
ClusterId String 集群ID
示例值:emr-38om728d
ClusterName String 集群名
示例值:tencent_emr
RegionId Integer 地域ID
示例值:1
ZoneId Integer 地区ID
示例值:10002
AppId Integer 用户APPID
示例值:251112431
Uin String 用户UIN
示例值:100000122121
ProjectId Integer 项目Id
示例值:0
VpcId Integer 集群VPCID
示例值:87821
SubnetId Integer 子网ID
示例值:2021891
Status Integer 实例的状态码。取值范围:
  • 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:表示扩容失败。

  • 示例值:2
    AddTime String 添加时间
    示例值:2021-10-18 19:46:32
    RunTime String 已经运行时间
    示例值:0天18小时32分钟28秒
    MasterIp String 主节点外网IP
    示例值:--
    EmrVersion String EMR版本
    示例值:EMR-V2.5.0
    ChargeType Integer 收费类型
    示例值:0
    TradeVersion Integer 交易版本
    示例值:1
    ResourceOrderId Integer 资源订单ID
    示例值:0
    IsTradeCluster Integer 是否计费集群
    示例值:0
    AlarmInfo String 集群错误状态告警信息
    示例值:--
    IsWoodpeckerCluster Integer 是否采用新架构
    示例值:1
    MetaDb String 元数据库信息
    示例值:cdb-lvz9h3us
    Tags Array of Tag 标签信息
    注意:此字段可能返回 null,表示取不到有效值。
    HiveMetaDb String Hive元数据信息
    示例值:cdb-8mq5jdt1
    ServiceClass String 集群类型:EMR,CLICKHOUSE,DRUID
    示例值:HADOOP
    AliasInfo String 集群所有节点的别名序列化
    示例值:"eyJjNrIn0="
    ProductId Integer 集群版本Id
    示例值:20
    Zone String 地区ID
    示例值:ap-guangzhou-2
    SceneName String 场景名称
    示例值:Hadoop-Default
    SceneServiceClass String 场景化集群类型
    示例值:Hadoop
    SceneEmrVersion String 场景化EMR版本
    示例值:ClickHouse-V1.0.0
    DisplayName String 场景化集群类型
    示例值:Hadoop
    VpcName String vpc name
    示例值:emr
    SubnetName String subnet name
    示例值:emr-name
    ClusterExternalServiceInfo Array of ClusterExternalServiceInfo 集群依赖关系
    注意:此字段可能返回 null,表示取不到有效值。
    UniqVpcId String 集群vpcid 字符串类型
    示例值:vpc-34o0gwhj
    UniqSubnetId String 子网id 字符串类型
    示例值:subnet-1laxlsao
    TopologyInfoList Array of TopologyInfo 节点信息
    注意:此字段可能返回 null,表示取不到有效值。
    IsMultiZoneCluster Boolean 是否是跨AZ集群
    示例值:false
    IsCvmReplace Boolean 是否开通异常节点自动补偿
    示例值:false
    ClusterTitle String 标题
    示例值:集群运行中
    ConfigDetail EmrProductConfigDetail 集群产品配置信息
    注意:此字段可能返回 null,表示取不到有效值。
    BindFileSystemNum Integer 集群绑定的文件系统数
    示例值:1
    ClusterRelationInfoList Array of ClusterRelationMeta rss集群的绑定列表
    注意:此字段可能返回 null,表示取不到有效值。
    RedisId String Redis信息
    示例值:crs-0kfb1a25

    ClusterRelationMeta

    集群间绑定使用信息

    被如下接口引用:DescribeInstances。

    名称 类型 必选 描述
    ClusterType String 集群类型
    示例值:EMR on CVM
    ClusterIdList Array of String 集群id列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["emr-riuzv9pw"]

    ClusterSetting

    集群配置。

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    InstanceChargeType String 付费方式。
    PREPAID 包年包月。
    POSTPAID_BY_HOUR 按量计费,默认方式。
    示例值:PREPAID
    SupportHA Boolean 是否为HA集群。
    示例值:true
    SecurityGroupIds Array of String 集群所使用的安全组,目前仅支持一个。
    示例值:sg-xxxxxxxx
    Placement Placement 实例位置。
    VPCSettings VPCSettings 实例所在VPC。
    LoginSettings LoginSettings 实例登录配置。
    TagSpecification Array of String 实例标签,示例:["{"TagKey":"test-tag1","TagValue":"001"}","{"TagKey":"test-tag2","TagValue":"002"}"]。
    示例值:["{"TagKey":"test-tag1","TagValue":"001"}","{"TagKey":
    MetaDB MetaDbInfo 元数据库配置。
    ResourceSpec JobFlowResourceSpec 实例硬件配置。
    PublicIpAssigned Boolean 是否申请公网IP,默认为false。
    示例值:false
    InstanceChargePrepaid InstanceChargePrepaid 包年包月配置,只对包年包月集群生效。
    DisasterRecoverGroupIds String 集群置放群组。
    示例值:ps-iy2i7msf
    CbsEncryptFlag Boolean 是否使用cbs加密。
    示例值:false
    RemoteTcpDefaultPort Boolean 是否使用远程登录,默认为false。
    示例值:false

    ComponentBasicRestartInfo

    操作的进程范围

    被如下接口引用:StartStopServiceOrMonitor。

    名称 类型 必选 描述
    ComponentName String 进程名,必填,如NameNode
    示例值:“NameNode”
    IpList Array of String 操作的IP列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["ip1", "ip2"]

    ComponentDeployInfo

    角色的部署信息

    被如下接口引用:InstallSoftware。

    名称 类型 必选 描述
    ComponentName String 角色名称
    示例值:HiveServer2
    DeployHostUuidList Array of String 待安装的节点uuid列表
    示例值:["0c88dde9-beb3-43ba-b83b-38a84afe193b"]

    ComputeResourceAdvanceParams

    计算资源高级设置

    被如下接口引用:DescribeAutoScaleGroupGlobalConf, ScaleOutInstance。

    名称 类型 必选 描述
    Labels Array of TkeLabel

    节点Label数组


    注意:此字段可能返回 null,表示取不到有效值。
    Taints Array of Taint

    节点污点


    注意:此字段可能返回 null,表示取不到有效值。
    PreStartUserScript String

    base64 编码的用户脚本,在初始化节点之前执行


    示例值:#!/bin/sh echo "hello world"
    UserScript String

    base64 编码的用户脚本, 此脚本会在 k8s 组件运行后执行, 需要用户保证脚本的可重入及重试逻辑, 脚本及其生成的日志文件可在节点的 /data/ccs_userscript/ 路径查看


    示例值:#!/bin/sh echo "hello world"
    TkeClusterNodePool String

    节点组Id


    示例值:np-ex9388xs

    ConfigModifyInfoV2

    资源调度 - 队列修改信息

    被如下接口引用:ModifyYarnQueueV2。

    名称 类型 必选 描述
    OpType Integer 操作类型,可选值:

    - 0:新建队列
    - 1:编辑-全量覆盖
    - 2:新建子队列
    - 3:删除
    - 4:克隆,与新建子队列的行为一样,特别的对于fair,可以复制子队列到新建队列
    - 6:编辑-增量更新
    示例值:0
    Name String 队列名称,不支持修改。
    示例值:b
    ParentId String 新建队列 传root的MyId;新建子队列 传 选中队列的 myId;克隆 要传 选中队列 parentId
    示例值:root.a
    MyId String 编辑、删除 传选中队列的 myId。克隆只有在调度器是fair时才需要传,用来复制子队列到新队列。
    示例值:root.a.b
    BasicParams ItemSeq 基础配置信息。key的取值与DescribeYarnQueue返回的字段一致。
    ###### 公平调度器
    key的取值信息如下:

    - type,父队列,取值为 parentnull
    - aclSubmitApps,提交访问控制,取值为AclForYarnQueue类型的json串null
    - aclAdministerApps,管理访问控制,取值为AclForYarnQueue类型的json串null
    - minSharePreemptionTimeout,最小共享优先权超时时间,取值为数字字符串null
    - fairSharePreemptionTimeout,公平份额抢占超时时间,取值为数字字符串null
    - fairSharePreemptionThreshold,公平份额抢占阈值,取值为数字字符串null,其中数字的范围是(0,1]
    - allowPreemptionFrom,抢占模式,取值为布尔字符串null
    - schedulingPolicy,调度策略,取值为drffairfifonull

    <br/>type AclForYarnQueue struct {<br/> User *string `json:"user"` //用户名<br/> Group *string `json:"group"`//组名<br/>}<br/>

    ###### 容量调度器
    key的取值信息如下:

    - state,队列状态,取值为STOPPEDRUNNING
    - default-node-label-expression,默认标签表达式,取值为标签null
    - acl_submit_applications,提交访问控制,取值为AclForYarnQueue类型的json串null
    - acl_administer_queue,管理访问控制,取值为AclForYarnQueue类型的json串null
    - maximum-allocation-mb,分配Container最大内存数量,取值为数字字符串null
    - maximum-allocation-vcores,Container最大vCore数量,取值为数字字符串null

    <br/>type AclForYarnQueue struct {<br/> User *string `json:"user"` //用户名<br/> Group *string `json:"group"`//组名<br/>}<br/>

    注意:此字段可能返回 null,表示取不到有效值。
    ConfigSetParams Array of ConfigSetInfo 配置集信息,取值见该复杂类型的参数说明。配置集是计划模式在队列中表现,表示的是不同时间段不同的配置值,所有队列的配置集名称都一样,对于单个队列,每个配置集中的标签与参数都一样,只是参数值不同。
    注意:此字段可能返回 null,表示取不到有效值。
    DeleteLables Array of String 容量调度专用,OpType6时才生效,表示要删除这个队列中的哪些标签。优先级高于ConfigSetParams中的LabelParams。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:label_test

    ConfigSetInfo

    资源调度-配置集信息

    被如下接口引用:ModifyYarnQueueV2。

    名称 类型 必选 描述
    ConfigSet String 配置集名称
    示例值:default
    LabelParams Array of ItemSeq 容量调度器会使用,里面设置了标签相关的配置。key的取值与DescribeYarnQueue返回的字段一致。
    key的取值信息如下:
    - labelName,标签名称,标签管理里的标签。
    - capacity,容量,取值为数字字符串
    - maximum-capacity,最大容量,取值为数字字符串
    注意:此字段可能返回 null,表示取不到有效值。
    BasicParams Array of Item 设置配置集相关的参数。key的取值与DescribeYarnQueue返回的字段一致。
    ###### 公平调度器
    key的取值信息如下:
    - minResources,最大资源量,取值为YarnResource类型的json串null
    - maxResources,最大资源量,取值为YarnResource类型的json串null
    - maxChildResources,能够分配给为未声明子队列的最大资源量,取值为数字字符串null
    - maxRunningApps,最高可同时处于运行的App数量,取值为数字字符串null
    - weight,权重,取值为数字字符串null
    - maxAMShare,App Master最大份额,取值为数字字符串null,其中数字的范围是[0,1]或-1

    <br/>type YarnResource struct {<br/> Vcores *int `json:"vcores"`<br/> Memory *int `json:"memory"`<br/> Type *string `json:"type"` // 取值为`percent`或`null`当值为`percent`时,表示使用的百分比,否则就是使用的绝对数值。只有maxResources、maxChildResources才可以取值为`percent`<br/>}<br/>


    ###### 容量调度器
    key的取值信息如下:
    - minimum-user-limit-percent,用户最小容量,取值为YarnResource类型的json串null,其中数字的范围是[0,100]
    - user-limit-factor,用户资源因子,取值为YarnResource类型的json串null
    - maximum-applications,最大应用数Max-Applications,取值为数字字符串null,其中数字为正整数
    - maximum-am-resource-percent,最大AM比例,取值为数字字符串null,其中数字的范围是[0,1]或-1
    - default-application-priority,资源池优先级,取值为数字字符串null,其中数字为正整数
    注意:此字段可能返回 null,表示取不到有效值。

    Configuration

    自定义配置参数

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    Classification String 配置文件名,支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。
    示例值:cluster.properties
    Properties String 配置参数通过KV的形式传入,部分文件支持自定义,可以通过特殊的键"content"传入所有内容。
    示例值:{ "spark.hadoop.fs.cosn.bucket.region":"ap-beijing-fsi"}

    ConfigurationItem

    配置项(配置管理页)

    被如下接口引用:DescribeServiceConfGroupInfos。

    名称 类型 必选 描述
    Name String 配置项名称
    示例值:item1
    Value String 配置项值
    示例值:val1
    InFile String 所在的配置文件名
    示例值:core-site.xml

    ContainerExtraConf

    容器额外配置

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    JobAccessProxyType String

    计算作业代理访问类型,如Spark作业和RayCluster UI;不填写默认使用Internal

    枚举值:

    • Internal: 使用内网LB代理访问
    • Public: 使用公网LB代理访问
    • None: 不创建LB代理访问

    示例值:Public

    CustomImage

    自定义镜像信息

    被如下接口引用:CreateDynamicInstance。

    名称 类型 必选 描述
    ImageSourceType String 镜像来源。支持企业版镜像(tcr)、个人版镜像(ccrPersonal)、个人版共有镜像(ccrAllPersonal)
    示例值:tcr
    ImageInfo ImageInfo 镜像信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ImageInfoTest
    ImagePullSecret ImagePullSecret 镜像获取密钥
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:ImagePullSecretTest

    CustomMetaDBInfo

    用户Hive-MetaDB信息

    被如下接口引用:CreateCloudInstance, CreateCluster。

    名称 类型 必选 描述
    MetaDataJdbcUrl String 自定义MetaDB的JDBC连接,示例: jdbc:mysql://10.10.10.10:3306/dbname
    示例值:jdbc:mysql://ip:port/hive
    MetaDataUser String 自定义MetaDB用户名
    示例值:userName
    MetaDataPass String 自定义MetaDB密码
    示例值:pwd
    MetaType String hive共享元数据库类型。取值范围:
  • EMR_DEFAULT_META:表示集群默认创建
  • EMR_EXIST_META:表示集群使用指定EMR-MetaDB。
  • USER_CUSTOM_META:表示集群使用自定义MetaDB。

  • 示例值:EMR_DEFAULT_META
    UnifyMetaInstanceId String EMR-MetaDB实例
    示例值:MetaDB-example

    CustomMetaInfo

    用户自建Hive-MetaDB信息

    被如下接口引用:CreateInstance, InquiryPriceCreateInstance, InstallSoftware, RunJobFlow。

    名称 类型 必选 描述
    MetaDataJdbcUrl String 自定义MetaDB的JDBC连接,请以 jdbc:mysql:// 开头
    示例值:jdbc:mysql://ip:port/hive
    MetaDataUser String 自定义MetaDB用户名
    示例值:userName
    MetaDataPass String 自定义MetaDB密码
    示例值:pwd

    CustomServiceDefine

    共用自建组件参数

    被如下接口引用:CreateCloudInstance, CreateInstance, InquiryPriceCreateInstance, InstallSoftware。

    名称 类型 必选 描述
    Name String 自定义参数key
    示例值:zookeeper.quorum
    Value String 自定义参数value
    示例值:1.1.1.1

    DAGInfo

    DAG信息

    被如下接口引用:DescribeDAGInfo。

    名称 类型 必选 描述
    ID String 查询ID
    示例值:queryid_123
    Type String DAG类型,目前只支持starrocks
    示例值:starrocks
    Content String 返回的DAG的JSON字符串
    示例值:{"json":123}

    DayRepeatStrategy

    弹性扩缩容按天重复任务描述

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    ExecuteAtTimeOfDay String 重复任务执行的具体时刻,例如"01:02:00"
    示例值:10:01:00
    Step Integer 每隔Step天执行一次
    示例值:1

    DefaultSetting

    资源调度的默认设置

    被如下接口引用:DescribeGlobalConfig。

    名称 类型 描述
    Name String 名称,作为入参的key
    示例值:node-locality-delay
    Desc String 描述
    示例值:保证任务本地化执行,可以延迟调度的次数,如果值为 -1,将禁用延迟调度。
    Prompt String 提示
    示例值:请输入-1和0、正整数
    Key String key,用于展示,该配置对应与配置文件中的配置项
    示例值:yarn.scheduler.capacity.node-locality-delay
    Value String Name对应的值
    示例值:value_test

    DependService

    共用组件信息

    被如下接口引用:CreateCluster, CreateDynamicInstance, ModifyDynamicInstance。

    名称 类型 必选 描述
    ServiceName String 共用组件名
    示例值:zookeeper
    InstanceId String 共用组件集群
    示例值:emr-123

    DescribeBootScriptRsp

    引导脚本回包

    被如下接口引用:DescribeBootScript。

    名称 类型 描述
    ResourceAfter Array of PreExecuteFileSetting 资源初始化结束自定义脚本文件
    注意:此字段可能返回 null,表示取不到有效值。
    ClusterBefore Array of PreExecuteFileSetting 集群启动前自定义脚本文件
    注意:此字段可能返回 null,表示取不到有效值。
    ClusterAfter Array of PreExecuteFileSetting 集群启动后自定义脚本文件
    注意:此字段可能返回 null,表示取不到有效值。
    ServiceBefore Array of PreExecuteFileSetting 服务下线前自定义脚本
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeNodeSpec

    节点规格

    被如下接口引用:DescribeNodeSpec。

    名称 类型 必选 描述
    NodeType String 节点类型
    示例值:Master
    NodeName String 节点类型名称
    示例值:Master节点
    Types Array of NodeSpecType Types数组
    注意:此字段可能返回 null,表示取不到有效值。
    CmnTypes Array of NodeSpecType 云托管节点机型规格列表
    注意:此字段可能返回 null,表示取不到有效值。

    DescribeResourceConfig

    DescribeResourceConfig接口出参

    被如下接口引用:DescribeNodeResourceConfigFast。

    名称 类型 描述
    ResourceType String 规格管理类型
    示例值:TASK
    ResourceData Array of NodeResource 规格管理数据

    DiffDetail

    动态生成的变更详情

    被如下接口引用:DescribeResourceScheduleDiffDetail。

    名称 类型 描述
    Name String tab页的头
    示例值:全局设置
    Count Integer 变化项的个数
    示例值:1
    Rows Array of DiffDetailItem 要渲染的明细数据
    注意:此字段可能返回 null,表示取不到有效值。
    Header Array of DiffHeader 要渲染的头部信息
    注意:此字段可能返回 null,表示取不到有效值。

    DiffDetailItem

    动态生成的变更详情条目

    被如下接口引用:DescribeResourceScheduleDiffDetail。

    名称 类型 描述
    Attribute String 属性
    示例值:属性
    InEffect String 当前生效
    示例值:当前生效
    PendingEffectiveness String 待生效
    示例值:待生效
    Operation String 操作
    示例值:操作
    Queue String 队列
    示例值:队列
    ConfigSet String 配置集
    示例值:配置集
    LabelName String 标签
    示例值:标签
    InEffectIndex String 当前所在位置
    示例值:当前所在位置
    PendingEffectIndex String 待生效的位置
    示例值:待生效的位置
    PlanName String 计划模式名称
    示例值:计划模式名称
    Label String 标签
    示例值:标签
    RuleName String 放置规则
    示例值:规则
    UserName String 用户名
    示例值:hadoop

    DiffHeader

    动态生成的变更详情

    被如下接口引用:DescribeResourceScheduleDiffDetail。

    名称 类型 描述
    Name String 名称
    示例值:Attribute
    Id String ID,前端会使用
    示例值:Attribute

    Disk

    磁盘信息

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    DiskType String 数据盘类型,创建EMR容器集群实例可选
  • SSD云盘: CLOUD_SSD
  • 高效云盘: CLOUD_PREMIUM

  • 示例值:CLOUD_SSD
    DiskCapacity Integer 单块大小GB
    示例值:70
    DiskNumber Integer 数据盘数量
    示例值:1

    DiskGroup

    磁盘组。

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    Spec DiskSpec 磁盘规格。
    Count Integer 同类型磁盘数量。
    示例值:1

    DiskSpec

    磁盘描述。

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    DiskType String 磁盘类型。
    LOCAL_BASIC 本地盘。
    CLOUD_BASIC 云硬盘。
    LOCAL_SSD 本地SSD。
    CLOUD_SSD 云SSD。
    CLOUD_PREMIUM 高效云盘。
    CLOUD_HSSD 增强型云SSD。
    示例值:CLOUD_SSD
    DiskSize Integer 磁盘大小,单位GB。
    示例值:200

    DiskSpecInfo

    节点磁盘信息

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    Count Integer 磁盘数量
    示例值:1
    DiskType String 系统盘类型 取值范围:
  • CLOUD_SSD:表示云SSD。
  • CLOUD_PREMIUM:表示高效云盘。
  • CLOUD_BASIC:表示云硬盘。
  • LOCAL_BASIC:表示本地盘。
  • LOCAL_SSD:表示本地SSD。


  • 数据盘类型 取值范围:
  • CLOUD_SSD:表示云SSD。
  • CLOUD_PREMIUM:表示高效云盘。
  • CLOUD_BASIC:表示云硬盘。
  • LOCAL_BASIC:表示本地盘。
  • LOCAL_SSD:表示本地SSD。
  • CLOUD_HSSD:表示增强型SSD云硬盘。
  • CLOUD_THROUGHPUT:表示吞吐型云硬盘。
  • CLOUD_TSSD:表示极速型SSD云硬盘。
  • CLOUD_BIGDATA:表示大数据型云硬盘。
  • CLOUD_HIGHIO:表示高IO型云硬盘。
  • CLOUD_BSSD:表示通用型SSD云硬盘。
  • REMOTE_SSD:表示远端SSD盘。


  • 示例值:CLOUD_SSD
    DiskSize Integer 数据容量,单位为GB
    示例值:70
    ExtraPerformance Integer 额外性能
    示例值:100

    Dps

    采样序列

    被如下接口引用:DescribeHDFSStorageInfo。

    名称 类型 必选 描述
    Timestamp String 时间戳
    示例值:1733799099153
    Value String 采样值
    示例值:2

    DynamicInstanceForm

    创建DynamicInstance提交的表单数据

    被如下接口引用:CreateDynamicInstance。

    名称 类型 必选 描述
    DynamicInstanceName String

    DynamicInstance名,长度限制1-64字符,只能包含小写字母


    示例值:rayClusterBigdata
    Namespace String

    命名空间


    示例值:251233709-emr-p2ww5xsr
    SupportHA Boolean

    是否支持高可用


    示例值:true
    CustomImage CustomImage

    自定义镜像信息

    DynamicInstanceGroups Array of DynamicInstanceGroup

    资源组配置

    SupportPV Boolean

    是否支持存储配置


    示例值:true
    CBSVolumes Array of CBSVolume

    cbs存储卷列表

    CFSVolumes Array of CFSVolume

    cfs存储卷列表,只包含cfs,不包含cfs turbo

    COSVolumes Array of COSVolume

    cos存储卷列表

    VolumeMounts Array of VolumeMount

    挂载卷列表

    Labels Array of TkeLabel

    pod标签

    Tolerations Array of Toleration

    Tolerations定义

    Envs Array of NameValue

    环境变量

    DependServices Array of DependService

    依赖外部组件

    SupportToken Boolean

    是否开启token鉴权


    示例值:true
    CFSTurboVolumes Array of CFSTurboVolume

    cfs trubo挂载列表,不包含标准版cfs

    DynamicInstanceGroup

    创建DynamicInstance提交的表单数据中的group部分

    被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

    名称 类型 必选 描述
    GroupType String

    资源组类型


    示例值:headGroup
    GroupName String

    资源组名称


    示例值:headGroup1
    PodCpu Integer

    pod cpu核数


    示例值:1
    PodMem Integer

    pod mem大小(GB)


    示例值:2
    PodGpuType String

    pod gpu类型


    示例值:T4
    PodGpu Integer

    pod gpu块数


    示例值:1
    PodNum Integer

    pod个数


    示例值:1
    MinPodNum Integer

    pod弹性最小个数


    示例值:1
    MaxPodNum Integer

    pod弹性最大个数,当MaxPodNum > MinPodNum时,默认表示开启弹性扩缩容,将在范围内扩缩容


    示例值:10
    SupportPV Boolean

    是否支持存储配置


    示例值:true
    CBSVolumes Array of CBSVolume

    cbs存储卷列表

    CFSVolumes Array of CFSVolume

    cfs存储卷列表

    COSVolumes Array of COSVolume

    cos存储卷列表

    VolumeMounts Array of VolumeMount

    挂载卷列表

    Labels Array of TkeLabel

    pod标签

    Tolerations Array of Toleration

    Tolerations定义

    Envs Array of NameValue

    环境变量

    SchedulingPolicy String

    节点调度策略


    示例值:{"nodeSelector":"1"}
    ResourceLabel String

    资源标签


    示例值:{"custom1": 1}
    PodGpuResourceKey String

    GPU资源厂商key


    示例值:nvidia.com/gpu
    CFSTurboVolumes Array of CFSTurboVolume

    CFS Turbo 挂载列表

    DynamicPodSpec

    POD浮动规格

    被如下接口引用:ScaleOutCluster, ScaleOutInstance。

    名称 类型 必选 描述
    RequestCpu Float 需求最小cpu核数
    示例值:0.1234
    LimitCpu Float 需求最大cpu核数
    示例值:1.2345
    RequestMemory Float 需求最小memory,单位MB
    示例值:1234.5678
    LimitMemory Float 需求最大memory,单位MB
    示例值:8765.4321

    EMREventListItem

    事件详情列表

    被如下接口引用:DescribeEMREventList。

    名称 类型 必选 描述
    Host String 事件受影响ip
    示例值:127.0.0.1
    Role String 事件受影响的服务角色
    示例值:CPU
    Name String 事件名称
    示例值:CPU利用率连续高于阈值
    Detail String 事件告警详情
    示例值:[NODE - CPU : 10.0.17.3] CPU utilization >= 0 % in 300 seconds
    CreateTime String 事件发生时间
    示例值:2026-01-03 00:33:43

    EmrListInstance

    集群列表返回示例

    被如下接口引用:DescribeInstancesList。

    名称 类型 描述
    ClusterId String 集群ID
    示例值:emr-xxxx
    StatusDesc String 常见状态描述:集群生产中,集群运行中,集群创建中,集群已关闭,集群已删除
    示例值:集群运行中
    ClusterName String 集群名字
    示例值:集群名字
    ZoneId Integer 集群地域
    示例值:1
    AppId Integer 用户APPID
    示例值:663622
    AddTime String 创建时间
    示例值:创建时间
    RunTime String 运行时间
    示例值:运行时间
    MasterIp String 集群IP
    示例值:集群ID
    EmrVersion String 集群版本
    示例值:集群版本
    ChargeType Integer 集群计费类型
    示例值:0
    Id Integer emr ID
    示例值:23321
    ProductId Integer 产品ID
    示例值:44333
    ProjectId Integer 项目ID
    示例值:4555
    RegionId Integer 区域
    示例值:4552
    SubnetId Integer 子网ID
    示例值:3422
    VpcId Integer 网络ID
    示例值:45666
    Zone String 地区
    示例值:zone
    Status Integer 状态码, 取值为-2(集群已删除), -1(集群已关闭), 0(集群生产中), 2(集群运行中), 3(集群创建中)
    示例值:2
    Tags Array of Tag 实例标签
    注意:此字段可能返回 null,表示取不到有效值。
    AlarmInfo String 告警信息
    示例值:告警信息
    IsWoodpeckerCluster Integer 是否是woodpecker集群
    示例值:1
    VpcName String Vpc中文
    示例值:emr
    SubnetName String 子网中文
    示例值:emr
    UniqVpcId String 字符串VpcId
    示例值:vpc-lzd3w8jz
    UniqSubnetId String 字符串子网
    示例值:subnet-3d73yezg
    ClusterClass String 集群类型
    示例值:spark
    IsMultiZoneCluster Boolean 是否为跨AZ集群
    示例值:true
    IsHandsCluster Boolean 是否手戳集群
    示例值:false
    OutSideSoftInfo Array of SoftDependInfo 体外客户端组件信息
    注意:此字段可能返回 null,表示取不到有效值。
    IsSupportOutsideCluster Boolean 当前集群的应用场景是否支持体外客户端
    示例值:true
    IsDedicatedCluster Boolean 是否专有集群场景集群
    示例值:false
    IsSupportClone Boolean 集群支持克隆
    示例值:true

    EmrPrice

    Emr询价描述

    被如下接口引用:InquiryPriceScaleOutInstance。

    名称 类型 描述
    OriginalCost String 刊例价格
    示例值:8.30
    DiscountCost String 折扣价格
    示例值:8.01
    Unit String 单位
    示例值:s
    PriceSpec PriceResource 询价配置
    注意:此字段可能返回 null,表示取不到有效值。
    SupportSpotPaid Boolean 是否支持竞价实例
    示例值:true

    EmrProductConfigDetail

    EMR产品配置

    被如下接口引用:DescribeInstances。

    名称 类型 描述
    SoftInfo Array of String 软件信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[""]
    MasterNodeSize Integer Master节点个数
    示例值:2
    CoreNodeSize Integer Core节点个数
    示例值:3
    TaskNodeSize Integer Task节点个数
    示例值:4
    ComNodeSize Integer Common节点个数
    示例值:5
    MasterResource ResourceDetail Master节点资源
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    CoreResource ResourceDetail Core节点资源
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    TaskResource ResourceDetail Task节点资源
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    ComResource ResourceDetail Common节点资源
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    OnCos Boolean 是否使用COS
    示例值:true
    ChargeType Integer 收费类型
    示例值:2
    RouterNodeSize Integer Router节点个数
    示例值:3
    SupportHA Boolean 是否支持HA
    示例值:true
    SecurityOn Boolean 是否支持安全模式
    示例值:true
    SecurityGroup String 安全组名称
    示例值:"111"
    CbsEncrypt Integer 是否开启Cbs加密
    示例值:2
    ApplicationRole String 自定义应用角色。
    示例值:"Role_test"
    SecurityGroups Array of String 安全组
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["sg-3xxx"]
    PublicKeyId String SSH密钥Id
    示例值:skey-xxxxxxxx

    Execution

    执行动作。

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    JobType String 任务类型,目前支持以下类型。
    1. “MR”,将通过hadoop jar的方式提交。
    2. "HIVE",将通过hive -f的方式提交。
    3. "SPARK",将通过spark-submit的方式提交。
    示例值:MR
    Args Array of String 任务参数,提供除提交指令以外的参数。
    示例值:arg_test

    ExternalAccess

    容器集群外部访问设置

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Type String 外部访问类型,当前仅支持CLB字段
    示例值:CLB
    CLBServer CLBSetting CLB设置信息
    注意:此字段可能返回 null,表示取不到有效值。

    ExternalService

    共用组件信息

    被如下接口引用:CreateCloudInstance, CreateInstance, InquiryPriceCreateInstance, InstallSoftware。

    名称 类型 必选 描述
    ShareType String 共用组件类型,EMR/CUSTOM
    示例值:EMR
    Service String 共用组件名
    示例值:zookeeper
    InstanceId String 共用组件集群
    示例值:emr-123
    CustomServiceDefineList Array of CustomServiceDefine 自定义参数集合

    FairGlobalConfig

    资源调度-公平调度器的全局配置

    被如下接口引用:DescribeGlobalConfig。

    名称 类型 描述
    UserMaxAppsDefault Integer 对应与页面的

    程序上限


    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1000

    Filter

    键值对过滤器,用于条件过滤查询.

    被如下接口引用:DescribeGroupsSTD。

    名称 类型 必选 描述
    Name String 需要过滤的字段。
    示例值:groupName
    Values Array of String 字段的过滤值。
    示例值:nametest

    Filters

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

    被如下接口引用:DescribeInstancesList, DescribeNodeDataDisks, DescribeSLInstanceList。

    名称 类型 必选 描述
    Name String 字段名称
    示例值:ComponentNames
    Values Array of String 过滤字段值
    示例值:["Presto-Coordinator"]}]

    FlowExtraDetail

    流程额外信息

    被如下接口引用:DescribeClusterFlowStatusDetail。

    名称 类型 描述
    Title String 额外信息Title
    示例值:Title_test
    Detail Array of FlowParamsDesc 额外信息
    注意:此字段可能返回 null,表示取不到有效值。

    FlowParam

    FlowParam流程参数

    被如下接口引用:DescribeClusterFlowStatusDetail。

    名称 类型 必选 描述
    FKey String 流程参数key
    TraceId:通过TraceId查询
    FlowId: 通过FlowId查询
    示例值:FlowId
    FValue String 参数value
    示例值:11

    FlowParamsDesc

    任务参数描述

    被如下接口引用:DescribeClusterFlowStatusDetail。

    名称 类型 描述
    PKey String 参数key
    示例值:服务信息
    PValue String 参数value
    示例值:ranger-2.3.0

    GroupGlobalConfs

    集群所有伸缩组全局参数信息

    被如下接口引用:DescribeAutoScaleGroupGlobalConf。

    名称 类型 必选 描述
    GroupGlobalConf AutoScaleResourceConf 伸缩组信息
    注意:此字段可能返回 null,表示取不到有效值。
    CurrentNodes Integer 当前伸缩组扩容出来的节点数量。
    示例值:0
    CurrentPostPaidNodes Integer 当前伸缩组扩容出来的后付费节点数量。
    示例值:0
    CurrentSpotPaidNodes Integer 当前伸缩组扩容出来的竞价实例节点数量。
    示例值:0

    GroupInfo

    用户组信息

    被如下接口引用:CreateGroupsSTD。

    名称 类型 必选 描述
    GroupName String 组名
    示例值:groupTest
    Description String 备注
    示例值:userGroup
    Users Array of String 用户列表
    示例值:["user"]

    GroupInfos

    用户组信息

    被如下接口引用:DescribeGroupsSTD。

    名称 类型 必选 描述
    GroupName String 用户组名称
    示例值:nameTest
    Users Array of String 用户名称列表
    示例值:["user"]
    Description String 备注
    示例值:系统组
    CreateTime String 创建时间
    示例值:2024-7-13
    GroupType Integer 用户组类型
    示例值:1
    GroupTypeDesc String 用户组类型描述
    示例值:系统用户组

    HBaseMetricData

    HBase监控数据结构

    被如下接口引用:DescribeHBaseTableRequestMetric, DescribeHBaseTableStoreSizeMetric。

    名称 类型 描述
    MetricName String 指标名称,如 read_request_rate
    MetricDesc String 指标描述,如 read request rate
    Timestamps Array of Integer 时间戳数组
    Values Array of Float 数值数组

    HealthStatus

    进程健康状态

    被如下接口引用:DescribeServiceNodeInfos。

    名称 类型 描述
    Code Integer 运行正常
    示例值:1
    Text String 运行正常
    示例值:良好
    Desc String 运行正常
    示例值:端口探测在5s内响应

    HiveQuery

    Hive查询详情

    被如下接口引用:DescribeHiveQueries。

    名称 类型 描述
    Statement String 查询语句
    示例值:show databases;
    Duration String 执行时长
    示例值:0ms
    StartTime Integer 开始时间毫秒
    示例值:1686101465000
    EndTime Integer 结束时间毫秒
    示例值:1686101465000
    State String 状态
    示例值:FINISHED
    User String 用户
    示例值:hadoop
    JobIds Array of String appId列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[application_16732132113_0001]
    ExecutionEngine String 执行引擎
    示例值:tez
    Id String 查询ID
    示例值:hadoop_20230606172943_a31edbc7

    HostPathVolumeSource

    主机路径

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Path String 主机路径
    示例值:/data/test
    Type String 主机路径类型,当前默认DirectoryOrCreate
    示例值:DirectoryOrCreate

    HostVolumeContext

    Pod HostPath挂载方式描述

    被如下接口引用:ScaleOutCluster, ScaleOutInstance。

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

    ImageInfo

    镜像信息

    被如下接口引用:CreateDynamicInstance。

    名称 类型 必选 描述
    Region String 镜像所属地域
    示例值:ap-guangzhou
    RegistryId String tcr实例Id
    示例值:tcr-xxxxxxxx
    DomainName String 域名
    示例值:tcr-test.tencentcloudcr.com
    NamespaceName String 命名空间
    示例值:Namespacetest
    RepositoryName String 镜像仓库名称
    示例值:spark
    ImageVersion String 镜像版本
    示例值:v3.3.2
    ImagePullPolicy String 镜像拉取策略
    示例值:Always
    Image String 镜像地址
    示例值:tcr-test.tencentcloudcr.com/test/spark:v3.3.2

    ImagePullSecret

    镜像获取密钥

    被如下接口引用:CreateDynamicInstance。

    名称 类型 必选 描述
    SourceNamespace String 源密钥所在命名空间
    示例值:SourceNamespace_test
    SecretNames Array of String 密钥名称列表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:SecretNames_test

    ImpalaQuery

    Impala查询详情

    被如下接口引用:DescribeImpalaQueries。

    名称 类型 描述
    Statement String 执行语句
    示例值:show databases;
    Id String 查询ID
    示例值:884c8989d757036f:ed89c04200000000
    StartTime Integer 开始时间
    示例值:1686101465000
    Duration String 运行时间
    示例值:3s104.599ms
    EndTime Integer 结束时间
    示例值:1686101465000
    State String 执行状态
    示例值:FINISHED
    RowsFetched Integer 获取行数
    示例值:592
    User String 用户
    示例值:user_test
    DefaultDB String 默认DB
    示例值:Default
    Coordinator String 执行的Coordinator节点
    示例值:12.13.14.11:27002
    MaxNodePeakMemoryUsage String 单节点内存峰值
    示例值:12.15 MB
    QueryType String 查询类型
    示例值:QUERY
    ScanHDFSRows Integer 扫描的HDFS行数
    示例值:0
    ScanKUDURows Integer 扫描的Kudu行数
    示例值:599
    ScanRowsTotal Integer 扫描的总行数
    示例值:599
    TotalBytesRead Integer 读取的总字节数
    示例值:0
    TotalBytesSent Integer 发送的总字节数
    示例值:0
    TotalCpuTime Integer CPU总时间
    示例值:0
    TotalInnerBytesSent Integer 内部数据发送总量(Bytes)
    示例值:664
    TotalScanBytesSent Integer 内部扫描数据发送总量(Bytes)
    示例值:0
    EstimatedPerHostMemBytes Integer 预估单节点内存
    示例值:834183168
    NumRowsFetchedFromCache Integer 从缓存中获取的数据行数
    示例值:0
    SessionId String 会话ID
    示例值:f44f47eda7f8a920:a555717b00000000
    PerNodePeakMemoryBytesSum Integer 单节点内存峰值和(Bytes)
    示例值:4324
    BackendsCount Integer 后端个数
    示例值:1
    FragmentInstancesCount Integer fragment数
    示例值:2
    RemainingFragmentCount Integer 剩余未完成Fragment数
    示例值:1

    InsightResult

    洞察结果项

    被如下接口引用:DescribeInsightList。

    名称 类型 必选 描述
    ID String 当Type为HIVE时,是Hive查询ID,当Type为MAPREDUCE,SPARK,TEZ时则是YarnAppID
    示例值:application_162444222_00001
    Type String 洞察应用的类型,HIVE,SPARK,MAPREDUCE,TEZ
    示例值:HIVE,SPARK,MAPREDUCE,TEZ
    RuleID String 洞察规则ID
    HIVE-ScanManyMeta:元数据扫描过多
    HIVE-ScanManyPartition:大表扫描
    HIVE-SlowCompile:编译耗时过长
    HIVE-UnSuitableConfig:不合理参数
    MAPREDUCE-MapperDataSkew:Map数据倾斜
    MAPREDUCE-MapperMemWaste:MapMemory资源浪费
    MAPREDUCE-MapperSlowTask:Map慢Task
    MAPREDUCE-MapperTaskGC:MapperTaskGC
    MAPREDUCE-MemExceeded:峰值内存超限
    MAPREDUCE-ReducerDataSkew:Reduce数据倾斜
    MAPREDUCE-ReducerMemWaste:ReduceMemory资源浪费
    MAPREDUCE-ReducerSlowTask:Reduce慢Task
    MAPREDUCE-ReducerTaskGC:ReducerTaskGC
    MAPREDUCE-SchedulingDelay:调度延迟
    SPARK-CpuWaste:CPU资源浪费
    SPARK-DataSkew:数据倾斜
    SPARK-ExecutorGC:ExecutorGC
    SPARK-MemExceeded:峰值内存超限
    SPARK-MemWaste:Memory资源浪费
    SPARK-ScheduleOverhead:ScheduleOverhead
    SPARK-ScheduleSkew:调度倾斜
    SPARK-SlowTask:慢Task
    TEZ-DataSkew:数据倾斜
    TEZ-MapperDataSkew:Map数据倾斜
    TEZ-ReducerDataSkew:Reduce数据倾斜
    TEZ-TezMemWaste:Memory资源浪费
    TEZ-TezSlowTask:慢Task
    TEZ-TezTaskGC:TasksGC
    示例值:MAPREDUCE-MemExceeded
    RuleName String 洞察规则名字,可参考RuleID的说明
    示例值:峰值内存超限
    RuleExplain String 洞察规则解释
    示例值:Map/Reduce实际峰值内存超过了申请的内存
    Detail String 详情
    示例值:MAP task_1701325375205_0001_m_000000 峰值内存 724.69MB
    Suggestion String 建议信息
    示例值:调大申请的内存或者排查是否有数据倾斜
    Value Integer 洞察异常衡量值,同类型的洞察项越大越严重,不同类型的洞察项无对比意义
    示例值:1231241
    ScheduleTaskExecID String 调度任务执行ID
    示例值:flow1_task1_exec_123
    ScheduleFlowName String 调度流,DAG
    示例值:flow1
    ScheduleTaskName String 调度flow中的某个task节点
    示例值:task1
    JobConf String Yarn任务的部分核心配置
    示例值:{ "mapreduce.job.queuename":, "default" }
    Context String 洞察结构化信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"allocatedMemMBSeconds":118066,"confMemSizeMB":4096,"minimumWastePercent":48,"suggestMemSizeMB":3072,"totalWastePercent":48}

    InspectionTaskSettings

    设置巡检任务配置

    被如下接口引用:ModifyInspectionSettings。

    名称 类型 必选 描述
    TaskType String 巡检任务的唯一标记
    示例值:CpuIOWaitAvgMoreThanThreshold
    Group String 巡检任务组名称
    示例值:节点
    Name String 巡检任务名称
    示例值:CPU利用率连续高于阈值
    TaskSettings Array of TaskSettings 巡检任务参数设置
    Selected String 是否选中,”true“ ”false“
    示例值:true
    Enable String 是否开启监控
    示例值:true
    SettingsJson String 事件Json模板
    示例值: [{ "StrategyMeta":{ "type": "AND" }, "StrategyList":[{"metricName":"elapsedtime","Value":10,"opType":">=","id":"0"}], "StrategyLabels":[{"labelKey":"queue","labelValue":["root","root.default"]}] }]

    InstanceChargePrepaid

    实例预付费参数,只有在付费类型为PREPAID时生效。

    被如下接口引用:CreateCluster, RunJobFlow, ScaleOutCluster。

    名称 类型 必选 描述
    Period Integer 包年包月时间,默认为1,单位:月。
    取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10,11, 12, 24, 36, 48, 60。
    示例值:1
    RenewFlag Boolean 是否自动续费,默认为否。
  • true:是
  • false:否

  • 示例值:false

    Item

    代表一个kv结构

    被如下接口引用:ModifyGlobalConfig, ModifyYarnQueueV2。

    名称 类型 必选 描述
    Key String 健值
    示例值:k
    Value String
    示例值:v

    ItemSeq

    键值对组成的列表

    被如下接口引用:ModifyYarnQueueV2。

    名称 类型 必选 描述
    Items Array of Item 标签名称
    注意:此字段可能返回 null,表示取不到有效值。

    JobFlowResource

    机器资源描述。

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    Spec String 机器类型描述。
    示例值:CVM.SA5
    InstanceType String 机器类型描述,可参考CVM的该含义。
    示例值:SA5.8XLARGE128
    Tags Array of Tag 标签KV对。
    DiskGroups Array of DiskGroup 磁盘描述列表。

    JobFlowResourceSpec

    流程作业资源描述

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    MasterCount Integer 主节点数量。
    示例值:1
    MasterResourceSpec JobFlowResource 主节点配置。
    CoreCount Integer Core节点数量
    示例值:2
    CoreResourceSpec JobFlowResource Core节点配置。
    TaskCount Integer Task节点数量。
    示例值:0
    CommonCount Integer Common节点数量。
    示例值:0
    TaskResourceSpec JobFlowResource Task节点配置。
    CommonResourceSpec JobFlowResource Common节点配置。

    JobResult

    任务步骤结果描述

    被如下接口引用:DescribeJobFlow。

    名称 类型 必选 描述
    Name String 任务步骤名称。
    示例值:test-job
    ActionOnFailure String 任务步骤失败时的处理策略,可以为以下值:
    "CONTINUE",跳过当前失败步骤,继续后续步骤。
    “TERMINATE_CLUSTER”,终止当前及后续步骤,并销毁集群。
    “CANCEL_AND_WAIT”,取消当前步骤并阻塞等待处理。
    示例值:CONTINUE
    JobState String 当前步骤的状态,可以为以下值:
    “JobFlowStepStatusInit”,初始化状态,等待执行。
    “JobFlowStepStatusRunning”,任务步骤正在执行。
    “JobFlowStepStatusFailed”,任务步骤执行失败。
    “JobFlowStepStatusSucceed”,任务步骤执行成功。
    示例值:JobFlowStepStatusRunning
    ApplicationId String YARN任务ID
    示例值:application_1658300000000_0001

    KeyValue

    键值对,主要用来做Filter

    被如下接口引用:DescribeAutoScaleRecords。

    名称 类型 必选 描述
    Key String
    示例值:key_test
    Value String
    示例值:value_test

    KyuubiQueryInfo

    Kyuubi查询信息

    被如下接口引用:DescribeKyuubiQueryInfo。

    名称 类型 描述
    ClientIP String 提交IP
    示例值:192.168.1.1
    Duration Integer 执行时长
    示例值:1000
    EndTime Integer 结束时间
    示例值:1633024800
    EngineID String Engine Id
    示例值:engine-12345
    EngineType String 计算引擎
    示例值:SPARK_SQL
    Id String ID
    示例值:d4cfc064-b7d9-43ec-a766-60013c592dd4
    SessionID String Session Id
    示例值:1c3cdb57-e0b3-489a-804e-662600a24f1d
    BeginTime Integer 开始时间
    示例值:1633024800
    ExecutionState String 执行状态
    示例值:FINISHED
    ExecutionStatement String 执行语句
    示例值:select * from kyuubi_test.kyuubi_new_user_tb order by id ASC
    StatementID String Statement Id
    示例值:d4cfc064-b7d9-43ec-a766-60013c592dd4
    User String 提交用户
    示例值:new_kyuubi_user

    LabelSelector

    标签选择器

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    MatchLabels Array of StringMap

    标签精确匹配条件

    MatchExpressions Array of LabelSelectorRequirement

    标签表达式匹配条件

    LabelSelectorRequirement

    标签选择器匹配表达式

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Key String


    示例值:app
    Operator String

    匹配操作


    示例值:NotIn
    Values Array of String


    示例值:["hbase"]

    LoadAutoScaleStrategy

    自动扩缩容基于负载指标的规则

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    StrategyId Integer 规则ID。
    示例值:1
    StrategyName String 规则名称。
    示例值:name_test
    CalmDownTime Integer 规则生效冷却时间。
    示例值:300
    ScaleAction Integer 扩缩容动作,1表示扩容,2表示缩容。
    示例值:1
    ScaleNum Integer 每次规则生效时的扩缩容数量。
    示例值:2
    ProcessMethod Integer 指标处理方法,1表示MAX,2表示MIN,3表示AVG。
    示例值:1
    Priority Integer 规则优先级,添加时无效,默认为自增。
    示例值:1
    StrategyStatus Integer 规则状态,1表示启动,3表示禁用。
    示例值:1
    YarnNodeLabel String 规则扩容指定 yarn node label
    示例值:label_test
    PeriodValid String 规则生效的有效时间
    示例值:{"Category":1,"StartDay":"2024-12-24","EndDay":"2024-12-24","StartTime":"00:00:00","EndTime":"23:59:59"}
    GraceDownFlag Boolean 优雅缩容开关
    示例值:false
    GraceDownTime Integer 优雅缩容等待时间
    示例值:1800
    GraceDownProtectFlag Boolean 是否开启任务保护
    示例值:true
    Tags Array of Tag 绑定标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    ConfigGroupAssigned String 预设配置组
    示例值:"{"HDFS-3.2.2":-1,"YARN-3.2.2":-1}
    MeasureMethod String 扩容资源计算方法,"DEFAULT","INSTANCE", "CPU", "MEMORYGB"。
    "DEFAULT"表示默认方式,与"INSTANCE"意义相同。
    "INSTANCE"表示按照节点计算,默认方式。
    "CPU"表示按照机器的核数计算。
    "MEMORYGB"表示按照机器内存数计算。
    示例值:DEFAULT
    SoftDeployDesc Array of String 节点部署服务列表,例如["HDFS-3.1.2","YARN-3.1.2"]。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["HDFS-3.1.2","YARN-3.1.2"]
    ServiceNodeDesc String 启动进程列表,例如["NodeManager"]。
    示例值:["NodeManager"]
    ServiceNodeInfo Array of Integer 启动进程列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[98]
    SoftDeployInfo Array of Integer 节点部署服务列表。部署服务仅填写HDFS、YARN。组件名对应的映射关系表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[98]
    LoadMetricsConditions LoadMetricsConditions 多指标触发条件
    注意:此字段可能返回 null,表示取不到有效值。
    GroupId Integer 伸缩组Id
    示例值:2
    Soft String soft例如yarn
    示例值:yarn
    GraceDownProtectTime Integer 任务保护时间
    示例值:60

    LoadMetricsCondition

    负载指标条件

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    StatisticPeriod Integer 规则统计周期,提供1min,3min,5min。
    示例值:300
    TriggerThreshold Integer 触发次数,当连续触发超过TriggerThreshold次后才开始扩缩容。
    示例值:1
    LoadMetrics String 扩缩容负载指标。
    示例值:AvailableVCores#root
    MetricId Integer 规则元数据记录ID。
    示例值:1
    Conditions Array of TriggerCondition 触发条件
    注意:此字段可能返回 null,表示取不到有效值。

    LoadMetricsConditions

    负载指标

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    LoadMetrics Array of LoadMetricsCondition 触发规则条件
    注意:此字段可能返回 null,表示取不到有效值。
    Match Integer 0:所有条件满足
    1:满足任意一个
    示例值:0

    LoginSettings

    登录设置

    被如下接口引用:CreateCloudInstance, CreateCluster, CreateInstance, RunJobFlow。

    名称 类型 必选 描述
    Password String 实例登录密码,8-16个字符,包含大写字母、小写字母、数字和特殊字符四种,特殊符号仅支持!@%^*,密码第一位不能为特殊字符
    示例值:Password_test
    PublicKeyId String 密钥ID。关联密钥后,就可以通过对应的私钥来访问实例;PublicKeyId可通过接口DescribeKeyPairs获取
    示例值:PublicKeyId_test

    MetaDbInfo

    元数据库信息

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    MetaType String 元数据类型。
    示例值:EMR_DEFAULT_META
    UnifyMetaInstanceId String 统一元数据库实例ID。
    示例值:cdb-26u8vvwr
    MetaDBInfo CustomMetaInfo 自建元数据库信息。

    MetricTags

    指标tag

    被如下接口引用:DescribeEmrOverviewMetrics。

    名称 类型 必选 描述
    Unit String 指标单位
    示例值:个
    Type String 指标Type
    示例值:Amount

    ModifyDynamicInstanceForm

    更新DynamicInstance提交的表单数据

    被如下接口引用:ModifyDynamicInstance。

    名称 类型 必选 描述
    ModifyScope Integer

    更新作用域:
    1:添加workerGroup(DynamicInstance级别)
    2:更新存储配置(DynamicInstance级别)
    3:更新标签配置(DynamicInstance级别)
    4:更新高级配置(DynamicInstance级别)
    5:更新PodCpu、PodMem(DynamicInstance-group级别)
    6:更新PodNum、MinPodNum、MaxPodNum(DynamicInstance-group级别)
    7:更新存储配置(DynamicInstance-group级别)
    8:更新标签配置(DynamicInstance-group级别)


    示例值:1
    AddDynamicInstanceGroup DynamicInstanceGroup

    添加的workerGroup信息

    SupportPV Boolean

    是否支持存储配置


    示例值:true
    CBSVolumes Array of CBSVolume

    cbs存储卷列表

    CFSVolumes Array of CFSVolume

    cfs存储卷列表,不包含cfs turbo列表

    COSVolumes Array of COSVolume

    cos存储卷列表

    VolumeMounts Array of VolumeMount

    挂载卷列表

    Labels Array of TkeLabel

    pod标签

    Tolerations Array of Toleration

    Tolerations定义

    Envs Array of NameValue

    环境变量

    DependServices Array of DependService

    依赖外部组件

    SupportNewToken Boolean

    是否生成新token鉴权


    示例值:true
    ModifyDynamicInstanceGroup DynamicInstanceGroup

    DynamicInstance-group级别的更新信息

    CFSTurboVolumes Array of CFSTurboVolume

    cfs turbo挂载列表,不包含标准版

    ModifyResourceTags

    强制修改标签

    被如下接口引用:ModifyResourcesTags。

    名称 类型 必选 描述
    ResourceId String 集群id 或者 cvm id
    示例值:emr-xxxx
    Resource String 资源6段式表达式
    示例值:qcs::emr:ap-guangzhou:...
    ResourcePrefix String 资源前缀
    示例值:emr-instance
    ResourceRegion String ap-beijing
    示例值:地域
    ServiceType String emr
    示例值:服务类型
    DeleteTags Array of Tag 删除的标签列表
    AddTags Array of Tag 添加的标签列表
    ModifyTags Array of Tag 修改的标签列表

    MonthRepeatStrategy

    定时伸缩每月重复任务策略

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    ExecuteAtTimeOfDay String 重复任务执行的具体时刻,例如"01:02:00"
    示例值:15:04:05
    DaysOfMonthRange Array of Integer 每月中的天数时间段描述,长度只能为2,例如[2,10]表示每月2-10号。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1,2]

    MultiDisk

    多云盘参数

    被如下接口引用:AddNodeResourceConfig, InquiryPriceScaleOutInstance。

    名称 类型 必选 描述
    DiskType String 云盘类型
  • CLOUD_SSD:表示云SSD。
  • CLOUD_PREMIUM:表示高效云盘。
  • CLOUD_HSSD:表示增强型SSD云硬盘。

  • 示例值:CLOUD_SSD
    Volume Integer 云盘大小
    示例值:20000
    Count Integer 该类型云盘个数
    示例值:1

    MultiDiskMC

    多云盘参数

    被如下接口引用:DescribeClusterNodes, DescribeInstanceRenewNodes。

    名称 类型 必选 描述
    Count Integer 该类型云盘个数
    示例值:1
    Type Integer 磁盘类型
    1 :本地盘
    2 :云硬盘
    3 : 本地SSD
    4 : 云SSD
    5 : 高效云盘
    6 : 增强型SSD云硬盘
    11 : 吞吐型云硬盘
    12 : 极速型SSD云硬盘
    13 : 通用型SSD云硬盘
    14 : 大数据型云硬盘
    15 : 高IO型云硬盘
    16 : 远端SSD盘
    示例值:4
    Size String 磁盘大小
    示例值:200 GB
    Volume Integer 云盘大小,单位b
    示例值:214748364800

    MultiZoneSetting

    各个可用区的参数信息

    被如下接口引用:CreateInstance, InquiryPriceCreateInstance。

    名称 类型 必选 描述
    ZoneTag String "master"、"standby"、"third-party"
    示例值:"master"
    VPCSettings VPCSettings
    Placement Placement
    ResourceSpec NewResourceSpec

    NameValue

    NameValue 键值

    被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

    名称 类型 必选 描述
    Name String name
    示例值:label
    Value String value
    示例值:value

    NewResourceSpec

    资源描述

    被如下接口引用:CreateInstance, InquiryPriceCreateInstance。

    名称 类型 必选 描述
    MasterResourceSpec Resource 描述Master节点资源
    CoreResourceSpec Resource 描述Core节点资源
    TaskResourceSpec Resource 描述Task节点资源
    MasterCount Integer Master节点数量
    示例值:2
    CoreCount Integer Core节点数量
    示例值:3
    TaskCount Integer Task节点数量
    示例值:0
    CommonResourceSpec Resource 描述Common节点资源
    CommonCount Integer Common节点数量
    示例值:3

    NodeAffinity

    节点亲和性设置

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    RequiredDuringSchedulingIgnoredDuringExecution NodeSelector 节点亲和性-强制调度设置
    注意:此字段可能返回 null,表示取不到有效值。
    PreferredDuringSchedulingIgnoredDuringExecution Array of PreferredSchedulingTerm 节点亲和性-容忍调度
    注意:此字段可能返回 null,表示取不到有效值。

    NodeDetailPriceResult

    用于创建集群价格清单 节点价格详情

    被如下接口引用:InquiryPriceCreateInstance。

    名称 类型 描述
    NodeType String 节点类型 master core task common router mysql
    示例值:master
    PartDetailPrice Array of PartDetailPriceItem 节点组成部分价格详情

    NodeHardwareInfo

    节点硬件信息

    被如下接口引用:DescribeClusterNodes。

    名称 类型 描述
    AppId Integer 用户APPID
    示例值:1211111111
    SerialNo String 序列号
    示例值:e25cf56b-37f7-45b5-b8f2-c3e355052065
    OrderNo String 机器实例ID
    示例值:ins-bg605040
    WanIp String master节点绑定外网IP
    示例值:"--"
    Flag Integer 节点类型。0:common节点;1:master节点
    ;2:core节点;3:task节点
    示例值:1
    Spec String 节点规格
    示例值:CVM.S5
    CpuNum Integer 节点核数
    示例值:8
    MemSize Integer 节点内存,单位b
    示例值:34359738368
    MemDesc String 节点内存描述,单位GB
    示例值:32GB
    RegionId Integer 节点所在region
    示例值:0
    ZoneId Integer 节点所在Zone
    示例值:19
    ApplyTime String 申请时间
    示例值:2024-12-24 11:05:09
    FreeTime String 释放时间
    示例值:0000-00-00 00:00:00
    DiskSize String 硬盘大小
    示例值:200.00 GB
    NameTag String 节点描述
    示例值:master.0
    Services String 节点部署服务
    示例值:Filebeat,gateway,JobHistoryServer,ldap,NameNode,Zookeeper,ResourceManager,slapd,Sysctl,TimeLineServer
    StorageType Integer 磁盘类型,1 :本地盘 2 :云硬盘 3 : 本地SSD 4 : 云SSD 5 : 高效云盘 6 : 增强型SSD云硬盘 11 : 吞吐型云硬盘 12 : 极速型SSD云硬盘 13 : 通用型SSD云硬盘 14 : 大数据型云硬盘 15 : 高IO型云硬盘 16 : 远端SSD盘

    示例值:4
    RootSize Integer 系统盘大小,单位GB
    示例值:70
    ChargeType Integer 付费类型,0:按量计费;1:包年包月
    示例值:0
    CdbIp String 数据库IP
    示例值:"127.0.0.1"
    CdbPort Integer 数据库端口
    示例值:0
    HwDiskSize Integer 硬盘容量,单位b
    示例值:214748364800
    HwDiskSizeDesc String 硬盘容量描述
    示例值:200.00 GB
    HwMemSize Integer 内存容量,单位b
    示例值:34359738368
    HwMemSizeDesc String 内存容量描述
    示例值:32GB
    ExpireTime String 过期时间
    示例值:0000-00-00 00:00:00
    EmrResourceId String 节点资源ID
    示例值:emr-vm-og6cdzw3
    IsAutoRenew Integer 续费标志
    示例值:0
    DeviceClass String 设备标识
    示例值:VSELF_5
    Mutable Integer 支持变配
    示例值:0
    MCMultiDisk Array of MultiDiskMC 多云盘
    注意:此字段可能返回 null,表示取不到有效值。
    CdbNodeInfo CdbInfo 数据库信息
    注意:此字段可能返回 null,表示取不到有效值。
    Ip String 内网IP
    示例值:127.0.0.1
    Destroyable Integer 此节点是否可销毁,1可销毁,0不可销毁
    示例值:0
    Tags Array of Tag 节点绑定的标签
    注意:此字段可能返回 null,表示取不到有效值。
    AutoFlag Integer 是否是自动扩缩容节点,0为普通节点,1为自动扩缩容节点。
    示例值:0
    HardwareResourceType String 资源类型, host/pod
    示例值:HOST
    IsDynamicSpec Integer 是否浮动规格,1是,0否
    示例值:0
    DynamicPodSpec String 浮动规格值json字符串
    示例值:"无"
    SupportModifyPayMode Integer 是否支持变更计费类型 1是,0否
    示例值:0
    RootStorageType Integer 系统盘类型,1 :本地盘 2 :云硬盘 3 : 本地SSD 4 : 云SSD 5 : 高效云盘 6 : 增强型SSD云硬盘 11 : 吞吐型云硬盘 12 : 极速型SSD云硬盘 13 : 通用型SSD云硬盘 14 : 大数据型云硬盘 15 : 高IO型云硬盘 16 : 远端SSD盘

    示例值:4
    Zone String 可用区信息
    示例值:ap-chongqing-1
    SubnetInfo SubnetInfo 子网
    注意:此字段可能返回 null,表示取不到有效值。
    Clients String 客户端
    示例值:HDFS,YARN,ZOOKEEPER,OPENLDAP,KNOX,FILEBEAT,RUNTIME
    CurrentTime String 系统当前时间
    示例值:2024-12-24 12:06:33
    IsFederation Integer 是否用于联邦 ,1是,0否
    示例值:0
    DeviceName String 设备名称
    示例值:EMR标准型S5
    ServiceClient String 服务
    示例值:"无"
    DisableApiTermination Boolean 该实例是否开启实例保护,true为开启 false为关闭
    示例值:true
    TradeVersion Integer 0表示老计费,1表示新计费
    示例值:1
    ServicesStatus String 各组件状态,Zookeeper:STARTED,ResourceManager:STARTED,STARTED已启动,STOPED已停止
    示例值:Filebeat:STARTED,gateway:STARTED,JobHistoryServer:STARTED,NameNode:STARTED,Zookeeper:STARTED,ResourceManager:STARTED
    Remark String 备注
    示例值:"无"
    SharedClusterId String 共享集群id
    示例值:"无"
    SharedClusterIdDesc String 共享集群id描述
    示例值:"无"
    TimingResource Boolean 是否是定时销毁资源
    示例值:true
    TkeClusterId String 资源类型(HardwareResourceType)为pod时,对应的TKE集群id
    示例值:cls-mlxxxxxx
    ConfigurableServices Array of String 新挂磁盘时可支持配置的服务名称列表
    示例值:["HDFS","YARN"]
    NodeMark String 节点标注信息,目前只提供给tf平台使用
    示例值:"core1"
    UnderwriteSetAutoRenew Boolean 包销资源是否支持设置自动续费
    示例值:true
    GpuDesc String Gpu信息
    示例值:1 * NVIDIA A10 1 * 24GB

    NodeMark

    节点标记信息

    被如下接口引用:CreateCluster, CreateInstance, ScaleOutCluster, ScaleOutInstance。

    名称 类型 必选 描述
    NodeType String 节点类型:master,core,task,router
    示例值:master
    NodeNames Array of String 节点标记信息,目前只提供给tf平台使用,作为入参区分同类型节点信息
    示例值:Master_1
    Zone String 可用区名称
    示例值:ap-guangzhou-1

    NodeRenewPriceDetail

    节点续费询价明细

    被如下接口引用:InquirePriceRenewEmr, InquiryPriceRenewInstance。

    名称 类型 描述
    ChargeType Integer 计费类型,包月为1、包销为3
    示例值:1
    EmrResourceId String emr资源id
    示例值:erm-vm-6jdsa17c
    NodeType String 节点类型
    示例值:Master
    Ip String 节点内网ip
    示例值:10.0.0.12
    ExpireTime String 当前到期时间
    示例值:2025-02-24 20:45:00
    OriginalCost Float 原价
    示例值:50
    DiscountCost Float 折扣价
    示例值:25
    RenewPriceDetails Array of RenewPriceDetail 节点子项续费询价明细列表

    NodeResource

    规格管理,规格类型描述

    被如下接口引用:DescribeNodeResourceConfigFast。

    名称 类型 描述
    ResourceConfigId Integer 配置Id
    示例值:75714
    Resource Resource Resource
    注意:此字段可能返回 null,表示取不到有效值。
    CreateTime String 创建时间
    示例值:2024-12-09 20:32:39
    UpdateTime String 更新时间
    示例值:2024-12-09 20:32:39
    IsDefault String 是否默认配置,DEFAULT,BACKUP
    示例值:DEFAULT
    MaxResourceNum Integer 该类型剩余
    示例值:0
    PrepaidUnderwritePeriods Array of Integer 支持的包销时长
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0

    NodeResourceSpec

    资源详情

    被如下接口引用:CreateCluster, ScaleOutCluster。

    名称 类型 必选 描述
    InstanceType String 规格类型,如S2.MEDIUM8
    示例值:S2.MEDIUM8
    SystemDisk Array of DiskSpecInfo 系统盘,系统盘个数不超过1块
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 需要绑定的标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    DataDisk Array of DiskSpecInfo 云数据盘,云数据盘总个数不超过15块
    注意:此字段可能返回 null,表示取不到有效值。
    LocalDataDisk Array of DiskSpecInfo 本地数据盘
    注意:此字段可能返回 null,表示取不到有效值。

    NodeSelector

    Pod强制调度节点选择条件

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    NodeSelectorTerms Array of NodeSelectorTerm Pod强制调度节点选择条件
    注意:此字段可能返回 null,表示取不到有效值。

    NodeSelectorRequirement

    Pod节点选择项

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Key String 节点选择项Key值
    示例值:node.kubernetes.io/instance-type
    Operator String 节点选择项Operator值,支持In, NotIn, Exists, DoesNotExist. Gt, and Lt.
    示例值:In
    Values Array of String 节点选择项Values值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:eklet

    NodeSelectorTerm

    Pod节点选择项集合

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    MatchExpressions Array of NodeSelectorRequirement 节点选择项表达式集合
    注意:此字段可能返回 null,表示取不到有效值。

    NodeSpecDisk

    节点磁盘类型

    被如下接口引用:DescribeNodeSpec。

    名称 类型 必选 描述
    Count Integer 数量
    示例值:1
    Name String 名字
    示例值:高效云盘
    DiskType String 磁盘类型
    示例值:CLOUD_SSD
    DefaultDiskSize Integer 指定磁盘大小
    示例值:1000
    IsSpecialDisk Boolean 是否为特殊的数据盘,如:单副本盘
    示例值:false

    NodeSpecDiskV2

    节点磁盘类型

    被如下接口引用:AttachDisks。

    名称 类型 必选 描述
    Count Integer 数量
    示例值:1
    Name String 名字
    示例值:高效云盘
    DiskType String 磁盘类型
    示例值:CLOUD_SSD
    DefaultDiskSize Integer 指定磁盘大小
    示例值:1000

    NodeSpecFamily

    节点机型列族

    被如下接口引用:DescribeNodeSpec。

    名称 类型 必选 描述
    InstanceFamily String 机型
    示例值:S5
    FamilyName String 机型名称
    示例值:标准型S5
    Order Integer 排序
    示例值:1
    InstanceTypes Array of NodeSpecInstanceType InstanceType的列表
    注意:此字段可能返回 null,表示取不到有效值。

    NodeSpecInstanceType

    节点规格类型

    被如下接口引用:DescribeNodeSpec。

    名称 类型 必选 描述
    InstanceType String 规格
    示例值:SA2.4XALARGE
    Cpu Integer 4
    示例值:核数
    Memory Integer 8,单位G
    示例值:内存
    Order Integer 排序,越小排的越前
    示例值:1
    Num Integer 数量
    示例值:1
    SellOutReason String 售罄原因
    示例值:Fileterd
    SystemDisk Array of NodeSpecDisk 系统盘
    注意:此字段可能返回 null,表示取不到有效值。
    DataDisk Array of NodeSpecDisk 数据盘
    注意:此字段可能返回 null,表示取不到有效值。
    LocalDataDisk Array of NodeSpecDisk 本地数据盘
    注意:此字段可能返回 null,表示取不到有效值。
    SoldOutReason String 售罄原因
    示例值:Fileterd
    InstanceFamily String 机型类别
    示例值:S6
    NodeName String 节点名称
    示例值:Master 节点
    NodeType String 节点类型
    示例值:Master
    Type String 类别
    示例值:typeTest
    TypeName String 类别名称
    示例值:typeTest
    FamilyName String 类别分类
    示例值:s6
    CpuType String cpu类型
    示例值:AMD EPYC™ Rome
    Remark String 售罄 RunOut、库存少 Less、充足 Enough
    示例值:RunOut
    OriginPrice Float 原价
    示例值:10.31
    PrepaidUnderwritePeriods Array of Integer 包销计费机型支持的购买时长
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1]
    GpuDesc String GPU信息
    示例值:4 * NVIDIA T4 4 * 16GB

    NodeSpecType

    节点机型类型

    被如下接口引用:DescribeNodeSpec。

    名称 类型 必选 描述
    Type String 机型序列
    示例值:S
    TypeName String 机型序列名字
    示例值:标准型
    Order Integer 排序
    示例值:1
    InstanceFamilies Array of NodeSpecFamily InstanceFamily数组
    注意:此字段可能返回 null,表示取不到有效值。

    NotRepeatStrategy

    弹性扩缩容执行一次规则上下文

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    ExecuteAt String 该次任务执行的具体完整时间,格式为"2020-07-13 00:00:00"
    示例值:2024-12-05 08:38:00

    OpScope

    操作范围

    被如下接口引用:StartStopServiceOrMonitor。

    名称 类型 必选 描述
    ServiceInfoList Array of ServiceBasicRestartInfo 操作范围,要操作的服务信息
    注意:此字段可能返回 null,表示取不到有效值。

    OperationLog

    操作日志描述

    被如下接口引用:DescribeInstanceOplog。

    名称 类型 描述
    InstanceId Integer EMR实例ID
    示例值:269553004
    Operation String 操作名称
    示例值:扩容
    OperationType Integer 操作类型
    示例值:3
    UserType Integer 用户类型
    示例值:1
    Operator String 操作者
    示例值:700000446528
    CreateTime String 操作时间
    示例值:2025-11-05 15:02:27
    Operand String 操作对象
    示例值:集群
    OperationDesc String 操作详情
    示例值:节点信息: S2.2XLARGE161(master), SA2.LARGE162(core)
    SecurityLevel String 安全级别
    示例值:一般

    Order

    描述排序,用于排序.

    被如下接口引用:DescribeGroupsSTD。

    名称 类型 必选 描述
    Name String 排序字段。
    示例值:create_time
    Direction String Desc or Asc。
    示例值:asc

    OtherAccountInfo

    其他账号信息

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    OtherUin String 其他账号UIN
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:700000446533
    RoleName String 其他账号授权角色名称
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:EMR-CROSS-ACCOUNT-ROLE

    OverviewMetricData

    概览数据

    被如下接口引用:DescribeEmrOverviewMetrics。

    名称 类型 必选 描述
    Metric String 指标名
    示例值:EMR.111.NODE.CPU
    First Integer 第一个数据时间戳
    示例值:1708496100
    Last Integer 最后一个数据时间戳
    示例值:1708499400
    Interval Integer 采样点时间间隔
    示例值:300
    DataPoints Array of String 采样点数据
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1.2, 1.4]
    Tags MetricTags 指标tags
    注意:此字段可能返回 null,表示取不到有效值。

    OverviewRow

    Hbase的TableMetric Overview返回

    被如下接口引用:DescribeHBaseTableOverview。

    名称 类型 描述
    Table String 表名字
    示例值:SYSTEM_STATS
    ReadRequestCount Float 读请求次数
    示例值:117.45
    WriteRequestCount Float 写请求次数
    示例值:0
    MemstoreSize Float 当前memstore的size
    示例值:7982
    StoreFileSize Float 当前region中StroreFile的size
    示例值:2930043
    Operation String regions,点击可跳转
    示例值:Regions,RegionServers
    StoreFileNum Float StoreFile数量
    示例值:10

    PartDetailPriceItem

    用于创建集群价格清单-节点组成部分价格

    被如下接口引用:InquiryPriceCreateInstance。

    名称 类型 描述
    InstanceType String 类型包括:节点->node、系统盘->rootDisk、云数据盘->dataDisk、metaDB
    示例值:node
    Price Float 单价(原价)
    示例值:0.52
    RealCost Float 单价(折扣价)
    示例值:0.34
    RealTotalCost Float 总价(折扣价)
    示例值:0.34
    Policy Float 折扣
    示例值:6.6
    GoodsNum Integer 数量
    示例值:1

    Period

    Serverless HBase包年包月时间

    被如下接口引用:CreateSLInstance。

    名称 类型 必选 描述
    TimeSpan Integer 时间跨度
    示例值:1
    TimeUnit String 时间单位,"m"代表月。
    示例值:m

    PersistentVolumeContext

    Pod PVC存储方式描述

    被如下接口引用:ScaleOutCluster, ScaleOutInstance。

    名称 类型 必选 描述
    DiskSize Integer 磁盘大小,单位为GB。
    示例值:1024
    DiskType String 磁盘类型。CLOUD_PREMIUM;CLOUD_SSD
    示例值:CLOUD_BSSD
    DiskNum Integer 磁盘数量
    示例值:1
    ExtraPerformance Integer 云盘额外性能
    示例值:100

    Placement

    描述集群实例位置信息

    被如下接口引用:CreateCluster, CreateInstance, InquirePriceRenewEmr, InquiryPriceCreateInstance, InquiryPriceRenewInstance, InquiryPriceUpdateInstance, RunJobFlow。

    名称 类型 必选 描述
    Zone String 实例所属的可用区,例如ap-guangzhou-1。该参数也可以通过调用DescribeZones 的返回值中的Zone字段来获取。
    示例值:ap-guangzhou-1
    ProjectId Integer 实例所属项目ID。该参数可以通过调用DescribeProject 的返回值中的 projectId 字段来获取。不填为默认项目。
    示例值:0

    PodAffinitySpec

    Pod亲和性

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    RequiredDuringSchedulingIgnoredDuringExecution Array of PodAffinityTerm

    调度硬关联规则

    PreferredDuringSchedulingIgnoredDuringExecution Array of WeightedPodAffinityTerm

    调度软关联规则

    PodAffinityTerm

    Pod亲和性项

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    LabelSelector LabelSelector

    标签选择器

    Namespaces Array of String

    命名空间列表


    示例值:["251233706-emr-3lq4rr8w"]
    TopologyKey String

    拓扑域键


    示例值:topology.kubernetes.io/zone
    NamespaceSelector LabelSelector

    命名空间选择器

    PodNewParameter

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

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    InstanceId String TKE或EKS集群ID
    示例值:emr-test
    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"
    ]
    }
    ]
    }
    ]
    }
    }
    }
    }
    }
    }
    }

    PodNewSpec

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

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    ResourceProviderIdentifier String 外部资源提供者的标识符,例如"cls-a1cd23fa"。
    示例值:cls-a1cd2dsx
    ResourceProviderType String 外部资源提供者类型,例如"tke",当前仅支持"tke"。
    示例值:tke
    NodeFlag String 资源的用途,即节点类型,当前仅支持"TASK"。
    示例值:TASK
    Cpu Integer CPU核数。
    示例值:1
    Memory Integer 内存大小,单位为GB。
    示例值:1
    CpuType String Eks集群-CPU类型,当前支持"intel"和"amd"
    示例值:intel
    PodVolumes Array of PodVolume Pod节点数据目录挂载信息。
    EnableDynamicSpecFlag Boolean 是否浮动规格,默认否
  • true:代表是
  • false:代表否

  • 示例值:true
    DynamicPodSpec DynamicPodSpec 浮动规格
    注意:此字段可能返回 null,表示取不到有效值。
    VpcId String 代表vpc网络唯一id
    示例值:vpc-se938xw9
    SubnetId String 代表vpc子网唯一id
    示例值:sub-ei39s9xx
    PodName String pod name
    示例值:podname_test
    OtherAccountInfo OtherAccountInfo 其他账号授权信息

    PodParameter

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

    被如下接口引用:ScaleOutInstance。

    名称 类型 必选 描述
    ClusterId String TKE或EKS集群ID
    示例值:cls-1234abcd
    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"
    }
    }
    ]
    }
    示例值:{ "apiVersion": "v1", "clusters": [ { "cluster": {
    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"
    ]
    }
    ]
    }
    ]
    }
    }
    }
    }
    }
    }
    }
    示例值:{ "apiVersion": "apps/v1", "kind": "Deployment", "metadata

    PodSaleSpec

    Pod资源售卖规格

    被如下接口引用:DescribeCvmQuota。

    名称 类型 必选 描述
    NodeType String 可售卖的资源规格,仅为以下值:"TASK","CORE","MASTER","ROUTER"。
    示例值:TASK
    Cpu Integer Cpu核数。
    示例值:4
    Memory Integer 内存数量,单位为GB。
    示例值:8
    Number Integer 该规格资源可申请的最大数量。
    示例值:496

    PodSpec

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

    被如下接口引用:ScaleOutInstance。

    名称 类型 必选 描述
    ResourceProviderIdentifier String 外部资源提供者的标识符,例如"cls-a1cd23fa"。
    示例值:cls-a1cd23fa
    ResourceProviderType String 外部资源提供者类型,例如"tke",当前仅支持"tke"。
    示例值:tke
    NodeType String 资源的用途,即节点类型,当前仅支持"TASK"。
    示例值:Task
    Cpu Integer CPU核数。
    示例值:0
    Memory Integer 内存大小,单位为GB。
    示例值:0
    DataVolumes Array of String 资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用。弃用
    示例值:["/data"]
    CpuType String Eks集群-CPU类型,当前支持"intel"和"amd"
    示例值:intel
    PodVolumes Array of PodVolume Pod节点数据目录挂载信息。
    示例值:["/data"]
    IsDynamicSpec Integer 是否浮动规格,1是,0否
    示例值:0
    DynamicPodSpec DynamicPodSpec 浮动规格
    注意:此字段可能返回 null,表示取不到有效值。
    VpcId String 代表vpc网络唯一id
    示例值:vpc-xxtt67hg
    SubnetId String 代表vpc子网唯一id
    示例值:sub-yiu78vg7
    PodName String pod name
    示例值:emr-p9biv55e-kyuubi-kyuubiserver-0

    PodSpecInfo

    Pod相关信息

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    PodSpec PodNewSpec 使用Pod资源扩容时,指定的Pod规格以及来源等信息
    PodParameter PodNewParameter POD自定义权限和自定义参数

    PodState

    单个pod状态

    被如下接口引用:SyncPodState。

    名称 类型 必选 描述
    Name String pod的名称
    示例值:1234-5677-3352-2
    Uuid String pod uuid
    示例值:1234-5677-3352-2
    State String pod的状态
    示例值:POD_STATE_DELETED
    Reason String pod处于该状态原因
    示例值:pod is deleted
    OwnerCluster String pod所属集群
    示例值:emr-cluster
    Memory Integer pod内存大小
    示例值:2

    PodVolume

    Pod的存储设备描述信息。

    被如下接口引用:ScaleOutCluster, ScaleOutInstance。

    名称 类型 必选 描述
    VolumeType String 存储类型,可为"pvc","hostpath"。
    示例值:pvc
    PVCVolume PersistentVolumeContext 当VolumeType为"pvc"时,该字段生效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"DiskType":"CLOUD_PREMIUM","DiskSize":1000,"DiskNum":1}
    HostVolume HostVolumeContext 当VolumeType为"hostpath"时,该字段生效。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"VolumePath":"/data/emr"}

    PreExecuteFileSetting

    预执行脚本配置

    被如下接口引用:DescribeBootScript, ModifyBootScript。

    名称 类型 必选 描述
    Path String 脚本在COS上路径
    Args String 执行脚本参数
    Bucket String COS的Bucket名称
    Region String COS的Region名称
    Domain String COS的Domain数据
    RunOrder Integer 执行顺序
    WhenRun String resourceAfter 或 clusterAfter
    CosFileName String 脚本文件名
    CosFileURI String 脚本的cos地址
    CosSecretId String cos的SecretId
    CosSecretKey String Cos的SecretKey
    AppId String cos的appid
    Remark String 备注

    PreExecuteFileSettings

    预执行脚本配置

    被如下接口引用:CreateInstance, ScaleOutInstance。

    名称 类型 必选 描述
    Path String 脚本在COS上路径,已废弃
    示例值:emr/emr_init.sh
    Args Array of String 执行脚本参数
    示例值:Args_test
    Bucket String COS的Bucket名称,已废弃
    示例值:starmaker-research-xxxx
    Region String COS的Region名称,已废弃
    示例值:ap-mumbai
    Domain String COS的Domain数据,已废弃
    示例值:Domain_test
    RunOrder Integer 执行顺序
    示例值:0
    WhenRun String resourceAfter 或 clusterAfter
    示例值:resourceAfter
    CosFileName String 脚本文件名,已废弃
    示例值:test_file
    CosFileURI String 脚本的cos地址
    示例值:cos://xxxxx
    CosSecretId String cos的SecretId
    示例值:CosSecretId_test
    CosSecretKey String Cos的SecretKey
    示例值:CosSecretKey_test
    AppId String cos的appid,已废弃
    示例值:41345531
    Remark String 备注
    示例值:remark_test

    PrePaySetting

    Serverless HBase 预付费设置

    被如下接口引用:CreateSLInstance。

    名称 类型 必选 描述
    Period Period 时间
    注意:此字段可能返回 null,表示取不到有效值。
    AutoRenewFlag Integer 自动续费标记,0:表示通知即将过期,但不自动续费 1:表示通知即将过期,而且自动续费 2:表示不通知即将过期,也不自动续费
    示例值:0

    PreferredSchedulingTerm

    Pod容忍调度节点选择项

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Weight Integer 权重,范围1-100
    示例值:1
    Preference NodeSelectorTerm 节点选择表达式
    注意:此字段可能返回 null,表示取不到有效值。

    PriceDetail

    价格详情

    被如下接口引用:InquiryPriceRenewInstance, InquiryPriceUpdateInstance。

    名称 类型 描述
    ResourceId String 节点ID
    示例值:emr-vm-xxxxxxxx
    Formula String 价格计算公式
    示例值:(1).变配订单金额:X 元[ 新配置单价X时长Y折扣Z% - 旧配置单价M时长N折扣O%]
    (2).时长:S月
    OriginalCost Float 原价
    示例值:4.3
    DiscountCost Float 折扣价
    示例值:3.2

    PriceResource

    询价资源

    被如下接口引用:InquiryPriceScaleOutInstance。

    名称 类型 描述
    Spec String 需要的规格
    示例值:CVM.SA5
    StorageType Integer 硬盘类型
    示例值:6
    DiskType String 硬盘类型
    示例值:CLOUD_HSSD
    RootSize Integer 系统盘大小
    示例值:70
    MemSize Integer 内存大小
    示例值:8193
    Cpu Integer 核心数量
    示例值:4
    DiskSize Integer 硬盘大小
    示例值:200
    MultiDisks Array of MultiDisk 云盘列表
    注意:此字段可能返回 null,表示取不到有效值。
    DiskCnt Integer 磁盘数量
    示例值:0
    InstanceType String 规格
    示例值:SA5.LARGE8
    Tags Array of Tag 标签
    注意:此字段可能返回 null,表示取不到有效值。
    DiskNum Integer 磁盘数量
    示例值:0
    LocalDiskNum Integer 本地盘的数量
    示例值:0
    GpuDesc String GPU信息
    示例值:1 * NVIDIA T4

    PriceResult

    询价结果

    被如下接口引用:InquiryPriceUpdateInstance。

    名称 类型 必选 描述
    OriginalCost Float 原价
    示例值:4240
    DiscountCost Float 折扣价
    示例值:4240

    QuotaEntity

    获取CVM配额

    被如下接口引用:DescribeCvmQuota。

    名称 类型 描述
    UsedQuota Integer 已使用配额
    示例值:0
    RemainingQuota Integer 剩余配额
    示例值:0
    TotalQuota Integer 总配额
    示例值:0
    Zone String 可用区
    示例值:100002

    RayCluster

    RayCluster

    被如下接口引用:DescribeDynamicInstanceList。

    名称 类型 必选 描述
    RayClusterName String

    RayCluster 集群名


    示例值:ClusterA
    RayClusterId Integer

    RayCluster 集群 id


    示例值:13997
    PodCount Integer

    pod 数量


    示例值:31
    CreateTime String

    集群创建时间


    示例值:2025-11-11 12:23:11
    RedisCount Integer

    redis 实例数量


    示例值:1
    SubmitType Integer

    创建类型

    枚举值:

    • 1: 表单创建
    • 2: yaml创建

    示例值:1
    DashboardUrl String

    head访问地址,也是dashboard地址


    示例值:http://xxxx/raycluster

    RenewInstancesInfo

    集群续费实例信息

    被如下接口引用:DescribeInstanceRenewNodes。

    名称 类型 描述
    EmrResourceId String 节点资源ID
    示例值:emr-vm-wwwe2
    Flag Integer 节点类型。0:common节点;1:master节点
    ;2:core节点;3:task节点
    示例值:1
    Ip String 内网IP
    示例值:192.182.1.1
    MemDesc String 节点内存描述
    示例值:8G
    CpuNum Integer 节点核数
    示例值:4
    DiskSize String 硬盘大小
    示例值:100G
    ExpireTime String 过期时间
    示例值:2021-02-01
    Spec String 节点规格
    示例值:CVM.S2
    StorageType Integer 磁盘类型
    示例值:1
    RootSize Integer 系统盘大小
    示例值:50
    RootStorageType Integer 系统盘类型
    示例值:5高效云盘
    MCMultiDisk Array of MultiDiskMC 数据盘信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[{"type":5,"size":"200.00 GB","sizeOuter":"200G","count":1,"Volume":214748364800,"storageId":""}]

    RenewPriceDetail

    节点子项续费询价明细

    被如下接口引用:InquirePriceRenewEmr, InquiryPriceRenewInstance。

    名称 类型 描述
    BillingName String 计费项名称
    示例值:云SSD 70G
    Policy Float 折扣
    示例值:0.5
    Quantity Integer 数量
    示例值:1
    OriginalCost Float 原价
    示例值:50
    DiscountCost Float 折扣价
    示例值:25

    RepeatStrategy

    定时伸缩任务策略

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    RepeatType String 取值范围"DAY","DOW","DOM","NONE",分别表示按天重复、按周重复、按月重复和一次执行。必须填写
    示例值:NONE
    DayRepeat DayRepeatStrategy 按天重复规则,当RepeatType为"DAY"时有效
    注意:此字段可能返回 null,表示取不到有效值。
    WeekRepeat WeekRepeatStrategy 按周重复规则,当RepeatType为"DOW"时有效
    注意:此字段可能返回 null,表示取不到有效值。
    MonthRepeat MonthRepeatStrategy 按月重复规则,当RepeatType为"DOM"时有效
    注意:此字段可能返回 null,表示取不到有效值。
    NotRepeat NotRepeatStrategy 一次执行规则,当RepeatType为"NONE"时有效
    注意:此字段可能返回 null,表示取不到有效值。
    Expire String 规则过期时间,超过该时间后,规则将自动置为暂停状态,形式为"2020-07-23 00:00:00"。必须填写
    示例值:2026-01-09 23:59:59
    StartTime String 周期性规则开始时间
    示例值:2024-01-09 23:59:59

    Resource

    资源详情

    被如下接口引用:AddNodeResourceConfig, CreateInstance, DescribeNodeResourceConfigFast, InquiryPriceCreateInstance。

    名称 类型 必选 描述
    Spec String

    节点规格描述,如CVM.SA2。


    示例值:CVM.SA2
    StorageType Integer

    取值范围:
    "LOCAL_SSD" 3 //本地SSD
    "CLOUD_SSD" 4 //云SSD
    "CLOUD_PREMIUM" 5 //高效云盘
    "CLOUD_HSSD" 6 //增强型SSD云硬盘
    "CLOUD_THROUGHPUT" 11//吞吐型云硬盘
    "CLOUD_TSSD" 12 //极速型SSD云硬盘
    "CLOUD_BSSD" 13 //通用型SSD云硬盘
    "CLOUD_BIGDATA" 14 //大数据型云硬盘
    "CLOUD_HIGHIO" 15 //高IO型云硬盘

    该类型字段为无效字段,实际系统盘类型会根据数据盘类型和节点类型判断,如果节点支持所选的数据盘类型,系统盘类型会跟数据盘保持一致,建议使用CreateCluster接口


    示例值:5
    DiskType String

    数据盘类型 取值范围:

    CLOUD_SSD:表示云SSD。

    CLOUD_PREMIUM:表示高效云盘。

    CLOUD_BASIC:表示云硬盘。

    LOCAL_BASIC:表示本地盘。

    LOCAL_SSD:表示本地SSD。

    CLOUD_HSSD:表示增强型SSD云硬盘。

    CLOUD_THROUGHPUT:表示吞吐型云硬盘。

    CLOUD_TSSD:表示极速型SSD云硬盘。

    CLOUD_BIGDATA:表示大数据型云硬盘。

    CLOUD_HIGHIO:表示高IO型云硬盘。

    CLOUD_BSSD:表示通用型SSD云硬盘。

    REMOTE_SSD:表示远端SSD盘。


    示例值:LOUD_PREMIUM
    MemSize Integer

    内存容量,单位为M


    示例值:131072
    Cpu Integer

    CPU核数


    示例值:2
    DiskSize Integer

    数据盘容量


    示例值:300
    RootSize Integer

    系统盘容量


    示例值:0
    MultiDisks Array of MultiDisk

    云盘列表,当数据盘为一块云盘时,直接使用DiskType和DiskSize参数,超出部分使用MultiDisks


    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag

    需要绑定的标签列表


    注意:此字段可能返回 null,表示取不到有效值。
    InstanceType String

    规格类型,如S2.MEDIUM8


    示例值:S2.MEDIUM8
    LocalDiskNum Integer

    本地盘数量,该字段已废弃


    示例值:1
    DiskNum Integer

    本地盘数量,如2


    示例值:2
    GpuDesc String

    GPU信息


    示例值:1 * NVIDIA T4
    PartitionNumber Integer

    分区置放群组分区数


    示例值:1

    ResourceDetail

    资源详情

    被如下接口引用:DescribeInstances。

    名称 类型 描述
    Spec String 规格
    示例值:CVM.SA5
    SpecName String 规格名
    示例值:EMR内存型M6
    StorageType Integer 硬盘类型
    示例值:6
    DiskType String 硬盘类型
    示例值:CLOUD_PREMIUM
    RootSize Integer 系统盘大小
    示例值:1024
    MemSize Integer 内存大小
    示例值:1024
    Cpu Integer CPU个数
    示例值:4
    DiskSize Integer 硬盘大小
    示例值:1024
    InstanceType String 规格
    示例值:SA5.2XLARGE16

    RestartPolicy

    组件重启策略

    被如下接口引用:DescribeServiceNodeInfos。

    名称 类型 描述
    Name String 重启策略名。
    示例值:fast
    DisplayName String 策略展示名称。
    示例值:快速暂停
    Describe String 策略描述。
    示例值:服务停止前不迁移Region
    BatchSizeRange Array of Integer 批量重启节点数可选范围。
    示例值:[1,9999]
    IsDefault String 是否是默认策略。
    示例值:false

    ResultItem

    用户组的输出结果

    被如下接口引用:CreateGroupsSTD, DeleteGroupsSTD。

    名称 类型 必选 描述
    Item String 此处为用户组名
    示例值:groupTest
    Result Boolean 创建用户组是否成功
    示例值:true
    Reason String 若是创建失败, 提供失败原因
    示例值:用户组已存在

    SLInstance

    Serverless Instance

    被如下接口引用:DescribeSLInstance。

    名称 类型 描述
    InstanceId String EMR Instance Id
    示例值:emr-xxx
    ClusterId Integer EMR Numeric Instance Id
    示例值:1234567
    InstanceName String Instance Name
    示例值:instance-1
    RegionId Integer Region id
    示例值:1
    Zone String Zone Name
    示例值:ap-guangzhou-2
    PayMode Integer Pay Mode
    示例值:0
    DiskType String Disk Type
    示例值:CLOUD_HSSD
    DiskSize Integer Disk Size
    示例值:200
    NodeType String Node Type
    示例值:4C16G
    NodeNum Integer Node Number
    示例值:3
    ExpireTime String Expire Time
    示例值:0000-00-00 00:00:00
    IsolateTime String Isolate Time
    示例值:0000-00-00 00:00:00
    CreateTime String Create Time
    示例值:2025-06-20 10:33:30
    AutoRenewFlag Integer Auto Renew Flag
    示例值:0
    Status Integer EMR Numeric Instance Status
    示例值:2
    ZoneSettings Array of ZoneSetting Zone Setting
    Tags Array of Tag Bound Tags
    DeployRole String Deploy Role
    示例值:Active

    SLInstanceInfo

    Serverless HBase实例信息

    被如下接口引用:DescribeSLInstanceList。

    名称 类型 描述
    ClusterId String 集群实例字符串ID
    示例值:emr-xxxxxxx
    Id Integer 集群实例数字ID
    示例值:126358002
    StatusDesc String 状态描述
    示例值:状态描述
    HealthStatus String 健康状态
    示例值:Green
    ClusterName String 实例名称
    示例值:sl-hbase-f3bak7nv
    RegionId Integer 地域ID
    示例值:1
    ZoneId Integer 主可用区ID
    示例值:100002
    Zone String 主可用区
    示例值:ap-guangzhou-2
    AppId Integer 用户APPID
    示例值:663622
    VpcId Integer 主可用区私有网络ID
    示例值:45666
    VpcName String 主可用区私有网络名
    示例值:vpc-ts4xd
    SubnetId Integer 主可用区子网ID
    示例值:3422
    SubnetName String 主可用区子网名
    示例值:subnet-d44sdf
    Status Integer 状态码
    示例值:1
    AddTime String 创建时间
    示例值:创建时间
    PayMode Integer 集群计费类型。0表示按量计费,1表示包年包月
    示例值:0
    ZoneSettings Array of ZoneSetting 多可用区信息
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 实例标签
    注意:此字段可能返回 null,表示取不到有效值。
    AutoRenewFlag Integer 自动续费标记, 0:表示通知即将过期,但不自动续费 1:表示通知即将过期,而且自动续费 2:表示不通知即将过期,也不自动续费,若业务无续费概念,设置为0
    示例值:0
    IsolateTime String 隔离时间,未隔离返回0000-00-00 00:00:00。
    示例值:0000-00-00 00:00:00
    ExpireTime String 过期时间,后付费返回0000-00-00 00:00:00
    示例值:0000-00-00 00:00:00
    DeployRole String 主备部署角色
    示例值:Active
    WebUIUrl String webui地址
    示例值:http://tcbase.com

    ScaleOutNodeConfig

    扩容节点类型以及数量

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    NodeFlag String 扩容节点类型取值范围:
  • MASTER

  • TASK

  • CORE

  • ROUTER

  • 示例值:MASTER
    NodeCount Integer 扩容节点数量
    示例值:5

    ScaleOutServiceConfGroupsInfo

    扩容指定配置组

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    ServiceComponentName String 组件版本名称 如 HDFS-2.8.5
    示例值:HDFS-2.8.5
    ConfGroupName String 配置组名 如hdfs-core-defaultGroup ConfGroupName参数传入 代表配置组维度
    ConfGroupName参数不传 默认 代表集群维度
    示例值:hdfs-core-defaultGroup

    SceneSoftwareConfig

    集群应用场景以及支持部署组件信息

    被如下接口引用:CreateCluster。

    名称 类型 必选 描述
    Software Array of String 部署的组件列表。不同的EMR产品版本ProductVersion 对应不同可选组件列表,不同产品版本可选组件列表查询:组件版本
    填写实例值:hive、flink。
    示例值:["hadoop-2.8.4\n","zookeeper-3.4.9\n","knox-1.2.0\n"]
    SceneName String 默认Hadoop-Default,场景查询场景化取值范围:
    Hadoop-Kudu
    Hadoop-Zookeeper
    Hadoop-Presto
    Hadoop-Hbase
    Hadoop-Default
    示例值:Hadoop-Kudu

    SchedulerTaskDetail

    调度任务详情

    被如下接口引用:DescribeYarnScheduleHistory。

    名称 类型 描述
    Step String 步骤
    示例值:重启
    Progress String 进度
    示例值:10%
    FailReason String 失败信息
    示例值:进程正在扩容中
    JobId Integer 用来获取详情的id
    示例值:39986

    SchedulerTaskInfo

    yarn资源调度历史

    被如下接口引用:DescribeYarnScheduleHistory。

    名称 类型 描述
    SchedulerName String 调度器类型
    示例值:capacity
    OperatorName String 操作类型
    示例值:OperatorName_test
    CreateTime String 开始时间
    示例值:CreateTime_test
    EndTime String 结束时间
    示例值:EndTime_test
    State Integer 状态
    示例值:2
    Details Array of SchedulerTaskDetail 详情
    注意:此字段可能返回 null,表示取不到有效值。

    ScriptBootstrapActionConfig

    添加引导操作

    被如下接口引用:CreateCluster, ScaleOutCluster。

    名称 类型 必选 描述
    CosFileURI String 脚本的cos地址,参照格式:https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh查询cos存储桶列表:[存储桶列表](https://console.cloud.tencent.com/cos/bucket)
    示例值:https://becklong-cos-1258469122.cos.ap-guangzhou.myqcloud.com/te
    ExecutionMoment String 引导脚步执行时机范围
  • resourceAfter:节点初始化后
  • clusterAfter:集群启动后
  • clusterBefore:集群启动前

  • 示例值:resourceAfter
    Args Array of String 执行脚本参数,参数格式请遵循标准Shell规范
    示例值:args_test
    CosFileName String 脚本文件名
    示例值:name_test
    Remark String 备注
    示例值:remark_test

    SearchItem

    搜索字段

    被如下接口引用:DescribeClusterNodes, DescribeInstanceOplog, DescribeServiceNodeInfos。

    名称 类型 必选 描述
    SearchType String 支持搜索的类型
    示例值:ipv4
    SearchValue String 支持搜索的值
    示例值:127.0.0.1

    ServiceBasicRestartInfo

    操作的服务范围

    被如下接口引用:StartStopServiceOrMonitor。

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

    ServiceDeployInfo

    服务的部署信息

    被如下接口引用:InstallSoftware。

    名称 类型 必选 描述
    ServiceName String 服务名称
    示例值:YARN
    ComponentDeployInfoList Array of ComponentDeployInfo 角色的部署信息列表

    ServiceNodeDetailInfo

    服务进程信息

    被如下接口引用:DescribeServiceNodeInfos。

    名称 类型 描述
    Ip String 进程所在节点IP
    示例值:10.10.10.10
    NodeType Integer 进程类型
    示例值:66
    NodeName String 进程名称
    示例值:PrestoSql-Worker
    ServiceStatus Integer 服务组件状态
    示例值:1
    MonitorStatus Integer 进程监控状态
    示例值:1
    Status Integer 服务组件状态
    示例值:1
    PortsInfo String 进程端口信息
    示例值: port_test
    LastRestartTime String 最近重启时间
    示例值:2021-09-01 11:31:55
    Flag Integer 节点类型
    示例值:2
    ConfGroupId Integer 配置组ID
    示例值:1
    ConfGroupName String 配置组名称
    示例值:prestosql-defaultGroup
    ConfStatus Integer 节点是否需要重启
    示例值:1
    ServiceDetectionInfo Array of ServiceProcessFunctionInfo 进程探测信息
    注意:此字段可能返回 null,表示取不到有效值。
    NodeFlagFilter String 节点类型
    示例值:core
    HealthStatus HealthStatus 进程健康状态
    注意:此字段可能返回 null,表示取不到有效值。
    IsSupportRoleMonitor Boolean 角色是否支持监控
    示例值:true
    StopPolicies Array of RestartPolicy 暂停策略
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:null
    HAState String 测试环境api强校验,现网没有,emrcc接口返回有。不加会报错
    示例值:127.0.0.1
    NameService String NameService名称
    示例值:name_test
    IsFederation Boolean 是否支持联邦
    示例值:false
    DataNodeMaintenanceState Integer datanode是否是维护状态
    示例值:1表示处于维护状态

    ServiceProcessFunctionInfo

    进程检测信息

    被如下接口引用:DescribeServiceNodeInfos。

    名称 类型 描述
    DetectAlert String 探测告警级别
    示例值:DetectAlert
    DetectFunctionKey String 探测功能描述
    示例值:DetectFunctionKey
    DetectFunctionValue String 探测功能结果
    示例值:DetectFunctionValue
    DetectTime String 探测结果
    示例值:DetectTime

    ShortNodeInfo

    节点信息

    被如下接口引用:DescribeInstances。

    名称 类型 必选 描述
    NodeType String 节点类型,Master/Core/Task/Router/Common
    示例值:Master
    NodeSize Integer 节点数量
    示例值:1

    SoftDependInfo

    体外客户端组件依赖信息

    被如下接口引用:DescribeInstancesList。

    名称 类型 描述
    SoftName String 组件名称
    示例值:hdfs-2.8.5
    Required Boolean 是否必选
    示例值:true

    SparkApplicationsList

    spark任务列表

    被如下接口引用:DescribeSparkApplications。

    名称 类型 描述
    ID String 应用id
    示例值:spark-49cdc7a5b06a46fca99c497a5b47e7f1
    Name String 应用名称
    示例值:kyuubi_CONNECTION_SPARK_SQL_hadoop_7043f4f2-c8b6-4681-8e7a-873e477c6db7
    User String 用户
    示例值:hadoop
    StartTime Integer 起始时间
    示例值:1746003194374
    EndTime Integer 结束时间
    示例值:1746003394835
    Duration Integer 持续时间
    示例值:200461
    State String 状态
    示例值:completed
    ApplicationType String 类型
    示例值:SPARK
    CoreSeconds Integer 核数*秒
    示例值:478
    MemorySeconds String 内存MB*秒
    示例值:489472 MB Seconds
    Insight String 洞察结果
    示例值:UNKNOWN

    SparkQuery

    spark查询详情

    被如下接口引用:DescribeSparkQueries。

    名称 类型 描述
    Statement String 执行语句
    示例值:SELECT * FROM tb
    Duration Integer 执行时长(单位毫秒)
    示例值:163
    Status String 执行状态
    示例值:RUNNING
    Id String 查询ID
    示例值:1
    ScanPartitionNum Integer 扫描分区数
    示例值:5
    ScanRowNum Integer 扫描总行数
    示例值:10
    ScanFileNum Integer 扫描总文件数
    示例值:12
    ScanTotalData Integer 查询扫描总数据量(单位B)
    示例值:65535
    ApplicationId Array of String 应用ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["application_1711099949065_0343"]
    OutputRowNum Integer 输出总行数
    示例值:16
    OutputFileNum Integer 输出总文件数
    示例值:12
    OutputPartitionNum Integer 输出分区数
    示例值:13
    OutputTotalData Integer 输出总数据量(单位B)
    示例值:65532
    BeginTime Integer 开始时间
    示例值:1712124411
    EndTime Integer 结束时间
    示例值:1712124416

    StageInfoDetail

    任务步骤详情

    被如下接口引用:DescribeClusterFlowStatusDetail。

    名称 类型 描述
    Stage String 步骤
    示例值:resizeDisk
    Name String 步骤名
    示例值:扩容云盘
    IsShow Boolean 是否展示
    示例值:true
    IsSubFlow Boolean 是否子流程
    示例值:false
    SubFlowFlag String 子流程标签
    示例值:tag_test
    Status Integer 步骤运行状态:0:未开始 1:进行中 2:已完成 3:部分完成 -1:失败
    示例值:2
    Desc String 步骤运行状态描述
    示例值:已完成
    Progress Float 运行进度
    示例值:0
    Starttime Timestamp 开始时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-12-26 14:49:20
    Endtime Timestamp 结束时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2024-12-26 14:49:24
    HadWoodDetail Boolean 是否有详情信息
    示例值:false
    WoodJobId Integer Wood子流程Id
    示例值:0
    LanguageKey String 多语言版本Key
    示例值:resizeDisk
    FailedReason String 如果stage失败,失败原因
    示例值:"FailedReason"
    TimeConsuming String 步骤耗时
    示例值:耗时4秒
    Id Integer id,前端用
    示例值:1

    StarRocksQueryInfo

    StarRocks 查询信息

    被如下接口引用:DescribeStarRocksQueryInfo。

    名称 类型 描述
    ClientIP String 提交IP
    示例值:192.168.1.1
    CPUCost Integer CPU总时间(ns)
    示例值:1000000000
    DefaultDB String 默认DB
    示例值:test_db
    EndTime Integer 结束时间
    示例值:1634352000
    ExecutionIP String 执行IP
    示例值:172.0.0.1
    QueryID String 查询ID
    示例值:query_12345
    QueryType String 查询类型
    示例值:SELECT
    MemCost Integer 消耗总内存(bytes)
    示例值:1073741824
    PlanCpuCosts Integer plan阶段CPU占用(ns)
    示例值:500000000
    PlanMemCosts Integer plan阶段内存占用(bytes)
    示例值:536870912
    QueryTime Integer 执行时长
    示例值:2000000
    ResourceGroup String 资源组
    示例值:group_1
    ReturnRows Integer 获取行数
    示例值:100
    ScanBytes Integer 扫描数据量(bytes)
    示例值:2147483648
    ScanRows Integer 扫描行数
    示例值:500
    BeginTime Integer 开始时间
    示例值:1634351000
    ExecutionState String 执行状态
    示例值:FINISHED
    ExecutionStatement String 执行语句
    示例值:SELECT * FROM test_table
    User String 用户
    示例值:user_1
    ErrorCode String 错误码
    示例值:ANALYSIS_ERR

    Step

    执行步骤

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    Name String 执行步骤名称。
    示例值:step1
    ExecutionStep Execution 执行动作。
    ActionOnFailure String 执行失败策略。
    1. TERMINATE_CLUSTER 执行失败时退出并销毁集群。
    2. CONTINUE 执行失败时跳过并执行后续步骤。
    示例值:CONTINUE
    User String 指定执行Step时的用户名,非必须,默认为hadoop。
    示例值:hadoop

    StopParams

    停止服务时的参数

    被如下接口引用:StartStopServiceOrMonitor。

    名称 类型 必选 描述
    StopPolicy String 安全模式:safe
    默认模式:default
    示例值:default
    ThreadCount Integer 线程数
    示例值:12
    GraceDownTime Integer 安全停止超时时间,单位秒
    示例值:80

    StorageSummaryDistribution

    HDFS文件存储详情

    被如下接口引用:DescribeHDFSStorageInfo。

    名称 类型 必选 描述
    MetricItem String 数据项
    示例值:big_file
    MetricName String 数据项描述
    示例值:大文件
    Dps Array of Dps 采样值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{"1735550700":"39.75920104980469"}

    StrategyConfig

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

    被如下接口引用:StartStopServiceOrMonitor。

    名称 类型 必选 描述
    RollingRestartSwitch Integer 0:关闭滚动重启
    1:开启滚动启动
    示例值:0
    BatchSize Integer 滚动重启每批次的重启数量,最大重启台数为 99999 台
    示例值:1
    TimeWait Integer 滚动重启每批停止等待时间 ,最大间隔为 5 分钟 单位是秒
    示例值:5
    DealOnFail Integer 操作失败处理策略,0:失败阻塞, 1:失败自动跳过
    示例值:0
    Args Array of Arg 指令需要指定的参数
    注意:此字段可能返回 null,表示取不到有效值。

    StringMap

    通用字符串map

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Key String


    示例值:testkey
    Value String


    示例值:testval

    SubnetInfo

    子网信息

    被如下接口引用:DescribeClusterNodes, DescribeInstances。

    名称 类型 必选 描述
    SubnetName String 子网信息(名字)
    示例值:名字
    SubnetId String 子网信息(ID)
    示例值:subnet-xxx

    TableSchemaItem

    表格schema信息

    被如下接口引用:DescribeHBaseTableOverview。

    名称 类型 描述
    Name String 列标识
    示例值:GetTimeTp99
    Sortable Boolean 是否可按该列排序
    示例值:true
    WithFilter Boolean 是否可筛选
    示例值:false
    Candidates Array of String 筛选的候选集
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:slow
    Clickable Boolean 是否可点击
    示例值:false
    Title String 展示的名字
    示例值:GetTimeTp99

    Tag

    标签

    被如下接口引用:AddMetricScaleStrategy, AddNodeResourceConfig, CreateCloudInstance, CreateCluster, CreateInstance, CreateSLInstance, DescribeAutoScaleStrategies, DescribeClusterNodes, DescribeInstances, DescribeInstancesList, DescribeSLInstance, DescribeSLInstanceList, InquiryPriceScaleOutInstance, InstallSoftware, ModifyAutoScaleStrategy, ModifyResourcesTags, RunJobFlow, ScaleOutCluster, ScaleOutInstance。

    名称 类型 必选 描述
    TagKey String 标签键
    示例值:depart-xxx
    TagValue String 标签值
    示例值:Intelligent-xxx

    TagInfo

    标签信息

    被如下接口引用:DescribeNodeDataDisks。

    名称 类型 必选 描述
    Key String 标签键
    示例值:tag-key
    Value String 标签值
    示例值:tag-value

    Taint

    Kubernetes Taint

    被如下接口引用:ScaleOutInstance。

    名称 类型 必选 描述
    Key String Taint Key
    示例值:node.kubernetes.io/unschedulable
    Value String Taint Value
    示例值:true
    Effect String Taint Effect
    示例值:NoSchedule

    TaskSettings

    巡检任务参数

    被如下接口引用:ModifyInspectionSettings。

    名称 类型 必选 描述
    Name String 参数名称
    示例值:阈值
    Value String 参数值
    示例值:85
    Key String 参数唯一标记
    示例值:Threshold
    Editable String 是否可编辑,”true" "false"
    示例值:true

    TimeAutoScaleStrategy

    时间扩缩容规则

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    StrategyName String 策略名字,集群内唯一。
    示例值:dafsd
    IntervalTime Integer 策略触发后的冷却时间,该段时间内,将不能触发弹性扩缩容。
    示例值:300
    ScaleAction Integer 扩缩容动作,1表示扩容,2表示缩容。
    示例值:1
    ScaleNum Integer 扩缩容数量。
    示例值:20
    StrategyStatus Integer 规则状态,1表示有效,2表示无效,3表示暂停。必须填写
    示例值:1
    Priority Integer 规则优先级,越小越高。
    示例值:2
    RetryValidTime Integer 当多条规则同时触发,其中某些未真正执行时,在该时间范围内,将会重试。
    示例值:600
    RepeatStrategy RepeatStrategy 时间扩缩容重复策略
    注意:此字段可能返回 null,表示取不到有效值。
    StrategyId Integer 策略唯一ID。
    示例值:1
    GraceDownFlag Boolean 优雅缩容开关
    示例值:false
    GraceDownTime Integer 优雅缩容等待时间
    示例值:600
    GraceDownProtectFlag Boolean 是否开启任务保护
    示例值:true
    Tags Array of Tag 绑定标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    ConfigGroupAssigned String 预设配置组
    示例值:{"HDFS-3.2.2":-1,"TRINO-389":-1,"YARN-3.2.2":-1}
    MeasureMethod String 扩容资源计算方法,"DEFAULT","INSTANCE", "CPU", "MEMORYGB"。
    "DEFAULT"表示默认方式,与"INSTANCE"意义相同。
    "INSTANCE"表示按照节点计算,默认方式。
    "CPU"表示按照机器的核数计算。
    "MEMORYGB"表示按照机器内存数计算。
    示例值:DEFAULT
    TerminatePolicy String 销毁策略, "DEFAULT",默认销毁策略,由缩容规则触发缩容,"TIMING"表示定时销毁
    示例值:DEFAULT
    MaxUse Integer 最长使用时间, 秒数,最短1小时,最长24小时
    示例值:3600
    SoftDeployInfo Array of Integer 节点部署服务列表。部署服务仅填写HDFS、YARN。组件名对应的映射关系表
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[1,2,42]
    ServiceNodeInfo Array of Integer 启动进程列表。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[7,89]
    CompensateFlag Integer 补偿扩容,0表示不开启,1表示开启
    示例值:0
    GroupId Integer 伸缩组id
    示例值:0
    GraceDownLabel Array of TkeLabel 优雅缩容业务pod标签,当node不存在上述pod或超过优雅缩容时间时,缩容节点
    GraceDownProtectTime Integer 任务保护时间
    示例值:60

    TkeLabel

    Kubernetes Label

    被如下接口引用:AddMetricScaleStrategy, CreateDynamicInstance, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy, ModifyDynamicInstance, ScaleOutInstance。

    名称 类型 必选 描述
    Name String Label Name
    示例值:cloud.tencent.com/node-instance-id
    Value String Label Value
    示例值:ins-0dcxficf

    Toleration

    Tolerations

    被如下接口引用:CreateCloudInstance, CreateDynamicInstance, InstallSoftware, ModifyDynamicInstance。

    名称 类型 必选 描述
    Key String
    示例值:key1
    Value String
    示例值:value1
    Operator String 操作符
    示例值:Equal
    Effect String 污点排斥效果
    示例值:NoSchedule
    TolerationSeconds Integer 驱逐等待时间
    示例值:300

    TopologyInfo

    集群节点拓扑信息

    被如下接口引用:DescribeInstances。

    名称 类型 必选 描述
    ZoneId Integer 可用区ID
    示例值:100002
    Zone String 可用区信息
    示例值:"ap-guangzhou-2"
    SubnetInfoList Array of SubnetInfo 子网信息
    注意:此字段可能返回 null,表示取不到有效值。
    NodeInfoList Array of ShortNodeInfo 节点信息
    注意:此字段可能返回 null,表示取不到有效值。

    TopologySpreadConstraint

    调度拓扑分布

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    MaxSkew Integer

    最大偏差值


    示例值:1
    TopologyKey String

    拓扑域键


    示例值:topology.kubernetes.io/zone
    WhenUnsatisfiable String

    不满足约束时的处理策略


    示例值:DoNotSchedule
    LabelSelector LabelSelector

    标签选择器

    MinDomains Integer

    最小拓扑域数量


    示例值:1
    NodeAffinityPolicy String

    节点亲和性策略


    示例值:Honor
    NodeTaintsPolicy String

    节点污点策略


    示例值:Honor
    MatchLabelKeys Array of String

    匹配标签键列表


    示例值:["pod-template-hash"]

    TriggerCondition

    规则触发条件

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    CompareMethod Integer 条件比较方法,1表示大于,2表示小于,3表示大于等于,4表示小于等于。
    示例值:1
    Threshold Float 条件阈值。
    示例值:1

    TrinoQueryInfo

    trino 查询信息

    被如下接口引用:DescribeTrinoQueryInfo。

    名称 类型 描述
    Catalog String catalog
    示例值:trino
    ClientIpAddr String 提交IP
    示例值:192.168.1.1
    CompletedSplits String 切片数
    示例值:10
    CpuTime Integer CPU时间
    示例值:100
    CumulativeMemory Integer 累计内存
    示例值:2048
    DurationMillis Integer 执行时长
    示例值:1000
    EndTime Integer 结束时间 (s)
    示例值:1629379200
    Id String 查询ID
    示例值:query-12345
    InternalNetworkBytes Integer 内部传输量
    示例值:1024
    OutputBytes Integer 输出字节数
    示例值:1024
    PeakUserMemoryBytes Integer 峰值内存量
    示例值:4096
    PhysicalInputBytes Integer 物理输入量
    示例值:1024
    ProcessedInputBytes Integer 处理输入量
    示例值:1024
    SqlCompileTime Integer 编译时长
    示例值:10
    StartTime Integer 开始时间 (s)
    示例值:1629379200
    State String 执行状态
    示例值:FINISHED
    Statement String 执行语句
    示例值:SELECT * FROM my_table
    User String 提交用户
    示例值:user1
    WrittenBytes Integer 写入字节数
    示例值:1024
    ErrorMessage String Error日志

    UpdateInstanceSettings

    变配资源规格

    被如下接口引用:InquiryPriceUpdateInstance。

    名称 类型 必选 描述
    Memory Integer 内存容量,单位为G
    示例值:16
    CPUCores Integer CPU核数
    示例值:8
    ResourceId String 机器资源ID(EMR测资源标识)
    示例值:emr-vm-eqeq131
    InstanceType String 变配机器规格
    示例值:S5.2XLARGE16

    UserAndGroup

    容器集群用户组信息

    被如下接口引用:DeleteUserManagerUserList。

    名称 类型 必选 描述
    UserName String 用户名
    示例值:root
    UserGroup String 用户组
    示例值:root

    UserInfoForUserManager

    添加的用户信息列表

    被如下接口引用:AddUsersForUserManager。

    名称 类型 必选 描述
    UserName String 用户名
    示例值:user1
    UserGroup String 用户所属的组
    示例值:group1
    PassWord String 密码
    示例值:PassWord_123
    ReMark String 备注
    示例值:提交mr任务
    Groups Array of String 用户副组
    示例值:groups

    UserManagerFilter

    用户管理列表过滤器

    被如下接口引用:DescribeUsersForUserManager。

    名称 类型 必选 描述
    UserName String 用户名
    示例值:emr
    UserType String 用户来源
    示例值:自定义
    Groups String 组名
    示例值:组名

    UserManagerUserBriefInfo

    用户管理中用户的简要信息

    被如下接口引用:DescribeUsersForUserManager。

    名称 类型 描述
    UserName String 用户名
    示例值:hadoop
    UserGroup String 用户所属的组
    示例值:hadoop
    UserType String Manager表示管理员、NormalUser表示普通用户
    示例值:NormalUser
    CreateTime String 用户创建时间
    示例值:2022-04-28 18:08:28
    SupportDownLoadKeyTab Boolean 是否可以下载用户对应的keytab文件,对开启kerberos的集群才有意义
    示例值:true
    DownLoadKeyTabUrl String keytab文件的下载地址
    示例值:https://image-xxx.cos.region.xx.com/12323/someone.keytab

    VPCSettings

    VPC 参数

    被如下接口引用:CreateCloudInstance, CreateInstance, CreateSLInstance, DescribeSLInstance, DescribeSLInstanceList, InquiryPriceCreateInstance, InstallSoftware, RunJobFlow。

    名称 类型 必选 描述
    VpcId String VPC ID
    示例值:vpc-xxxxx
    SubnetId String Subnet ID
    示例值:subnet-xxxxx

    VirtualPrivateCloud

    VPC 参数

    被如下接口引用:CreateCluster。

    名称 类型 必选 描述
    VpcId String VPC ID
    示例值:vpc-xxxxx
    SubnetId String Subnet ID
    示例值:subnet-xxxxx

    VolumeMount

    挂载卷

    被如下接口引用:CreateDynamicInstance, ModifyDynamicInstance。

    名称 类型 必选 描述
    MountName String 挂载卷名称
    示例值:Cfs-1
    MountPath String 挂载路径
    示例值:/data1
    SubPathMode String 挂载类型
    示例值:subpath
    SubPath String 子路径
    示例值:/var/dev
    MountMode String 挂载模式,仅支持ReadWrite和OnlyRead
    示例值:ReadWrite

    VolumeSetting

    数据卷目录设置

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    VolumeType String 数据卷类型
  • HOST_PATH表示支持本机路径
  • NEW_PVC表示新建PVC

  • 组件角色支持的数据卷类型可参考 EMR on TKE 集群部署说明:部署说明
    示例值:NEW_PVC
    HostPath HostPathVolumeSource 主机路径信息
    注意:此字段可能返回 null,表示取不到有效值。

    WeekRepeatStrategy

    定时扩容每周重复任务策略

    被如下接口引用:AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy。

    名称 类型 必选 描述
    ExecuteAtTimeOfDay String 重复任务执行的具体时刻,例如"01:02:00"
    示例值:11:05:00
    DaysOfWeek Array of Integer 每周几的数字描述,例如,[1,3,4]表示每周周一、周三、周四。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    WeightedPodAffinityTerm

    加权pod亲和性项

    被如下接口引用:CreateCloudInstance, InstallSoftware。

    名称 类型 必选 描述
    Weight Integer

    权重


    示例值:50
    PodAffinityTerm PodAffinityTerm

    pod亲和性条件

    YarnApplication

    Yarn 运行的Application信息

    被如下接口引用:DescribeYarnApplications。

    名称 类型 描述
    Id String 应用ID
    示例值:application_1686032366242_0014
    User String 用户
    示例值:hadoop
    Name String 应用名
    示例值:HIVE-b67d086c-462b-492e-a5d1-8ecb81cea369
    Queue String 队列
    示例值:root.default
    ApplicationType String 应用类型
    示例值:TEZ
    ElapsedTime String 运行时间
    示例值:6h12min
    State String 状态
    示例值:FINISHED
    FinalStatus String 最终状态
    示例值:SUCCEEDED
    Progress Integer 进度
    示例值:100
    StartedTime Integer 开始时间毫秒
    示例值:1686101465000
    FinishedTime Integer 结束时间毫秒
    示例值:1686101465000
    AllocatedMB Integer 申请内存MB
    示例值:-1
    AllocatedVCores Integer 申请VCores
    示例值:-1
    RunningContainers Integer 运行的Containers数
    示例值:-1
    MemorySeconds Integer 内存MB*时间秒
    示例值:692611
    VCoreSeconds Integer VCores*时间秒
    示例值:338
    QueueUsagePercentage Float 队列资源占比
    示例值:0
    ClusterUsagePercentage Float 集群资源占比
    示例值:0
    PreemptedResourceMB Integer 预占用的内存
    示例值:0
    PreemptedResourceVCores Integer 预占用的VCore
    示例值:0
    NumNonAMContainerPreempted Integer 预占的非应用程序主节点容器数量
    示例值:0
    NumAMContainerPreempted Integer AM预占用的容器数量
    示例值:0
    MapsTotal Integer Map总数
    示例值:1
    MapsCompleted Integer 完成的Map数
    示例值:1
    ReducesTotal Integer Reduce总数
    示例值:0
    ReducesCompleted Integer 完成的Reduce数
    示例值:0
    AvgMapTime Integer 平均Map时间
    示例值:4437
    AvgReduceTime Integer 平均Reduce时间
    示例值:0
    AvgShuffleTime Integer 平均Shuffle时间毫秒
    示例值:0
    AvgMergeTime Integer 平均Merge时间毫秒
    示例值:0
    FailedReduceAttempts Integer 失败的Reduce执行次数
    示例值:0
    KilledReduceAttempts Integer Kill的Reduce执行次数
    示例值:0
    SuccessfulReduceAttempts Integer 成功的Reduce执行次数
    示例值:0
    FailedMapAttempts Integer 失败的Map执行次数
    示例值:0
    KilledMapAttempts Integer Kill的Map执行次数
    示例值:0
    SuccessfulMapAttempts Integer 成功的Map执行次数
    示例值:1
    GcTimeMillis Integer GC毫秒
    示例值:96
    VCoreMillisMaps Integer Map使用的VCore毫秒
    示例值:4168
    MbMillisMaps Integer Map使用的内存毫秒
    示例值:4268032
    VCoreMillisReduces Integer Reduce使用的VCore毫秒
    示例值:0
    MbMillisReduces Integer Reduce使用的内存毫秒
    示例值:0
    TotalLaunchedMaps Integer 启动Map的总数
    示例值:1
    TotalLaunchedReduces Integer 启动Reduce的总数
    示例值:0
    MapInputRecords Integer Map输入记录数
    示例值:1
    MapOutputRecords Integer Map输出记录数
    示例值:0
    ReduceInputRecords Integer Reduce输入记录数
    示例值:0
    ReduceOutputRecords Integer Reduce输出记录数
    示例值:0
    HDFSBytesWritten Integer HDFS写入字节数
    示例值:0
    HDFSBytesRead Integer HDFS读取字节数
    示例值:13986

    ZoneDetailPriceResult

    用于创建集群价格清单 不同可用区下价格详情

    被如下接口引用:InquiryPriceCreateInstance。

    名称 类型 描述
    ZoneId String 可用区Id
    示例值:100002
    NodeDetailPrice Array of NodeDetailPriceResult 不同节点的价格详情

    ZoneResourceConfiguration

    可用区配置信息

    被如下接口引用:CreateCluster。

    名称 类型 必选 描述
    VirtualPrivateCloud VirtualPrivateCloud 私有网络相关信息配置。通过该参数可以指定私有网络的ID,子网ID等信息。
    注意:此字段可能返回 null,表示取不到有效值。
    Placement Placement 实例所在的位置。通过该参数可以指定实例所属可用区,所属项目等属性。
    注意:此字段可能返回 null,表示取不到有效值。
    AllNodeResourceSpec AllNodeResourceSpec 所有节点资源的规格
    注意:此字段可能返回 null,表示取不到有效值。
    ZoneTag String 如果是单可用区,ZoneTag可以不用填, 如果是双AZ部署,第一个可用区ZoneTag选择master,第二个可用区ZoneTag选择standby,如果是三AZ部署,第一个可用区ZoneTag选择master,第二个可用区ZoneTag选择standby,第三个可用区ZoneTag选择third-party,取值范围:
  • master

  • standby

  • third-party

  • 示例值:master

    ZoneSetting

    可用区配置描述。

    被如下接口引用:CreateSLInstance, DescribeSLInstance, DescribeSLInstanceList。

    名称 类型 必选 描述
    Zone String 可用区名称
    示例值:ap-guangzhou-2
    VPCSettings VPCSettings 可用区VPC和子网
    NodeNum Integer 可用区节点数量
    示例值:3