有奖捉虫:办公协同&微信生态&物联网文档专题 HOT

AllNodeResourceSpec

资源描述

被如下接口引用:CreateCluster。

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

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
注意:此字段可能返回 null,表示取不到有效值。
Values Array of String 值列表
注意:此字段可能返回 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表示开启
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
CompensateCount Integer 补偿次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RetryCount Integer 重试次数
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
RetryInfo String 重试信息
注意:此字段可能返回 null,表示取不到有效值。
示例值:重试次数: 1, 重试结束时间: 2023-12-08 12:00:00, 重试原因: 资源不足

AutoScaleResourceConf

弹性扩缩容规格配置

被如下接口引用:DescribeAutoScaleGroupGlobalConf。

名称 类型 必选 描述
Id Integer 配置ID。
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ClusterId Integer 集群实例ID。
示例值:123
ScaleLowerBound Integer 自动扩缩容保留最小实例数。
示例值:0
ScaleUpperBound Integer 自动扩缩容最大实例数。
示例值:29
StrategyType Integer 扩容规则类型,1为按负载指标扩容规则,2为按时间扩容规则
示例值:1
NextTimeCanScale Integer 下次能可扩容时间。
注意:此字段可能返回 null,表示取不到有效值。
示例值:123
GraceDownFlag Boolean 优雅缩容开关
注意:此字段可能返回 null,表示取不到有效值。
示例值:true

BootstrapAction

引导脚本

被如下接口引用:RunJobFlow。

名称 类型 必选 描述
Path String 脚本位置,支持cos上的文件,且只支持https协议。
WhenRun String 执行时间。
resourceAfter 表示在机器资源申请成功后执行。
clusterBefore 表示在集群初始化前执行。
clusterAfter 表示在集群初始化后执行。
Args Array of String 脚本参数

COSSettings

COS 相关配置

被如下接口引用:CreateInstance。

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

CdbInfo

出参

被如下接口引用:DescribeClusterNodes。

名称 类型 描述
InstanceName String 数据库实例
注意:此字段可能返回 null,表示取不到有效值。
Ip String 数据库IP
注意:此字段可能返回 null,表示取不到有效值。
Port Integer 数据库端口
注意:此字段可能返回 null,表示取不到有效值。
MemSize Integer 数据库内存规格
注意:此字段可能返回 null,表示取不到有效值。
Volume Integer 数据库磁盘规格
注意:此字段可能返回 null,表示取不到有效值。
Service String 服务标识
注意:此字段可能返回 null,表示取不到有效值。
ExpireTime String 过期时间
注意:此字段可能返回 null,表示取不到有效值。
ApplyTime String 申请时间
注意:此字段可能返回 null,表示取不到有效值。
PayType Integer 付费类型
注意:此字段可能返回 null,表示取不到有效值。
ExpireFlag Boolean 过期标识
注意:此字段可能返回 null,表示取不到有效值。
Status Integer 数据库状态
注意:此字段可能返回 null,表示取不到有效值。
IsAutoRenew Integer 续费标识
注意:此字段可能返回 null,表示取不到有效值。
SerialNo String 数据库字符串
注意:此字段可能返回 null,表示取不到有效值。
ZoneId Integer ZoneId
注意:此字段可能返回 null,表示取不到有效值。
RegionId Integer RegionId
注意:此字段可能返回 null,表示取不到有效值。

ClusterExternalServiceInfo

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

被如下接口引用:DescribeInstances。

名称 类型 描述
DependType Integer 依赖关系,0:被其他集群依赖,1:依赖其他集群
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
Service String 共用组件
注意:此字段可能返回 null,表示取不到有效值。
示例值:zookeeper
ClusterId String 共用集群
注意:此字段可能返回 null,表示取不到有效值。
示例值:emr-123
ClusterStatus Integer 共用集群状态
注意:此字段可能返回 null,表示取不到有效值。
示例值:2

ClusterIDToFlowID

集群id与流程id的mapping

被如下接口引用:ModifyResourcesTags。

名称 类型 描述
ClusterId String 集群id
注意:此字段可能返回 null,表示取不到有效值。
FlowId Integer 流程id
注意:此字段可能返回 null,表示取不到有效值。

ClusterInstancesInfo

集群实例信息

被如下接口引用:DescribeInstances。

名称 类型 描述
Id Integer ID号
注意:此字段可能返回 null,表示取不到有效值。
示例值:13284
ClusterId String 集群ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:emr-38om728d
ClusterName String 集群名
注意:此字段可能返回 null,表示取不到有效值。
示例值:tencent_emr
RegionId Integer 地域ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:1
ZoneId Integer 地区ID
注意:此字段可能返回 null,表示取不到有效值。
示例值:10002
AppId Integer 用户APPID
注意:此字段可能返回 null,表示取不到有效值。
示例值:251112431
Uin String 用户UIN
注意:此字段可能返回 null,表示取不到有效值。
示例值:100000122121
ProjectId Integer 项目Id
注意:此字段可能返回 null,表示取不到有效值。
示例值:0
VpcId Integer 集群VPCID
注意:此字段可能返回 null,表示取不到有效值。
示例值:87821
SubnetId Integer 子网ID
注意:此字段可能返回 null,表示取不到有效值。
示例值: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:表示扩容失败。

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

    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 集群置放群组。
    CbsEncryptFlag Boolean 是否使用cbs加密。
    示例值:false
    RemoteTcpDefaultPort Boolean 是否使用远程登录,默认为false。
    示例值:false

    ComponentBasicRestartInfo

    操作的进程范围

    被如下接口引用:StartStopServiceOrMonitor。

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

    Configuration

    自定义配置参数

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    Classification String 配置文件名,支持SPARK、HIVE、HDFS、YARN的部分配置文件自定义。
    Properties String 配置参数通过KV的形式传入,部分文件支持自定义,可以通过特殊的键"content"传入所有内容。

    CustomMetaDBInfo

    用户Hive-MetaDB信息

    被如下接口引用: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。
  • UnifyMetaInstanceId String EMR-MetaDB实例

    CustomMetaInfo

    用户自建Hive-MetaDB信息

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

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

    CustomServiceDefine

    共用自建组件参数

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

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

    DayRepeatStrategy

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

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

    名称 类型 必选 描述
    ExecuteAtTimeOfDay String 重复任务执行的具体时刻,例如"01:02:00"
    注意:此字段可能返回 null,表示取不到有效值。
    Step Integer 每隔Step天执行一次
    注意:此字段可能返回 null,表示取不到有效值。

    DependService

    共用组件信息

    被如下接口引用:CreateCluster。

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

    DiskGroup

    磁盘组。

    被如下接口引用:RunJobFlow。

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

    DiskSpec

    磁盘描述。

    被如下接口引用:RunJobFlow。

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

    DiskSpecInfo

    节点磁盘信息

    被如下接口引用:ScaleOutCluster。

    名称 类型 必选 描述
    Count Integer 磁盘数量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值: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云硬盘。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:CLOUD_SSD
    DiskSize Integer 数据容量,单位为GB
    注意:此字段可能返回 null,表示取不到有效值。

    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

    EmrListInstance

    集群列表返回示例

    被如下接口引用:DescribeInstancesList。

    名称 类型 描述
    ClusterId String 集群ID
    示例值:emr-xxxx
    StatusDesc String 状态描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:状态描述
    ClusterName String 集群名字
    示例值:集群名字
    ZoneId Integer 集群地域
    示例值:集群地域
    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
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:44333
    ProjectId Integer 项目ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:4555
    RegionId Integer 区域
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:4552
    SubnetId Integer 子网ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3422
    VpcId Integer 网络ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:45666
    Zone String 地区
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:zone
    Status Integer 状态码
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    Tags Array of Tag 实例标签
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    AlarmInfo String 告警信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:告警信息
    IsWoodpeckerCluster Integer 是否是woodpecker集群
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    VpcName String Vpc中文
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:emr
    SubnetName String 子网中文
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:emr
    UniqVpcId String 字符串VpcId
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:vpc-lzd3w8jz
    UniqSubnetId String 字符串子网
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:subnet-3d73yezg
    ClusterClass String 集群类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:spark
    IsMultiZoneCluster Boolean 是否为跨AZ集群
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    IsHandsCluster Boolean 是否手戳集群
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false
    OutSideSoftInfo Array of SoftDependInfo 体外客户端组件信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:["hdfs-2.8.5",true]
    IsSupportOutsideCluster Boolean 当前集群的应用场景是否支持体外客户端
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    IsDedicatedCluster Boolean 是否专有集群场景集群
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:false

    EmrPrice

    Emr询价描述

    被如下接口引用:InquiryPriceScaleOutInstance。

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

    EmrProductConfigDetail

    EMR产品配置

    被如下接口引用:DescribeInstances。

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

    Execution

    执行动作。

    被如下接口引用:RunJobFlow。

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

    ExternalService

    共用组件信息

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

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

    Filters

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

    被如下接口引用:DescribeInstancesList。

    名称 类型 必选 描述
    Name String 字段名称
    Values Array of String 过滤字段值

    GroupGlobalConfs

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

    被如下接口引用:DescribeAutoScaleGroupGlobalConf。

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

    HiveQuery

    Hive查询详情

    被如下接口引用:DescribeHiveQueries。

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

    HostVolumeContext

    Pod HostPath挂载方式描述

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

    名称 类型 必选 描述
    VolumePath String Pod挂载宿主机的目录。资源对宿主机的挂载点,指定的挂载点对应了宿主机的路径,该挂载点在Pod中作为数据存储目录使用
    注意:此字段可能返回 null,表示取不到有效值。

    ImpalaQuery

    Impala查询详情

    被如下接口引用:DescribeImpalaQueries。

    名称 类型 描述
    Statement String 执行语句
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:show databases;
    Id String 查询ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:884c8989d757036f:ed89c04200000000
    StartTime Integer 开始时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1686101465000
    Duration String 运行时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:3s104.599ms
    EndTime Integer 结束时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1686101465000
    State String 执行状态
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:FINISHED
    RowsFetched Integer 获取行数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:592
    User String 用户
    注意:此字段可能返回 null,表示取不到有效值。
    DefaultDB String 默认DB
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Default
    Coordinator String 执行的Coordinator节点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:12.13.14.11:27002
    MaxNodePeakMemoryUsage String 单节点内存峰值
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:12.15 MB
    QueryType String 查询类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:QUERY
    ScanHDFSRows Integer 扫描的HDFS行数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ScanKUDURows Integer 扫描的Kudu行数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:599
    ScanRowsTotal Integer 扫描的总行数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:599
    TotalBytesRead Integer 读取的总字节数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    TotalBytesSent Integer 发送的总字节数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    TotalCpuTime Integer CPU总时间
    注意:此字段可能返回 null,表示取不到有效值。
    TotalInnerBytesSent Integer 内部数据发送总量(Bytes)
    注意:此字段可能返回 null,表示取不到有效值。
    TotalScanBytesSent Integer 内部扫描数据发送总量(Bytes)
    注意:此字段可能返回 null,表示取不到有效值。
    EstimatedPerHostMemBytes Integer 预估单节点内存
    注意:此字段可能返回 null,表示取不到有效值。
    NumRowsFetchedFromCache Integer 从缓存中获取的数据行数
    注意:此字段可能返回 null,表示取不到有效值。
    SessionId String 会话ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:f44f47eda7f8a920:a555717b00000000
    PerNodePeakMemoryBytesSum Integer 单节点内存峰值和(Bytes)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:4324

    InsightResult

    洞察结果项

    被如下接口引用:DescribeInsightList。

    名称 类型 必选 描述
    ID String 当Type为HIVE时,是Hive查询ID,当Type为MAPREDUCE,SPARK,TEZ时则是YarnAppID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:application_162444222_00001
    Type String 洞察应用的类型,HIVE,SPARK,MAPREDUCE,TEZ
    注意:此字段可能返回 null,表示取不到有效值。
    示例值: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
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:MAPREDUCE-MemExceeded
    RuleName String 洞察规则名字,可参考RuleID的说明
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:峰值内存超限
    RuleExplain String 洞察规则解释
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Map/Reduce实际峰值内存超过了申请的内存
    Detail String 详情
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:MAP task_1701325375205_0001_m_000000 峰值内存 724.69MB
    Suggestion String 建议信息
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:调大申请的内存或者排查是否有数据倾斜
    Value Integer 洞察异常衡量值,同类型的洞察项越大越严重,不同类型的洞察项无对比意义
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1231241
    ScheduleTaskExecID String 调度任务执行ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:flow1_task1_exec_123
    ScheduleFlowName String 调度流,DAG
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:flow1
    ScheduleTaskName String 调度flow中的某个task节点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:task1
    JobConf String Yarn任务的部分核心配置
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:{ "mapreduce.job.queuename":, "default", "mapreduce.job.user.name": "hadoop", "mapreduce.job.name": "test_name", "mapreduce.map.memory.mb": 4096, "mapreduce.reduce.memory.mb": 4096, "mapreduce.map.java.opts": "-Xmx3500g", "mapreduce.reduce.java.opts": "-Xmx3500g", "airflow.ctx.task.task_id": "123", "oozie.action.id": "abc", "azkaban.job.id": "123" }

    InstanceChargePrepaid

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

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

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

    机器资源描述。

    被如下接口引用:RunJobFlow。

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

    JobFlowResourceSpec

    流程作业资源描述

    被如下接口引用:RunJobFlow。

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

    JobResult

    任务步骤结果描述

    被如下接口引用:DescribeJobFlow。

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

    KeyValue

    键值对,主要用来做Filter

    被如下接口引用:DescribeAutoScaleRecords。

    名称 类型 必选 描述
    Key String
    注意:此字段可能返回 null,表示取不到有效值。
    Value String
    注意:此字段可能返回 null,表示取不到有效值。

    LoginSettings

    登录设置

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

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

    MetaDbInfo

    元数据库信息

    被如下接口引用:RunJobFlow。

    名称 类型 必选 描述
    MetaType String 元数据类型。
    UnifyMetaInstanceId String 统一元数据库实例ID。
    MetaDBInfo CustomMetaInfo 自建元数据库信息。

    ModifyResourceTags

    强制修改标签

    被如下接口引用:ModifyResourcesTags。

    名称 类型 必选 描述
    ResourceId String 集群id 或者 cvm id
    示例值:emr-xxxx
    Resource String 资源6段式表达式
    示例值:qcs::emr:ap-guangzhou:...
    ResourcePrefix String 资源前缀
    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"
    注意:此字段可能返回 null,表示取不到有效值。
    DaysOfMonthRange Array of Integer 每月中的天数时间段描述,长度只能为2,例如[2,10]表示每月2-10号。
    注意:此字段可能返回 null,表示取不到有效值。

    MultiDisk

    多云盘参数

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

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

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:CLOUD_SSD
    Volume Integer 云盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:20000
    Count Integer 该类型云盘个数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    MultiDiskMC

    多云盘参数

    被如下接口引用:DescribeClusterNodes。

    名称 类型 必选 描述
    Count Integer 该类型云盘个数
    注意:此字段可能返回 null,表示取不到有效值。
    Type Integer 磁盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    Volume Integer 云盘大小
    注意:此字段可能返回 null,表示取不到有效值。

    MultiZoneSetting

    各个可用区的参数信息

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

    名称 类型 必选 描述
    ZoneTag String "master"、"standby"、"third-party"
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:"master"
    VPCSettings VPCSettings
    Placement Placement
    ResourceSpec NewResourceSpec

    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

    NodeDetailPriceResult

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

    被如下接口引用:InquiryPriceCreateInstance。

    名称 类型 描述
    NodeType String 节点类型 master core task common router mysql
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:master
    PartDetailPrice Array of PartDetailPriceItem 节点组成部分价格详情

    NodeHardwareInfo

    节点硬件信息

    被如下接口引用:DescribeClusterNodes。

    名称 类型 描述
    AppId Integer 用户APPID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    SerialNo String 序列号
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    OrderNo String 机器实例ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    WanIp String master节点绑定外网IP
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Flag Integer 节点类型。0:common节点;1:master节点
    ;2:core节点;3:task节点
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Spec String 节点规格
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    CpuNum Integer 节点核数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    MemSize Integer 节点内存
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    MemDesc String 节点内存描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    RegionId Integer 节点所在region
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ZoneId Integer 节点所在Zone
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ApplyTime String 申请时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    FreeTime String 释放时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    DiskSize String 硬盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    NameTag String 节点描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Services String 节点部署服务
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    StorageType Integer 磁盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    RootSize Integer 系统盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    ChargeType Integer 付费类型
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    CdbIp String 数据库IP
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    CdbPort Integer 数据库端口
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    HwDiskSize Integer 硬盘容量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    HwDiskSizeDesc String 硬盘容量描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    HwMemSize Integer 内存容量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    HwMemSizeDesc String 内存容量描述
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    ExpireTime String 过期时间
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    EmrResourceId String 节点资源ID
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    IsAutoRenew Integer 续费标志
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    DeviceClass String 设备标识
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Mutable Integer 支持变配
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    MCMultiDisk Array of MultiDiskMC 多云盘
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    CdbNodeInfo CdbInfo 数据库信息
    注意:此字段可能返回 null,表示取不到有效值。
    Ip String 内网IP
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    Destroyable Integer 此节点是否可销毁,1可销毁,0不可销毁
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Tags Array of Tag 节点绑定的标签
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:[]
    AutoFlag Integer 是否是自动扩缩容节点,0为普通节点,1为自动扩缩容节点。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    HardwareResourceType String 资源类型, host/pod
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    IsDynamicSpec Integer 是否浮动规格,1是,0否
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    DynamicPodSpec String 浮动规格值json字符串
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    SupportModifyPayMode Integer 是否支持变更计费类型 1是,0否
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    RootStorageType Integer 系统盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    Zone String 可用区信息
    注意:此字段可能返回 null,表示取不到有效值。
    SubnetInfo SubnetInfo 子网
    注意:此字段可能返回 null,表示取不到有效值。
    Clients String 客户端
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    CurrentTime String 系统当前时间
    注意:此字段可能返回 null,表示取不到有效值。
    IsFederation Integer 是否用于联邦 ,1是,0否
    注意:此字段可能返回 null,表示取不到有效值。
    DeviceName String 设备名称
    注意:此字段可能返回 null,表示取不到有效值。
    ServiceClient String 服务
    注意:此字段可能返回 null,表示取不到有效值。
    DisableApiTermination Boolean 该实例是否开启实例保护,true为开启 false为关闭
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:true
    TradeVersion Integer 0表示老计费,1表示新计费
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    ServicesStatus String 各组件状态,Zookeeper:STARTED,ResourceManager:STARTED,STARTED已启动,STOPED已停止
    注意:此字段可能返回 null,表示取不到有效值。

    NodeResourceSpec

    资源详情

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

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

    NotRepeatStrategy

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

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

    名称 类型 必选 描述
    ExecuteAt String 该次任务执行的具体完整时间,格式为"2020-07-13 00:00:00"
    注意:此字段可能返回 null,表示取不到有效值。

    OpScope

    操作范围

    被如下接口引用:StartStopServiceOrMonitor。

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

    PartDetailPriceItem

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

    被如下接口引用:InquiryPriceCreateInstance。

    名称 类型 描述
    InstanceType String 类型包括:节点->node、系统盘->rootDisk、云数据盘->dataDisk、metaDB
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:node
    Price Float 单价(原价)
    注意:此字段可能返回 null,表示取不到有效值。
    RealCost Float 单价(折扣价)
    注意:此字段可能返回 null,表示取不到有效值。
    RealTotalCost Float 总价(折扣价)
    注意:此字段可能返回 null,表示取不到有效值。
    Policy Float 折扣
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:7.5
    GoodsNum Integer 数量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    PersistentVolumeContext

    Pod PVC存储方式描述

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

    名称 类型 必选 描述
    DiskSize Integer 磁盘大小,单位为GB。
    注意:此字段可能返回 null,表示取不到有效值。
    DiskType String 磁盘类型。CLOUD_PREMIUM;CLOUD_SSD
    注意:此字段可能返回 null,表示取不到有效值。
    DiskNum Integer 磁盘数量
    注意:此字段可能返回 null,表示取不到有效值。

    Placement

    描述集群实例位置信息

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

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

    PodNewParameter

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

    被如下接口引用:ScaleOutCluster。

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

    PodNewSpec

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

    被如下接口引用:ScaleOutCluster。

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

  • 示例值:""
    DynamicPodSpec DynamicPodSpec 浮动规格
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    VpcId String 代表vpc网络唯一id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    SubnetId String 代表vpc子网唯一id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""
    PodName String pod name
    注意:此字段可能返回 null,表示取不到有效值。

    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"。
    Cpu Integer Cpu核数。
    Memory Integer 内存数量,单位为GB。
    Number Integer 该规格资源可申请的最大数量。

    PodSpec

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

    被如下接口引用:ScaleOutInstance。

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

    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"。
    注意:此字段可能返回 null,表示取不到有效值。
    PVCVolume PersistentVolumeContext 当VolumeType为"pvc"时,该字段生效。
    注意:此字段可能返回 null,表示取不到有效值。
    HostVolume HostVolumeContext 当VolumeType为"hostpath"时,该字段生效。
    注意:此字段可能返回 null,表示取不到有效值。

    PreExecuteFileSettings

    预执行脚本配置

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

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

    PriceDetail

    价格详情

    被如下接口引用:InquiryPriceUpdateInstance。

    名称 类型 描述
    ResourceId String 节点ID
    示例值:emr-vm-xxxxxxxx
    Formula String 价格计算公式
    OriginalCost Float 原价
    示例值:4.3
    DiscountCost Float 折扣价
    示例值:3.2

    PriceResource

    询价资源

    被如下接口引用:InquiryPriceScaleOutInstance。

    名称 类型 描述
    Spec String 需要的规格
    注意:此字段可能返回 null,表示取不到有效值。
    StorageType Integer 硬盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    DiskType String 硬盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    RootSize Integer 系统盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    MemSize Integer 内存大小
    注意:此字段可能返回 null,表示取不到有效值。
    Cpu Integer 核心数量
    注意:此字段可能返回 null,表示取不到有效值。
    DiskSize Integer 硬盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    MultiDisks Array of MultiDisk 云盘列表
    注意:此字段可能返回 null,表示取不到有效值。
    DiskCnt Integer 磁盘数量
    注意:此字段可能返回 null,表示取不到有效值。
    InstanceType String 规格
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 标签
    注意:此字段可能返回 null,表示取不到有效值。
    DiskNum Integer 磁盘数量
    注意:此字段可能返回 null,表示取不到有效值。
    LocalDiskNum Integer 本地盘的数量
    注意:此字段可能返回 null,表示取不到有效值。

    QuotaEntity

    获取CVM配额

    被如下接口引用:DescribeCvmQuota。

    名称 类型 描述
    UsedQuota Integer 已使用配额
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    RemainingQuota Integer 剩余配额
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    TotalQuota Integer 总配额
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    Zone String 可用区
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:""

    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

    RepeatStrategy

    定时伸缩任务策略

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

    名称 类型 必选 描述
    RepeatType String 取值范围"DAY","DOW","DOM","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"。
    注意:此字段可能返回 null,表示取不到有效值。

    Resource

    资源详情

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

    名称 类型 必选 描述
    Spec String 节点规格描述,如CVM.SA2。
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:CVM.SA2
    StorageType Integer 存储类型
    取值范围:
  • 4:表示云SSD。
  • 5:表示高效云盘。
  • 6:表示增强型SSD云硬盘。
  • 11:表示吞吐型云硬盘。
  • 12:表示极速型SSD云硬盘。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:5
    DiskType String 磁盘类型
    取值范围:
  • CLOUD_SSD:表示云SSD。
  • CLOUD_PREMIUM:表示高效云盘。
  • CLOUD_BASIC:表示云硬盘。

  • 注意:此字段可能返回 null,表示取不到有效值。
    示例值:LOUD_PREMIUM
    MemSize Integer 内存容量,单位为M
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:131072
    Cpu Integer CPU核数
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2
    DiskSize Integer 数据盘容量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:300
    RootSize Integer 系统盘容量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:0
    MultiDisks Array of MultiDisk 云盘列表,当数据盘为一块云盘时,直接使用DiskType和DiskSize参数,超出部分使用MultiDisks
    注意:此字段可能返回 null,表示取不到有效值。
    Tags Array of Tag 需要绑定的标签列表
    注意:此字段可能返回 null,表示取不到有效值。
    InstanceType String 规格类型,如S2.MEDIUM8
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:S2.MEDIUM8
    LocalDiskNum Integer 本地盘数量,该字段已废弃
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1
    DiskNum Integer 本地盘数量,如2
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:2

    ResourceDetail

    资源详情

    被如下接口引用:DescribeInstances。

    名称 类型 描述
    Spec String 规格
    注意:此字段可能返回 null,表示取不到有效值。
    SpecName String 规格名
    注意:此字段可能返回 null,表示取不到有效值。
    StorageType Integer 硬盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    DiskType String 硬盘类型
    注意:此字段可能返回 null,表示取不到有效值。
    RootSize Integer 系统盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    MemSize Integer 内存大小
    注意:此字段可能返回 null,表示取不到有效值。
    Cpu Integer CPU个数
    注意:此字段可能返回 null,表示取不到有效值。
    DiskSize Integer 硬盘大小
    注意:此字段可能返回 null,表示取不到有效值。
    InstanceType String 规格
    注意:此字段可能返回 null,表示取不到有效值。

    ScaleOutNodeConfig

    扩容节点类型以及数量

    被如下接口引用:ScaleOutCluster。

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

  • TASK

  • CORE

  • ROUTER
  • NodeCount Integer 扩容节点数量

    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

    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:集群启动前
  • Args Array of String 执行脚本参数,参数格式请遵循标准Shell规范
    CosFileName String 脚本文件名
    Remark String 备注

    SearchItem

    搜索字段

    被如下接口引用:DescribeClusterNodes。

    名称 类型 必选 描述
    SearchType String 支持搜索的类型
    注意:此字段可能返回 null,表示取不到有效值。
    SearchValue String 支持搜索的值
    注意:此字段可能返回 null,表示取不到有效值。

    ServiceBasicRestartInfo

    操作的服务范围

    被如下接口引用:StartStopServiceOrMonitor。

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

    ShortNodeInfo

    节点信息

    被如下接口引用:DescribeInstances。

    名称 类型 必选 描述
    NodeType String 节点类型,Master/Core/Task/Router/Common
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:Master
    NodeSize Integer 节点数量
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:1

    SoftDependInfo

    体外客户端组件依赖信息

    被如下接口引用:DescribeInstancesList。

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

    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

    StrategyConfig

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

    被如下接口引用:StartStopServiceOrMonitor。

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

    SubnetInfo

    子网信息

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

    名称 类型 必选 描述
    SubnetName String 子网信息(名字)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:名字
    SubnetId String 子网信息(ID)
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:subnet-xxx

    Tag

    标签

    被如下接口引用:AddMetricScaleStrategy, CreateCluster, CreateInstance, DescribeAutoScaleStrategies, DescribeClusterNodes, DescribeInstances, DescribeInstancesList, InquiryPriceCreateInstance, InquiryPriceScaleOutInstance, ModifyAutoScaleStrategy, ModifyResourcesTags, RunJobFlow, ScaleOutCluster, ScaleOutInstance。

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

    TimeAutoScaleStrategy

    时间扩缩容规则

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

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

    TopologyInfo

    集群节点拓扑信息

    被如下接口引用:DescribeInstances。

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

    UpdateInstanceSettings

    变配资源规格

    被如下接口引用:InquiryPriceUpdateInstance。

    名称 类型 必选 描述
    Memory Integer 内存容量,单位为G
    CPUCores Integer CPU核数
    ResourceId String 机器资源ID(EMR测资源标识)
    InstanceType String 变配机器规格

    UserAndGroup

    容器集群用户组信息

    被如下接口引用:DeleteUserManagerUserList。

    名称 类型 必选 描述
    UserName String 用户名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:root
    UserGroup String 用户组
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:root

    UserInfoForUserManager

    添加的用户信息列表

    被如下接口引用:AddUsersForUserManager。

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

    UserManagerFilter

    用户管理列表过滤器

    被如下接口引用:DescribeUsersForUserManager。

    名称 类型 必选 描述
    UserName String 用户名
    注意:此字段可能返回 null,表示取不到有效值。
    示例值:emr

    UserManagerUserBriefInfo

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

    被如下接口引用:DescribeUsersForUserManager。

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

    VPCSettings

    VPC 参数

    被如下接口引用:CreateInstance, InquiryPriceCreateInstance, 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

    WeekRepeatStrategy

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

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

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

    YarnApplication

    Yarn 运行的Application信息

    被如下接口引用:DescribeYarnApplications。

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

    ZoneDetailPriceResult

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

    被如下接口引用:InquiryPriceCreateInstance。

    名称 类型 描述
    ZoneId String 可用区Id
    注意:此字段可能返回 null,表示取不到有效值。
    示例值: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

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