tencent cloud

Elastic MapReduce

  • Release Notes and Announcements
  • Product Introduction
  • Purchase Guide
    • EMR on CVM Billing Instructions
    • EMR on TKE Billing Instructions
    • EMR Serverless HBase Billing Instructions
    • EMR Serverless TCBase Billing Overview
  • Getting Started
  • EMR on CVM Operation Guide
    • Planning Cluster
    • Administrative rights
    • Configuring Cluster
    • Managing Cluster
    • Managing Service
    • Monitoring and Alarms
    • TCInsight
  • EMR on TKE Operation Guide
  • EMR Serverless HBase Operation Guide
  • EMR Serverless TCBase Operation Guide
  • EMR Development Guide
    • Hadoop Development Guide
    • Spark Development Guide
    • HBase Development Guide
    • Phoenix on Hbase Development Guide
    • Hive Development Guide
    • Presto Development Guide
    • Sqoop Development Guide
    • Hue Development Guide
    • Oozie Development Guide
    • Flume Development Guide
    • Kerberos Development Guide
    • Knox Development Guide
    • Alluxio Development Guide
    • Kylin Development Guide
    • Livy Development Guide
    • Kyuubi Development Guide
    • Zeppelin Development Guide
    • Hudi Development Guide
    • Superset Development Guide
    • Impala Development Guide
    • Druid Development Guide
    • TensorFlow Development Guide
    • Kudu Development Guide
    • Ranger Development Guide
    • Kafka Development Guide
    • StarRocks Development Guide
    • Flink Development Guide
    • JupyterLab Development Guide
    • MLflow Development Guide
  • Practical Tutorial
    • Practice of EMR on CVM Ops
    • Data Migration
    • Practical Tutorial on Custom Scaling
  • API Documentation
    • History
    • Introduction
    • API Category
    • Making API Requests
    • Cluster Resource Management APIs
    • Cluster Service APIs
    • User Management APIs
    • Information Query APIs
    • Information Query APIs
    • Scaling APIs
    • Configuration APIs
    • Other APIs
    • Cluster Lifecycle APIs
    • Serverless HBase APIs
    • YARN Resource Scheduling APIs
    • Data Types
    • Error Codes
  • FAQs
    • EMR on CVM
  • Service Level Agreement
  • Contact Us
DokumentasiElastic MapReduceAPI DocumentationData Types

Data Types

Unduh
Mode fokus
Ukuran font
Terakhir diperbarui: 2026-10-10 14:59:24

AllNodeResourceSpec

Resource description.

Used by actions: CreateCluster.

Name Type Required Description
MasterResourceSpec NodeResourceSpec No Description of Master node resources.
CoreResourceSpec NodeResourceSpec No Description of Core node resources.
TaskResourceSpec NodeResourceSpec No Description of Task node resources.
CommonResourceSpec NodeResourceSpec No Description of Common node resources.
MasterCount Integer No Number of Master nodes.
CoreCount Integer No Number of Core nodes.
TaskCount Integer No Number of Task nodes.
CommonCount Integer No Number of Common nodes.

ApplicationStatics

YARN application statistics information.

Used by actions: DescribeEmrApplicationStatics.

Name Type Description
Queue String Queue name.
User String Username.
ApplicationType String Job type.
SumMemorySeconds Integer Meaning of SumMemorySeconds.
SumVCoreSeconds Integer Meaning of SumVCoreSeconds.
SumHDFSBytesWritten String SumHDFSBytesWritten (with the unit).
SumHDFSBytesRead String SumHDFSBytesRead (with the unit).
CountApps Integer Number of jobs.

ArchitectureInfo

Architecture information.

Used by actions: DescribeNodeSpec.

Name Type Description
Architecture String

Architecture type.
ArchitectureName String

Architecture type name.
Order Integer

Architecture type display order.
InstanceFamilies Array of String

Instance specification families included in the architecture.

Arg

General parameters.

Used by actions: StartStopServiceOrMonitor.

Name Type Required Description
Key String No key
Values Array of String No Value list.

AutoScaleGroupAdvanceAttrs

Advanced settings of the auto-scaling group.

Used by actions: DescribeAutoScaleGroupGlobalConf.

Name Type Required Description
ComputeResourceAdvanceParams ComputeResourceAdvanceParams No Advanced settings of computing resources.

AutoScaleRecord

Auto scaling record.

Used by actions: DescribeAutoScaleRecords.

Name Type Description
StrategyName String

Scaling rule name.
ScaleAction String

"SCALE_OUT" and "SCALE_IN", indicating scale-out and scale-in, respectively.
ActionStatus String

The value is "SUCCESS", "FAILED", "PART_SUCCESS", or "IN_PROCESS", indicating success, failure, partial success, and in-process, respectively.
ActionTime String

Flow trigger time.
ScaleInfo String

Scaling-related description.
ExpectScaleNum Integer

Valid only when ScaleAction is SCALE_OUT.
EndTime String

Flow end time.
StrategyType Integer

Policy type. Load-based scaling or time-based scaling. 1 indicates load-based scaling, and 2 indicates time-based scaling.
SpecInfo String

Specifications information used during scale-out.
CompensateFlag Integer

Compensatory scale-out. Valid values: 0 (disable) and 1 (enable).
CompensateCount Integer

Number of compensations.
RetryCount Integer

Number of retries.
RetryInfo String

Retry information.
RetryEnReason String

Retry description in English.
RetryReason String

Retry description.
ShortageClass Integer

Missing category.

AutoScaleResourceConf

Auto scaling specification configuration.

Used by actions: DescribeAutoScaleGroupGlobalConf.

Name Type Required Description
Id Integer No

Configuration ID.
ClusterId Integer No

Cluster ID.
ScaleLowerBound Integer No

Minimum number of reserved instances for auto scaling.
ScaleUpperBound Integer No

Maximum number of instances for auto scaling.
StrategyType Integer No

Scale-out rule type. Valid values: 1 (scale-out rule by load metrics) and 2 (scale-out rule by time).
NextTimeCanScale Integer No

Next scale-out time.
GraceDownFlag Boolean No

Graceful scale-in switch.
HardwareType String No

"CVM" indicates that all specifications use CVM-related types, and "POD" indicates that specifications use container-related types. The default value is "CVM".
PayMode String No

"POSTPAY" indicates that only pay-as-you-go billing is used. "SPOT_FIRST" indicates that spot instances are preferred, which is supported only when HardwareType is "HOST". "POD" only supports pure pay-as-you-go billing.
PostPayPercentMin Integer No

Minimum percentage of pay-as-you-go resources in the scenario where spot instances are preferred. It is an integer.
ChangeToPod Integer No

When the preset resource type is HOST, you can select "switch to POD when resources are insufficient" or clear the selection. 0 indicates that it is not selected by default (0), and 1 indicates that it is selected.
GroupName String No

Scaling group name.
YarnNodeLabel String No

Tag.
WarehouseName String No

Corresponding computing group.
GroupStatus Integer No

Scaling group status.
Parallel Integer No

Parallel scaling. Valid values: 0 (disabled) and 1 (enabled).
EnableMNode Integer No

Whether MNode is supported.
ExtraAdvanceAttrs AutoScaleGroupAdvanceAttrs No

More scaling group settings.
CustomNodeName String No

Custom hostname.

CBSInstance

CBS instance information.

Used by actions: DescribeNodeDataDisks.

Name Type Description
DiskId String Cloud disk ID.
DiskUsage String Cloud disk type.
DiskName String Cloud disk name.
DiskSize Integer Cloud disk size.
DiskType String Cloud disk media type.
DeleteWithInstance Boolean Whether to delete it with the instance.
DiskChargeType String Cloud disk billing mode.
DiskState String Cloud disk running status.
RenewFlag String Whether to perform auto-renewal.
DeadlineTime String Expiration time.
Attached Boolean Whether the cloud disk is mounted on the CVM.
DifferDaysOfDeadline Integer Days remaining until disk expiration.
InstanceIdList Array of String ID of the CVM instance to which this cloud disk is currently mounted.
InstanceId String ID of the CVM to which the cloud disk is mounted.
Shareable Boolean Whether the cloud disk is a shared cloud disk.
EmrResourceId String EMR node ID.
UnderwriteExpiredTime String Committed use expiration time.
Tags Array of TagInfo Tag.
ThroughputPerformance Integer Cloud disk additional performance value. Unit: MB/s.

CBSVolume

CBS storage volume.

Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

Name Type Required Description
VolumeName String No Storage volume name.
DiskType String No CBS disk type.
DiskSize Integer No CBS disk size (GB).
DiskCount Integer No Number of CBS disks.

CFSTurboVolume

CFS Turbo storage volume.

Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

Name Type Required Description
VolumeName String No

Storage volume name.
FileSystemId String No

File system ID.
FSId String No

CFSId
Host String No

Mount point IP address.
SubPath String No

CFS subdirectory.
RootDir String No

Lustre mount root directory. The default value is /cfs.

CFSVolume

CFS volume.

Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

Name Type Required Description
VolumeName String No Storage volume name.
FileSystemId String No File system ID.
FSId String No CFSId
Host String No Mount point IP address.
SubPath String No CFS subdirectory.

CLBSetting

CLB settings for container cluster Pod service.

Used by actions: InstallSoftware.

Name Type Required Description
CLBType String No CLB type. Valid values: PUBLIC_IP (supports public network CLB) and INTERNAL_IP (supports private network CLB).
VPCSettings VPCSettings No Settings for VPC and subnet information.

COSSettings

COS related configuration.

Used by actions: CreateInstance.

Name Type Required Description
CosSecretId String Yes COS SecretId
CosSecretKey String Yes COS SecrectKey
LogOnCosPath String No Log storage path on COS.

COSVolume

COS storage volume.

Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

Name Type Required Description
VolumeName String No Storage volume name.
Secret String No Secret name.
Region String No Region where the COS bucket is located.
Bucket String No Bucket name.
SubPath String No COS subdirectory.

CapacityGlobalConfig

Global configuration of the capacity scheduler in resource scheduling.

Used by actions: DescribeGlobalConfig.

Name Type Description
EnableLabel Boolean Whether label-based scheduling is enabled.
LabelDir String Path where the label information is stored if label-based scheduling is enabled.
QueueMappingOverride Boolean Whether to overwrite the user-specified queue. true indicates overwriting.
DefaultSettings Array of DefaultSetting Advanced settings.

CdbInfo

Response parameter.

Used by actions: DescribeClusterNodes.

Name Type Description
InstanceName String Database instance.
Ip String Database IP address.
Port Integer Database port.
MemSize Integer Database memory specifications.
Volume Integer Database disk specifications.
Service String Service flag.
ExpireTime String Expiration time.
ApplyTime String Application time.
PayType Integer Payment type.
ExpireFlag Boolean Expiration flag.
Status Integer Database status.
IsAutoRenew Integer Renewal flag.
SerialNo String Database string.
ZoneId Integer ZoneId
RegionId Integer RegionId

CloudResource

Information about request resources of the container cluster Pod.

Used by actions: InstallSoftware.

Name Type Required Description
ComponentName String Yes

Component role name.
PodNumber Integer Yes

Number of Pod requests.
LimitCpu Integer Yes

Maximum number of CPU requests.
LimitMemory Integer Yes

Maximum number of memory requests.
Service String No

Service name, for example, HIVE.
VolumeDir VolumeSetting No

Data volume directory settings.
ExternalAccess ExternalAccess No

External access settings for the component.
Affinity NodeAffinity No

Node affinity settings.
Disks Array of Disk No

Selected data disk information.
Tolerations Array of Toleration No

Toleration.
PodAffinity PodAffinitySpec No

Pod affinity.
PodAntiAffinity PodAffinitySpec No

Pod anti-affinity.
TopologySpreadConstraints Array of TopologySpreadConstraint No

Topology distribution constraint.
PodLabels Array of StringMap No

Pod tag.
EnableDefaultRayCluster Boolean No

Whether the default Ray cluster is created.
ImageInfoV2 ImageInfoV2 No

Custom image.
DynamicInstanceForm DynamicInstanceForm No

Specifies the dynamic instance parameter to be created.

ClusterExternalServiceInfo

Mapping between the current cluster and the shared component.

Used by actions: DescribeInstances.

Name Type Description
DependType Integer Dependency relationship. Valid values: 0 (being depended on by other clusters) and 1 (depending on other clusters).
Service String Shared component.
ClusterId String Shared cluster.
ClusterStatus Integer Shared cluster status.

ClusterIDToFlowID

Mapping between the cluster ID and flow ID.

Used by actions: ModifyResourcesTags.

Name Type Description
ClusterId String Cluster ID.
FlowId Integer Flow ID.

ClusterInstancesInfo

Cluster information.

Used by actions: DescribeInstances.

Name Type Description
Id Integer

ID.
ClusterId String

Cluster ID.
ClusterName String

Cluster name.
RegionId Integer

Region ID.
ZoneId Integer

Region ID.
AppId Integer

User APPID.
Uin String

User UIN.
ProjectId Integer

Project ID.
VpcId Integer

Cluster VPC ID.
SubnetId Integer

Subnet ID.
Status Integer

Status code of the instance. Valid values:

  • 2: The cluster is running.
  • 3: The cluster is being created.
  • 4: The cluster is being scaled out.
  • 5: Router nodes are being added to the cluster.
  • 6: Components are being installed in the cluster.
  • 7: The cluster is executing a command.
  • 8: The service is being restarted.
  • 9: The cluster is entering maintenance.
  • 10: The service is being paused.
  • 11: The cluster is exiting maintenance.
  • 12: The cluster is exiting the pause status.
  • 13: The configuration is being delivered.
  • 14: The cluster is being terminated.
  • 15: Core nodes are being terminated.
  • 16: Task nodes are being terminated.
  • 17: Router nodes are being terminated.
  • 18: The webproxy password is being changed.
  • 19: The cluster is being isolated.
  • 20: The cluster is being reconciled.
  • 21: The cluster is being reclaimed.
  • 22: The configuration change is waiting.
  • 23: The cluster has been isolated.
  • 24: Nodes are being scaled in.
  • 33: The cluster is waiting for a refund.
  • 34: The cluster has been refunded.
  • 301: Creation failed.
  • 302: Scale-out failed.
    		•
    AddTime String

    Addition time.
    RunTime String

    Execution duration.
    MasterIp String

    Public IP address of the Master node.
    EmrVersion String

    EMR version.
    ChargeType Integer

    Billing mode.
    TradeVersion Integer

    Transaction version.
    ResourceOrderId Integer

    Resource order ID.
    IsTradeCluster Integer

    Whether it is a billable cluster.
    AlarmInfo String

    Cluster error status alarm information.
    IsWoodpeckerCluster Integer

    Whether a new architecture is used.
    MetaDb String

    Meta database information.
    Tags Array of Tag

    Tag information.
    HiveMetaDb String

    Hive metadata information.
    ServiceClass String

    Cluster type. Valid values: EMR, CLICKHOUSE, and DRUID.
    AliasInfo String

    Serialization of the aliases of all nodes in the cluster.
    ProductId Integer

    Cluster version ID.
    Zone String

    Region ID.
    SceneName String

    Scenario name.
    SceneServiceClass String

    Scenario-based cluster type.
    SceneEmrVersion String

    Scenario-based EMR version.
    DisplayName String

    Scenario-based cluster type.
    VpcName String

    vpc name
    SubnetName String

    subnet name
    ClusterExternalServiceInfo Array of ClusterExternalServiceInfo

    Cluster dependency.
    UniqVpcId String

    Cluster VPC ID, string type.
    UniqSubnetId String

    Subnet ID, string type.
    TopologyInfoList Array of TopologyInfo

    Node information.
    IsMultiZoneCluster Boolean

    Whether it is a cross-AZ cluster.
    IsCvmReplace Boolean

    Whether automatic compensation for abnormal nodes is enabled.
    ClusterTitle String

    Title.
    ConfigDetail EmrProductConfigDetail

    Cluster product configuration information.
    BindFileSystemNum Integer

    Number of file systems bound to the cluster.
    ClusterRelationInfoList Array of ClusterRelationMeta

    Binding list of the RSS cluster.
    RedisId String

    Redis information.
    IsIOHungSelfRecovery Boolean

    Whether IO fault self-healing is enabled.
    MetaDBGroupInfo Array of CustomMetaDBInfo

    Metadata information.

    ClusterRelationMeta

    Binding usage information between clusters.

    Used by actions: DescribeInstances.

    Name Type Required Description
    ClusterType String No Cluster type.
    ClusterIdList Array of String No List of cluster IDs.

    ComponentBasicRestartInfo

    Operation process scope.

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    ComponentName String No (Required) Process name, for example, NameNode.
    IpList Array of String No List of operation IP addresses.

    ComponentDeployInfo

    Deployment information of the role.

    Used by actions: InstallSoftware.

    Name Type Required Description
    ComponentName String No Role name.
    DeployHostUuidList Array of String No List of UUIDs of nodes to be installed.

    ComputeResourceAdvanceParams

    Advanced settings of computing resources.

    Used by actions: DescribeAutoScaleGroupGlobalConf, ScaleOutInstance.

    Name Type Required Description
    Labels Array of TkeLabel No

    Node Label array.
    Taints Array of Taint No

    Node taint.
    PreStartUserScript String No

    Base64-encoded user script, which is executed before node initialization.
    UserScript String No

    Base64-encoded user script, which is executed after the Kubernetes component starts. You need to guarantee the script reentrancy and retry logic. The script and generated log files can be viewed in the /data/ccs_userscript/ directory on the node.
    TkeClusterNodePool String No

    Node group ID.
    NodePoolJoinMode String No

    Mode of joining a node pool.

    Enumeration values:

    • Inherit: inherits the configuration from the node pool.
    • OnlyJoin: joins the node pool only without inheriting the configuration.

    Default value: Inherit.

    ConfSubContext

    Used by actions: ModifyServiceParamsByExportConfs.

    Name Type Required Description
    FileName String Yes
    Params String Yes

    ConfigModifyInfoV2

    Queue modification information in resource scheduling.

    Used by actions: ModifyYarnQueueV2.

    Name Type Required Description
    OpType Integer Yes Operation type. Valid values:

    0: Create a queue.
    1: Edit - fully overwrite a queue.
    2: Create a subqueue.
    3: Delete a queue.
    4: Clone a queue. This is the same as creating a subqueue. Specifically, for fair, a subqueue can be copied to a new queue.
    6: Edit - incrementally update a queue.
    Name String No Queue name. It cannot be modified.
    ParentId String No Create the root queue: pass "myId of root". Create a subqueue: pass "myId of the selected queue". Clone a queue: pass "parentId of the selected queue".
    MyId String No Edit or delete operations: pass "myId of the selected queue". Passing is required for cloning only when the scheduler is fair in order to copy a subqueue to a new queue.
    BasicParams ItemSeq No Basic configuration information. The value of key is consistent with the field returned by DescribeYarnQueue.
    ###### Fair scheduler.
    The key value information is as follows:

    - type: parent queue. The value is parent or null.
    - aclSubmitApps: submit access control. The value is a JSON string of the AclForYarnQueue type or null.
    - aclAdministerApps: administer access control. The value is a JSON string of the AclForYarnQueue type or null.
    - minSharePreemptionTimeout: minimum share preemption timeout. The value is a numeric string or null.
    - fairSharePreemptionTimeout: fair share preemption timeout. The value is a numeric string or null.
    - fairSharePreemptionThreshold: fair share preemption threshold. The value is a numeric string or null, where the numeric range is (0, 1].
    - allowPreemptionFrom: preemption mode. The value is a boolean string or null.
    - schedulingPolicy: scheduling policy. The value is drf, fair, fifo, or null.

    <br/>type AclForYarnQueue struct {<br/> User *string `json:"user"` // Username<br/> Group *string `json:"group"`// Group name<br/>}<br/>

    ###### Capacity scheduler.
    The key value information is as follows:

    - state: queue status. The value is STOPPED or RUNNING.
    - default-node-label-expression: default label expression. The value is a label or null.
    - acl_submit_applications: submit access control. The value is a JSON string of the AclForYarnQueue type or null.
    - acl_administer_queue: administer access control. The value is a JSON string of the AclForYarnQueue type or null.
    - maximum-allocation-mb: maximum memory allocated to a container. The value is a numeric string or null.
    - maximum-allocation-vcores: maximum number of vCores allocated to a container. The value is a numeric string or null.

    <br/>type AclForYarnQueue struct {<br/> User *string `json:"user"` // Username<br/> Group *string `json:"group"`// Group name<br/>}<br/>
    ConfigSetParams Array of ConfigSetInfo No Configuration set information. For the value, see the parameter description of this complex type. A configuration set is the representation of the plan mode in a queue, indicating different configuration values in different time periods. All queues have the same configuration set name. For a single queue, the labels and parameters in each configuration set are the same, but the parameter values differ.
    DeleteLables Array of String No Specific to the capacity scheduler. It takes effect only when OpType is 6 and indicates which labels in this queue are to be deleted. Its priority is higher than that of LabelParams in ConfigSetParams.

    ConfigSetInfo

    Configuration set information in resource scheduling.

    Used by actions: ModifyYarnQueueV2.

    Name Type Required Description
    ConfigSet String Yes Configuration set name.
    LabelParams Array of ItemSeq No The capacity scheduler uses it to configure label-related settings. The value of key is consistent with the field returned by DescribeYarnQueue.
    The key value information is as follows:
    - labelName: label name, which is the label in label management.
    - capacity: capacity. The value is a numeric string.
    - maximum-capacity: maximum capacity. The value is a numeric string.
    BasicParams Array of Item No Sets the parameters related to the configuration set. The value of key is consistent with the field returned by DescribeYarnQueue.
    ###### Fair scheduler.
    The key value information is as follows:
    - minResources: minimum resource amount. The value is a JSON string of the YarnResource type or null.
    - maxResources: maximum resource amount. The value is a JSON string of the YarnResource type or null.
    - maxChildResources: maximum resource amount that can be allocated to undeclared subqueues. The value is a numeric string or null.
    - maxRunningApps: maximum number of apps that can run simultaneously. The value is a numeric string or null.
    - weight: weight. The value is a numeric string or null.
    - maxAMShare: maximum share of the App Master. The value is a numeric string or null, where the numeric range is [0, 1] or -1.

    <br/>type YarnResource struct {<br/> Vcores *int `json:"vcores"`<br/> Memory *int `json:"memory"`<br/> Type *string `json:"type"` // The value is `percent` or `null`. When the value is `percent`, it indicates the percentage used; otherwise, it is the absolute value used. Only maxResources and maxChildResources can be set to `percent`.<br/>}<br/>


    ###### Capacity scheduler.
    The key value information is as follows:
    - minimum-user-limit-percent: minimum user capacity. The value is a JSON string of the YarnResource type or null, where the numeric range is [0, 100].
    - user-limit-factor: user resource factor. The value is a JSON string of the YarnResource type or null.
    - maximum-applications: maximum number of applications (Max-Applications). The value is a numeric string or null, where the number is a positive integer.
    - maximum-am-resource-percent: maximum AM ratio. The value is a numeric string or null, where the numeric range is [0, 1] or -1.
    - default-application-priority: resource pool priority. The value is a numeric string or null, where the number is a positive integer.

    ConfigurationItem

    Configuration item (configuration management page).

    Used by actions: DescribeServiceConfGroupInfos.

    Name Type Required Description
    Name String Yes Configuration item name.
    Value String Yes Configuration item value.
    InFile String No Name of the configuration file where the configuration items are located.

    ContainerExtraConf

    Additional container configuration.

    Used by actions: InstallSoftware.

    Name Type Required Description
    JobAccessProxyType String No

    Proxy access type for computing jobs, such as Spark jobs and the RayCluster UI. If not specified, Internal is used by default.

    Enumeration values:

    • Internal: access through the private network LB proxy.
    • Public: access through the public network LB proxy.
    • None: No LB proxy access is created.

    CustomImage

    Custom image information.

    Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    ImageSourceType String No Image source. Valid values: tcr (public image), ccrPersonal (custom image), and ccrAllPersonal (shared image).
    ImageInfo ImageInfo No Image information.
    ImagePullSecret ImagePullSecret No Key used for obtaining an image.

    CustomMetaDBInfo

    User-defined database information.

    Used by actions: CreateCluster, DescribeInstances, DescribeMetaDBInfo, InquiryPriceCreateInstance, InstallSoftware.

    Name Type Required Description
    MetaDataJdbcUrl String No

    Custom MetaDB JDBC connection, for example: jdbc:mysql://10.10.10.10:3306/dbname.
    MetaDataUser String No

    Custom MetaDB username.
    MetaDataPass String No

    Custom MetaDB password.
    MetaType String No

    Hive shared metadata database type. Valid values:

  • EMR_DEFAULT_META: created by the cluster by default
  • EMR_EXIST_META: EMR-MetaDB specified by the cluster
  • USER_CUSTOM_META: custom MetaDB used by the cluster
    		•
    UnifyMetaInstanceId String No

    EMR-MetaDB instance.
    Components Array of String No

    Component.
    DefaultMetaVersion String No

    MetaDB version.
    LinkInstanceId String No

    CDBId

    CustomMetaInfo

    User-built Hive-MetaDB information.

    Used by actions: CreateInstance, InquiryPriceCreateInstance, InstallSoftware.

    Name Type Required Description
    MetaDataJdbcUrl String No Custom MetaDB JDBC connection, which starts with jdbc:mysql://.
    MetaDataUser String No Custom MetaDB username.
    MetaDataPass String No Custom MetaDB password.

    CustomServiceDefine

    Shared self-built component parameters.

    Used by actions: CreateInstance, InquiryPriceCreateInstance, InstallSoftware.

    Name Type Required Description
    Name String No Custom parameter key.
    Value String No Custom parameter value.

    DAGInfo

    DAG information.

    Used by actions: DescribeDAGInfo.

    Name Type Required Description
    ID String No Query ID.
    Type String No DAG type. Only StarRocks is supported currently.
    Content String No Returned JSON string of the DAG.

    DayRepeatStrategy

    Description of daily repetition tasks for auto scaling.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAtTimeOfDay String Yes Specific time for repetition task execution, for example, 01:02:00.
    Step Integer Yes Execute every Step days.

    DefaultSetting

    Default settings of resource scheduling.

    Used by actions: DescribeGlobalConfig.

    Name Type Description
    Name String Name, which is used as the key for request parameters.
    Desc String Description.
    Prompt String Prompt.
    Key String Key, which is used to display the configuration items in the configuration file.
    Value String Name value.

    DependService

    Shared component information.

    Used by actions: CreateCluster, CreateDynamicInstance, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    ServiceName String Yes Shared component name.
    InstanceId String Yes Shared component cluster.

    DescribeBootScriptRsp

    Bootstrap script response package.

    Used by actions: DescribeBootScript.

    Name Type Description
    ResourceAfter Array of PreExecuteFileSetting Custom script file when resource initialization ends.
    ClusterBefore Array of PreExecuteFileSetting Custom script file before cluster startup.
    ClusterAfter Array of PreExecuteFileSetting Custom script file after cluster startup.
    ServiceBefore Array of PreExecuteFileSetting Custom script before service decommissioning.

    DescribeNodeSpec

    Node specifications.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    NodeType String Yes Node type.
    NodeName String Yes Node type name.
    Types Array of NodeSpecType No Types array.
    CmnTypes Array of NodeSpecType No List of cloud-hosted node instance specifications.

    DescribeResourceConfig

    Response parameters of the DescribeResourceConfig API.

    Used by actions: DescribeNodeResourceConfigFast.

    Name Type Description
    ResourceType String Specification management type.
    ResourceData Array of NodeResource Specification management data.

    DiffDetail

    Dynamically generated change details.

    Used by actions: DescribeResourceScheduleDiffDetail.

    Name Type Description
    Name String Tab page header.
    Count Integer Number of change items.
    Rows Array of DiffDetailItem Detailed data to be rendered.
    Header Array of DiffHeader Header information to be rendered.

    DiffDetailItem

    Dynamically generated change detailed items.

    Used by actions: DescribeResourceScheduleDiffDetail.

    Name Type Description
    Attribute String Attribute.
    InEffect String Effective item.
    PendingEffectiveness String Pending effective.
    Operation String Operation.
    Queue String Queue.
    ConfigSet String Configuration set.
    LabelName String Tag.
    InEffectIndex String Current position.
    PendingEffectIndex String Position to be effective.
    PlanName String Plan mode name.
    Label String Tag.
    RuleName String Placement rule.
    UserName String Username.

    DiffHeader

    Dynamically generated change details.

    Used by actions: DescribeResourceScheduleDiffDetail.

    Name Type Description
    Name String Name.
    Id String ID, which is used by the frontend.

    Disk

    Disk information.

    Used by actions: InstallSoftware.

    Name Type Required Description
    DiskType String No Data disk type, which is available when an EMR container cluster is created. Valid values:
  • CLOUD_SSD: SSD Cloud Disk
  • CLOUD_PREMIUM: Premium Disk
    		•
    DiskCapacity Integer No Single block size (GB).
    DiskNumber Integer No Number of data disks.

    DiskHealthIssue

    Disk.

    Used by actions: DescribeClusterNodes.

    Name Type Description
    DiskId String

    Disk ID.
    MountDir String

    Mounted directory.
    DeviceName String

    Device path.
    CheckType Integer

    Exception type.
    Severity Integer

    Priority.
    State Integer

    Status.
    DetectSource String

    Probe source.
    FirstDetectTime String

    First probe time.
    LastDetectTime String

    Latest probe time.
    DetectDetail String

    Probe information.

    DiskSpecInfo

    Node disk information.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    Count Integer Yes Number of disks.
    DiskType String Yes System disk type. Valid values:
  • CLOUD_SSD: Cloud SSD
  • CLOUD_PREMIUM: Premium Disk
  • CLOUD_BASIC: Cloud Basic Disk
  • LOCAL_BASIC: Local Basic Disk
  • LOCAL_SSD: Local SSD


    • Data disk type. Valid values:
  • CLOUD_SSD: Cloud SSD
  • CLOUD_PREMIUM: Premium Disk
  • CLOUD_BASIC: Cloud Basic Disk
  • LOCAL_BASIC: Local Basic Disk
  • LOCAL_SSD: Local SSD


  • CLOUD_HSSD: Enhanced SSD
  • CLOUD_THROUGHPUT: Throughput-Optimized Cloud Disk
  • CLOUD_TSSD: Tremendous SSD
  • CLOUD_BIGDATA: Big Data Cloud Disk
  • CLOUD_HIGHIO: High-IO Cloud Disk
  • CLOUD_BSSD: Balanced SSD
  • REMOTE_SSD: Remote SSD Disk

    		•
    DiskSize Integer Yes Data capacity (GB).
    ExtraPerformance Integer No Additional performance.

    Dps

    Sampling sequence.

    Used by actions: DescribeHDFSStorageInfo.

    Name Type Required Description
    Timestamp String No Timestamp.
    Value String No Sampling value.

    DynamicInstanceForm

    Form data submitted when creating a DynamicInstance.

    Used by actions: CreateDynamicInstance, InstallSoftware.

    Name Type Required Description
    DynamicInstanceName String No

    DynamicInstance name. The length is limited to 1–64 characters and can only contain lowercase letters.
    Namespace String No

    Namespace.
    SupportHA Boolean No

    Whether high availability is supported.
    CustomImage CustomImage No

    Custom image information.
    DynamicInstanceGroups Array of DynamicInstanceGroup No

    Resource group configuration.
    SupportPV Boolean No

    Whether to support storage configuration.
    CBSVolumes Array of CBSVolume No

    CBS storage volume list.
    CFSVolumes Array of CFSVolume No

    CFS storage volume list, including only CFS but not CFS Turbo.
    COSVolumes Array of COSVolume No

    COS storage volume list.
    VolumeMounts Array of VolumeMount No

    Mount volume list.
    Labels Array of TkeLabel No

    Pod label.
    Tolerations Array of Toleration No

    Tolerations definition.
    Envs Array of NameValue No

    Environment variable.
    DependServices Array of DependService No

    Dependent external components.
    SupportToken Boolean No

    Whether to enable token authentication.
    CFSTurboVolumes Array of CFSTurboVolume No

    CFS Turbo mount list, excluding the standard edition CFS.
    ImageInfoV2 ImageInfoV2 No

    Custom image.
    GooseFSVolumes Array of GooseFSVolume No

    GooseFS disk.
    EnableHistoryServer Boolean No

    Enable HistoryServer.

    DynamicInstanceGroup

    Group part in the form data submitted when creating a DynamicInstance.

    Used by actions: CreateDynamicInstance, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    GroupType String No

    Resource group type.
    GroupName String No

    Resource group name.
    PodCpu Integer No

    Number of Pod CPU cores.
    PodMem Integer No

    Pod memory size (GB).
    PodGpuType String No

    Pod GPU type.
    PodGpu Integer No

    Number of Pod GPUs.
    PodNum Integer No

    Number of Pods.
    MinPodNum Integer No

    Minimum number of elastic Pods.
    MaxPodNum Integer No

    Maximum number of elastic Pods. When MaxPodNum > MinPodNum, auto scaling is enabled by default and scaling is performed within the range.
    SupportPV Boolean No

    Whether to support storage configuration.
    CBSVolumes Array of CBSVolume No

    CBS storage volume list.
    CFSVolumes Array of CFSVolume No

    CFS storage volume list.
    COSVolumes Array of COSVolume No

    COS storage volume list.
    VolumeMounts Array of VolumeMount No

    Mount volume list.
    Labels Array of TkeLabel No

    Pod label.
    Tolerations Array of Toleration No

    Tolerations definition.
    Envs Array of NameValue No

    Environment variable.
    SchedulingPolicy String No

    Node scheduling policy.
    ResourceLabel String No

    Resource label.
    PodGpuResourceKey String No

    GPU resource vendor key.
    CFSTurboVolumes Array of CFSTurboVolume No

    CFS Turbo mount list.
    GooseFSVolumes Array of GooseFSVolume No

    GooseFS disk.
    PreStartCommand String No

    Pre-start command.
    RayStartParams String No

    Ray pre-start command.

    DynamicInstanceGroupSpec

    DynamicInstanceGroupSpec

    Used by actions: DescribeDynamicInstanceDetail.

    Name Type Required Description
    Name String Yes

    Group name.
    PodCount Integer Yes

    Number of Pods.
    MinNodes Integer Yes

    Minimum number of nodes.
    MaxNodes Integer Yes

    Maximum number of nodes.
    StorageConfigEnabled Boolean Yes

    Whether to enable storage configuration.
    GroupType String No

    headGroup:head;
    workerGroup:worker
    Cpu Integer No

    Number of CPU cores.
    MemSize Integer No

    Memory (GB).
    GpuType String No

    GPU type.
    Gpu Integer No

    Number of GPU cores.
    ResourceLabels String No

    Resource label.
    Env Array of NameValue No

    Environment variable.
    Labels Array of NameValue No

    Tag.
    Tolerations Array of Toleration No

    Tolerations.
    Scheduler String No

    Scheduling policy.
    PersistentVolume PersistentVolume No

    Volume directory.
    PreStartCommand String No

    Pre-start command.
    RayStartParams String No

    RayStart startup parameters.

    DynamicPodSpec

    Pod floating specifications

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    RequestCpu Float No Minimum number of required CPU cores.
    LimitCpu Float No Maximum number of required CPU cores.
    RequestMemory Float No Minimum required memory capacity (MB).
    LimitMemory Float No Maximum required memory capacity (MB).

    EMREventListItem

    Event details list.

    Used by actions: DescribeEMREventList.

    Name Type Required Description
    Host String No IP address of the affected event.
    Role String No Service role of the affected event.
    Name String No Event name.
    Detail String No Event alarm details.
    CreateTime String No Event occurrence time.

    EmrListInstance

    Response example for the cluster list.

    Used by actions: DescribeInstancesList.

    Name Type Description
    ClusterId String Cluster ID.
    StatusDesc String Common status. Valid values: cluster in production, cluster running, cluster creating, cluster disabled, and cluster deleted.
    ClusterName String Cluster name.
    ZoneId Integer Cluster region.
    AppId Integer User APPID.
    AddTime String Creation time.
    RunTime String Running time.
    MasterIp String Cluster IP address.
    EmrVersion String Cluster version.
    ChargeType Integer Cluster billing type.
    Id Integer emr ID
    ProductId Integer Product ID.
    ProjectId Integer Project ID.
    RegionId Integer Region.
    SubnetId Integer Subnet ID.
    VpcId Integer Network ID.
    Zone String Region.
    Status Integer Status code. Valid values: -2 (cluster deleted), -1 (cluster disabled), 0 (cluster in production), 2 (cluster running), 3 (cluster creating).
    Tags Array of Tag Instance tag.
    AlarmInfo String Alarm information.
    IsWoodpeckerCluster Integer Whether it is a Woodpecker cluster.
    VpcName String VPC.
    SubnetName String Subnet.
    UniqVpcId String VPC ID (string).
    UniqSubnetId String Subnet (string).
    ClusterClass String Cluster type.
    IsMultiZoneCluster Boolean Whether it is a cross-AZ cluster.
    IsHandsCluster Boolean Whether it is a manually created cluster.
    OutSideSoftInfo Array of SoftDependInfo External client component information.
    IsSupportOutsideCluster Boolean Whether the current cluster's scenarios support external clients.
    IsDedicatedCluster Boolean Whether the cluster is used in a dedicated cluster scenario.
    IsSupportClone Boolean Whether cloning is supported for the cluster.

    EmrPrice

    EMR inquiry description.

    Used by actions: InquiryPriceScaleOutInstance.

    Name Type Description
    OriginalCost String List price.
    DiscountCost String Discounted price.
    Unit String Unit.
    PriceSpec PriceResource Price inquiry configuration.
    SupportSpotPaid Boolean Whether spot instances are supported.

    EmrProductConfigDetail

    EMR product configuration.

    Used by actions: DescribeInstances.

    Name Type Description
    SoftInfo Array of String Software information.
    MasterNodeSize Integer Number of Master nodes.
    CoreNodeSize Integer Number of Core nodes.
    TaskNodeSize Integer Number of Task nodes.
    ComNodeSize Integer Number of Common nodes.
    MasterResource ResourceDetail Master node resources.
    CoreResource ResourceDetail Core node resources.
    TaskResource ResourceDetail Task node resources.
    ComResource ResourceDetail Common node resources.
    OnCos Boolean Whether COS is used.
    ChargeType Integer Charge type.
    RouterNodeSize Integer Number of Router nodes.
    SupportHA Boolean Whether HA is supported.
    SecurityOn Boolean Whether security mode is supported.
    SecurityGroup String Security group name.
    CbsEncrypt Integer Whether CBS encryption is enabled.
    ApplicationRole String Custom application role.
    SecurityGroups Array of String Security group.
    PublicKeyId String SSH key ID.

    ExportConfContext

    Specifies the context structure in which the configuration needs to be exported.

    Used by actions: DescribeExportConfs.

    Name Type Required Description
    ServiceType Integer Yes

    Service configuration.
    FileName String Yes

    File name.
    ServiceName String No

    Service name.

    ExportConfMeta

    Used by actions: DescribeExportConfs, ModifyServiceParamsByExportConfs.

    Name Type Required Description
    ServiceName String No
    Classification String No
    ServiceVersion String No
    Properties String No

    ExternalAccess

    External access settings for the container cluster.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Type String No External access type. Currently, only CLB fields are supported.
    CLBServer CLBSetting No CLB configuration information.

    ExternalService

    Shared component information.

    Used by actions: CreateInstance, InquiryPriceCreateInstance, InstallSoftware.

    Name Type Required Description
    ShareType String Yes Shared component type. Valid values: EMR and CUSTOM.
    Service String Yes Shared component name.
    InstanceId String Yes Shared component cluster.
    CustomServiceDefineList Array of CustomServiceDefine Yes Custom parameter collection.

    FairGlobalConfig

    Global configuration of the fair scheduler in resource scheduling.

    Used by actions: DescribeGlobalConfig.

    Name Type Description
    UserMaxAppsDefault Integer

    Program upper limit

    on the corresponding page.

    Filter

    Key-value pair filter, which is mainly for condition filtering and query.

    Used by actions: DescribeGroupsSTD.

    Name Type Required Description
    Name String No Fields to be filtered.
    Values Array of String No Filter value of the field.

    Filters

    Custom query filter for instances in the EMR cluster list.

    Used by actions: DescribeInstancesList, DescribeNodeDataDisks, DescribeSLInstanceList.

    Name Type Required Description
    Name String Yes Field name.
    Values Array of String Yes Filter field value.

    FlowExtraDetail

    Additional flow information.

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Description
    Title String Title of additional information.
    Detail Array of FlowParamsDesc Additional information.

    FlowParam

    FlowParam: flow parameters.

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Required Description
    FKey String Yes Flow parameter key.
    TraceId: Query by TraceId.
    FlowId: Query by FlowId.
    FValue String Yes Parameter value.

    FlowParamsDesc

    Task parameter description.

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Description
    PKey String Parameter key.
    PValue String Parameter value.

    GooseFSVolume

    GooseFSVolume

    Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    VolumeName String No

    Storage volume name.
    ClusterId String No

    GooseFS instance ID.
    Namespace String No

    GooseFS namespace.
    SubPath String No

    Mount path in the namespace.
    FuseVersion String No

    FuseVERSION description.
    ClientVersion String No

    Client version description, for example, GOOSE-1.5.2.
    MountOptions String No

    Default mount parameter.
    JvmOptions String No

    Default JVM parameter.

    GpuImageDriverSpec

    Image and driver configuration for the GPU specification.

    Used by actions: AddNodeResourceConfig.

    Name Type Required Description
    ImageId String No

    Image ID.
    DriverName String No

    Driver name.
    DriverVersion String No

    Driver version.
    CUDAName String No

    CUDA name.
    CUDAVersion String No

    CUDA version.
    CUDNNName String No

    CUDNN name.
    CUDNNVersion String No

    CUDNN version.

    GroupGlobalConfs

    Global parameter information of all scaling groups in the cluster.

    Used by actions: DescribeAutoScaleGroupGlobalConf.

    Name Type Required Description
    GroupGlobalConf AutoScaleResourceConf No Scaling group information.
    CurrentNodes Integer No Number of nodes scaled out in the current scaling group.
    CurrentPostPaidNodes Integer No Number of postpaid nodes scaled out in the current scaling group.
    CurrentSpotPaidNodes Integer No Number of spot instance nodes scaled out in the current scaling group.

    GroupInfo

    User group information.

    Used by actions: CreateGroupsSTD.

    Name Type Required Description
    GroupName String No Group name.
    Description String No Remarks.
    Users Array of String No User list.

    GroupInfos

    User group information.

    Used by actions: DescribeGroupsSTD.

    Name Type Required Description
    GroupName String No User group name.
    Users Array of String No User name list.
    Description String No Remarks.
    CreateTime String No Creation time.
    GroupType Integer No User group type.
    GroupTypeDesc String No User group type description.

    HBaseMetricData

    HBase monitoring data structure.

    Used by actions: DescribeHBaseTableRequestMetric, DescribeHBaseTableStoreSizeMetric.

    Name Type Description
    MetricName String Metric name, for example, read_request_rate.
    MetricDesc String Metric description, for example, read request rate.
    Timestamps Array of Integer Timestamp array.
    Values Array of Float Numeric array.

    HealthStatus

    Process health status.

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    Code Integer Running normally.
    Text String Running normally.
    Desc String Running normally.

    HiveQuery

    Hive query details.

    Used by actions: DescribeHiveQueries.

    Name Type Description
    Statement String Query statement.
    Duration String Execution duration.
    StartTime Integer Start time (ms).
    EndTime Integer End time (ms).
    State String Status.
    User String User.
    JobIds Array of String APPID list.
    ExecutionEngine String Execution engine.
    Id String Query ID.

    HostPathVolumeSource

    Host path.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Path String No Host path.
    Type String No Host path type. Default value: DirectoryOrCreate.

    HostVolumeContext

    Description of the Pod HostPath mounting method.

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    VolumePath String Yes Directory for mounting the host in the Pod. As the mount point of the host in the resource, a specified mount point corresponds to the host path and is used as the data storage directory in the Pod.

    ImageInfo

    Image information.

    Used by actions: DescribeDynamicInstanceDetail.

    Name Type Required Description
    Region String No Image region.
    RegistryId String No TCR instance ID.
    DomainName String No Domain name.
    NamespaceName String No Namespace.
    RepositoryName String No Image repository name.
    ImageVersion String No Image version.
    ImagePullPolicy String No Image pull policy.
    Image String No Image address.

    ImageInfoV2

    EMR on TKE cluster component image information.

    Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    ImageMode String No

    Image type.

    Enumeration values:

    • official: official image
    • custom: custom image
    • imageUrl: image URL
    Region String No

    Region.
    LegacyCCR Boolean No

    Whether it is an existing image.
    FullImageUrl String No

    Image URL.
    MainVersion String No

    Version.
    RegistryUrl String No

    Image URL domain name.
    NamespaceName String No

    Image namespace.
    RepoName String No

    Image repository name.
    Tag String No

    Image version tag.
    Username String No

    Username.
    Password String No

    Password.
    ImagePullSecret ImagePullSecret No

    Image pull secret.
    ImagePullPolicy String No

    Image pull policy.

    ImagePullSecret

    Key used for obtaining an image.

    Used by actions: DescribeDynamicInstanceDetail.

    Name Type Required Description
    SourceNamespace String No Namespace of the source key.
    SecretNames Array of String No Key name list.

    InsightResult

    Insight result item.

    Used by actions: DescribeInsightList.

    Name Type Required Description
    ID String No When Type is set to HIVE, the value is the Hive query ID; when Type is set to MAPREDUCE, SPARK or TEZ, the value is YarnAppID.
    Type String No Insight application type. Valid values: HIVE, SPARK, MAPREDUCE, and TEZ.
    RuleID String No Insight rule ID.
    HIVE-ScanManyMeta: excessively large amount of scanned metadata
    HIVE-ScanManyPartition: large table scan
    HIVE-SlowCompile: excessively long compilation durationHIVE-UnSuitableConfig: improper parameter
    MAPREDUCE-MapperDataSkew: Map data skew
    MAPREDUCE-MapperMemWaste: MapMemory resource waste
    MAPREDUCE-MapperSlowTask: Map slow task
    MAPREDUCE-MapperTaskGC:MapperTaskGC
    MAPREDUCE-MemExceeded: peak memory exceeded
    MAPREDUCE-ReducerDataSkew: Reduce data skew
    MAPREDUCE-ReducerMemWaste: ReduceMemory resource waste
    MAPREDUCE-ReducerSlowTask: Reduce slow task
    MAPREDUCE-ReducerTaskGC:ReducerTaskGC
    MAPREDUCE-SchedulingDelay: scheduling delay
    SPARK-CpuWaste: CPU resource waste
    SPARK-DataSkew: data skew
    SPARK-ExecutorGC:ExecutorGC
    SPARK-MemExceeded: peak memory exceeded
    SPARK-MemWaste: Memory resource waste
    SPARK-ScheduleOverhead:ScheduleOverhead
    SPARK-ScheduleSkew: scheduling skew
    SPARK-SlowTask: slow task
    TEZ-DataSkew: data skew
    TEZ-MapperDataSkew: Map data skew
    TEZ-ReducerDataSkew: Reduce data skew
    TEZ-TezMemWaste: Memory resource waste
    TEZ-TezSlowTask: slow task
    TEZ-TezTaskGC:TasksGC
    RuleName String No Insight rule name. Refer to the description of RuleID.
    RuleExplain String No Insight rule interpretation.
    Detail String No Details.
    Suggestion String No Recommended message.
    Value Integer No Insight anomaly metric value. For insight items of the same type, a larger value indicates higher severity. Insight items of different types are not comparable.
    ScheduleTaskExecID String No Scheduling task execution ID.
    ScheduleFlowName String No Scheduling flow (DAG).
    ScheduleTaskName String No Task node in the scheduling flow.
    JobConf String No Some core configurations of the YARN task.
    Context String No Insight into structured information.

    InspectionTaskSettings

    Specifies the inspection task configuration to be set.

    Used by actions: ModifyInspectionSettings.

    Name Type Required Description
    TaskType String Yes Unique identifier for the inspection task.
    Group String No Inspection task group name.
    Name String No Inspection task name.
    TaskSettings Array of TaskSettings No Inspection task parameter settings.
    Selected String No Whether it is selected. Valid values: "true" and "false".
    Enable String No Whether monitoring is enabled.
    SettingsJson String No Event JSON template.

    InstanceChargePrepaid

    Instance prepayment parameter. This parameter is valid only when the payment type is PREPAID.

    Used by actions: CreateCluster, ScaleOutCluster.

    Name Type Required Description
    Period Integer Yes Yearly/monthly subscription duration. Default value: 1. Unit: month.Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36, 48, and 60.
    RenewFlag Boolean Yes Whether to enable auto-renewal, which defaults to no.
  • true: yes
  • false: no
    		•

    Item

    Key-value structure.

    Used by actions: ModifyGlobalConfig, ModifyYarnQueueV2.

    Name Type Required Description
    Key String Yes Key value.
    Value String Yes Value.

    ItemSeq

    List of key-value pairs.

    Used by actions: ModifyYarnQueueV2.

    Name Type Required Description
    Items Array of Item Yes Tag name.

    KeyValue

    Key-value pair, which is mainly for filtering.

    Used by actions: DescribeAutoScaleRecords.

    Name Type Required Description
    Key String Yes Key.
    Value String Yes Value.

    KyuubiQueryInfo

    Kyuubi query information.

    Used by actions: DescribeKyuubiQueryInfo.

    Name Type Description
    ClientIP String Submission IP address.
    Duration Integer Execution duration.
    EndTime Integer End time.
    EngineID String Engine Id
    EngineType String Computing engine.
    Id String ID
    SessionID String Session Id
    BeginTime Integer Start time.
    ExecutionState String Execution status.
    ExecutionStatement String Execution statement.
    StatementID String Statement Id
    User String Submission user.

    LabelSelector

    Tag selector.

    Used by actions: InstallSoftware.

    Name Type Required Description
    MatchLabels Array of StringMap No

    Tag exact match condition.
    MatchExpressions Array of LabelSelectorRequirement No

    Tag expression match condition.

    LabelSelectorRequirement

    Tag selector matching expression.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Key String No

    Key.
    Operator String No

    Matching operation.
    Values Array of String No

    Value.

    LoadAutoScaleStrategy

    Automatic scaling rule based on load metrics.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    StrategyId Integer No Rule ID.
    StrategyName String No Rule name.
    CalmDownTime Integer No Cooldown time for a rule to take effect.
    ScaleAction Integer No Scaling action. Valid values: 1 (scale-out) and 2 (scale-in).
    ScaleNum Integer No Number of scaling items each time the rule takes effect.
    ProcessMethod Integer No Metric processing method. Valid values: 1 (MAX), 2 (MIN), and 3 (AVG).
    Priority Integer No Rule priority, which is invalid during addition. By default, the auto-increment rule is used.
    StrategyStatus Integer No Rule status. Valid values: 1 (enabled) and 3 (disabled).
    YarnNodeLabel String No YARN node label specified for the rule-based scale-out.
    PeriodValid String No Effective time of the rule.
    GraceDownFlag Boolean No Graceful scale-in switch.
    GraceDownTime Integer No Graceful scale-in wait time.
    GraceDownProtectFlag Boolean No Whether to enable task protection.
    Tags Array of Tag No Bound tag list.
    ConfigGroupAssigned String No Preset configuration group.
    MeasureMethod String No Calculation method for scaled‑out resources. Valid values: "DEFAULT", "INSTANCE", "CPU", and "MEMORYGB".
    "DEFAULT" indicates the default calculation method, which is identical to "INSTANCE".
    "INSTANCE" indicates the calculation method based on nodes. This is the default method.
    "CPU" indicates the calculation method based on the number of cores of the machine.
    "MEMORYGB" indicates the calculation method based on the memory size of the machine.
    SoftDeployDesc Array of String No List of node deployment services, for example, ["HDFS-3.1.2","YARN-3.1.2"].
    ServiceNodeDesc String No Startup process list, for example, ["NodeManager"].
    ServiceNodeInfo Array of Integer No Startup process list.
    SoftDeployInfo Array of Integer No List of services deployed on the node. Valid values: HDFS and YARN. For details, see Mapping Table for Component Names.
    LoadMetricsConditions LoadMetricsConditions No Multi-metric triggering condition.
    GroupId Integer No Scaling group ID.
    Soft String No Soft. Example value: yarn.
    GraceDownProtectTime Integer No Task protection time.

    LoadMetricsCondition

    Load metric condition.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    StatisticPeriod Integer No Rule statistics cycle. One, three, and five minutes are supported.
    TriggerThreshold Integer No Number of triggering times. Scaling begins only after it has been triggered continuously for more than TriggerThreshold times.
    LoadMetrics String No Scaling load metric.
    MetricId Integer No Rule metadata record ID.
    Conditions Array of TriggerCondition No Triggering condition.

    LoadMetricsConditions

    Load metric.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    LoadMetrics Array of LoadMetricsCondition No Rule trigger condition.
    Match Integer No 0: All conditions are met.
    1: Any one of the conditions is met.

    LoginSettings

    Login settings.

    Used by actions: CreateCluster, CreateInstance.

    Name Type Required Description
    Password String No Instance login password, with 8 to 16 characters, including uppercase letters, lowercase letters, digits, and special characters. Special characters only support !@%^*. The password cannot start with a special character.
    PublicKeyId String No Key ID. After a key is associated, the instance can be accessed with the corresponding private key; PublicKeyId can be obtained through the API DescribeKeyPairs.

    MetricTags

    Metric tag.

    Used by actions: DescribeEmrOverviewMetrics.

    Name Type Required Description
    Unit String No Metric unit.
    Type String No Metric type.

    ModifyDynamicInstanceForm

    Form data submitted when updating a DynamicInstance.

    Used by actions: ModifyDynamicInstance.

    Name Type Required Description
    ModifyScope Integer Yes

    Update scope:
    1: Add a worker group (DynamicInstance level)
    2: Update storage configuration (DynamicInstance level)
    3: Update tag configuration (DynamicInstance level)
    4: Update advanced configuration (DynamicInstance level)
    5: Update PodCpu and PodMem (DynamicInstance-group level)
    6: Update PodNum, MinPodNum, and MaxPodNum (DynamicInstance-group level)
    7: Update storage configuration (DynamicInstance-group level)
    8: Update tag configuration (DynamicInstance-group level)
    AddDynamicInstanceGroup DynamicInstanceGroup No

    Added worker group information.
    SupportPV Boolean No

    Whether to support storage configuration.
    CBSVolumes Array of CBSVolume No

    CBS storage volume list.
    CFSVolumes Array of CFSVolume No

    CFS storage volume list, excluding the CFS Turbo list.
    COSVolumes Array of COSVolume No

    COS storage volume list.
    VolumeMounts Array of VolumeMount No

    Mount volume list.
    Labels Array of TkeLabel No

    Pod label.
    Tolerations Array of Toleration No

    Tolerations definition.
    Envs Array of NameValue No

    Environment variable.
    DependServices Array of DependService No

    Dependent external components.
    SupportNewToken Boolean No

    Whether to generate a new token for authentication.
    ModifyDynamicInstanceGroup DynamicInstanceGroup No

    Update information at the DynamicInstance-group level.
    CFSTurboVolumes Array of CFSTurboVolume No

    CFS Turbo mount list, excluding the standard edition.
    CustomImage CustomImage No

    Custom image.
    ImageInfoV2 ImageInfoV2 No

    Custom image.
    GooseFSVolumes Array of GooseFSVolume No

    GooseFS disk.
    EnableHistoryServer Boolean No

    Whether to enable log collection.

    ModifyResourceTags

    Specifies the tags to be forcibly modified.

    Used by actions: ModifyResourcesTags.

    Name Type Required Description
    ResourceId String Yes Cluster ID or CVM ID.
    Resource String Yes Six-segment resource expression.
    ResourcePrefix String Yes Resource prefix.
    ResourceRegion String Yes ap-beijing
    ServiceType String Yes emr
    DeleteTags Array of Tag No List of deleted tags.
    AddTags Array of Tag No List of added tags.
    ModifyTags Array of Tag No List of modified tags.

    MonthRepeatStrategy

    Monthly repetition task policy for scheduled scaling.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAtTimeOfDay String Yes Specific time for repetition task execution, for example, 01:02:00.
    DaysOfMonthRange Array of Integer Yes Description of the day range within a month. The length must be 2. For example, [2,10] indicates from the 2nd day to the 10th day every month.

    MultiDisk

    Multi-cloud disk parameter.

    Used by actions: AddNodeResourceConfig, InquiryPriceScaleOutInstance.

    Name Type Required Description
    DiskType String No Cloud disk type. Valid values:
  • CLOUD_SSD: Cloud SSD
  • CLOUD_PREMIUM: Premium Disk
  • CLOUD_HSSD: Enhanced SSD
    		•
    Volume Integer No Cloud disk size.
    Count Integer No Number of cloud disks of this type.

    MultiDiskMC

    Multi-cloud disk parameter.

    Used by actions: DescribeClusterNodes.

    Name Type Required Description
    Count Integer Yes Number of cloud disks of this type.
    Type Integer No Disk type.
    1: Local Basic Disk
    2: Cloud Basic Disk
    3: Local SSD
    4: Cloud SSD
    5: Premium Disk
    6: Enhanced SSD
    11: Throughput-Optimized Cloud Disk
    12: Tremendous SSD
    13: Balanced SSD
    14: Big Data Cloud Disk
    15: High-IO Cloud Disk
    16: Remote SSD Disk
    Size String No Disk size.
    Volume Integer No Cloud disk size (bytes).

    MultiZoneSetting

    Parameter information for each AZ.

    Used by actions: CreateInstance, InquiryPriceCreateInstance.

    Name Type Required Description
    ZoneTag String No "master", "standby", and "third-party".
    VPCSettings VPCSettings No None.
    Placement Placement No None.
    ResourceSpec NewResourceSpec No None.

    NameValue

    Key and value.

    Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    Name String Yes name
    Value String Yes value

    NewResourceSpec

    Resource description.

    Used by actions: CreateInstance, InquiryPriceCreateInstance.

    Name Type Required Description
    MasterResourceSpec Resource No Description of Master node resources.
    CoreResourceSpec Resource No Description of Core node resources.
    TaskResourceSpec Resource No Description of Task node resources.
    MasterCount Integer No Number of Master nodes.
    CoreCount Integer No Number of Core nodes.
    TaskCount Integer No Number of Task nodes.
    CommonResourceSpec Resource No Description of Common node resources.
    CommonCount Integer No Number of Common nodes.

    NodeAffinity

    Node affinity settings.

    Used by actions: InstallSoftware.

    Name Type Required Description
    RequiredDuringSchedulingIgnoredDuringExecution NodeSelector No Node affinity - forced scheduling settings.
    PreferredDuringSchedulingIgnoredDuringExecution Array of PreferredSchedulingTerm No Node affinity - tolerance scheduling.

    NodeDetailPriceResult

    Node price details, which are used to create the cluster price list.

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    NodeType String Node type. Valid values: master, core, task, common, router, and mysql.
    PartDetailPrice Array of PartDetailPriceItem Price details for each component of the node.

    NodeHardwareInfo

    Node hardware information.

    Used by actions: DescribeClusterNodes.

    Name Type Description
    AppId Integer

    User APPID.
    SerialNo String

    Serial number.
    OrderNo String

    Machine instance ID.
    WanIp String

    Public IP address bound to the Master node.
    Flag Integer

    Node type. Valid values: 0 (Common node), 1 (Master node)
    2 (Core node) and 3 (Task node).
    Spec String

    Node specifications.
    CpuNum Integer

    Number of node cores.
    MemSize Integer

    Node memory (bytes).
    MemDesc String

    Node memory description (GB).
    RegionId Integer

    Region where the node is located.
    ZoneId Integer

    Zone where the node is located.
    ApplyTime String

    Application time.
    FreeTime String

    Release time.
    DiskSize String

    Hard disk size.
    NameTag String

    Node description.
    Services String

    Services deployed on the node.
    StorageType Integer

    Disk type. Valid values: 1 (Local Basic Disk), 2 (Cloud Basic Disk), 3 (Local SSD), 4 (Cloud SSD), 5 (Premium Disk), 6 (Enhanced SSD), 11 (Throughput-Optimized Cloud Disk), 12 (Tremendous SSD), 13 (Balanced SSD), 14 (Big Data Cloud Disk), 15 (High-IO Cloud Disk), and 16 (Remote SSD Disk).
    RootSize Integer

    System disk size (GB).
    ChargeType Integer

    Payment type. Valid values: 0 (pay-as-you-go) and 1 (yearly/monthly subscription).
    CdbIp String

    Database IP address.
    CdbPort Integer

    Database port.
    HwDiskSize Integer

    Hard disk capacity (bytes).
    HwDiskSizeDesc String

    Hard disk capacity description.
    HwMemSize Integer

    Memory capacity (bytes).
    HwMemSizeDesc String

    Memory capacity description.
    ExpireTime String

    Expiration time.
    EmrResourceId String

    Node resource ID.
    IsAutoRenew Integer

    Renewal flag.
    DeviceClass String

    Device identifier.
    Mutable Integer

    Supports configuration change.
    MCMultiDisk Array of MultiDiskMC

    Multi-cloud disk.
    CdbNodeInfo CdbInfo

    Database information.
    Ip String

    Private IP address.
    Destroyable Integer

    Whether this node can be terminated. Valid values: 1 (yes) and 0 (no).
    Tags Array of Tag

    Tag bound to the node.
    AutoFlag Integer

    Whether it is an auto scaling node. Valid values: 0 (regular node) and 1 (auto scaling node).
    HardwareResourceType String

    Resource type. Valid values: host and pod.
    IsDynamicSpec Integer

    Whether it is a floating specification. Valid values: 1 (yes) and 0 (no).
    DynamicPodSpec String

    JSON string of the floating specification value.
    SupportModifyPayMode Integer

    Whether changing the billing mode is supported. Valid values: 1 (yes) and 0 (no).
    RootStorageType Integer

    System disk type. Valid values: 1 (Local Basic Disk), 2 (Cloud Basic Disk), 3 (Local SSD), 4 (Cloud SSD), 5 (Premium Disk), 6 (Enhanced SSD), 11 (Throughput-Optimized Cloud Disk), 12 (Tremendous SSD), 13 (Balanced SSD), 14 (Big Data Cloud Disk), 15 (High-IO Cloud Disk), and 16 (Remote SSD Disk).
    Zone String

    AZ information.
    SubnetInfo SubnetInfo

    Subnet.
    Clients String

    Client.
    CurrentTime String

    Current system time.
    IsFederation Integer

    Whether it is used for federation. Valid values: 1 (yes) and 0 (no).
    DeviceName String

    Device name.
    ServiceClient String

    Service.
    DisableApiTermination Boolean

    Whether instance protection is enabled for this instance. Valid values: true (enabled) and false (disabled).
    TradeVersion Integer

    0 indicates the old billing mode, and 1 indicates the new billing mode.
    ServicesStatus String

    Status of each component. ZooKeeper: STARTED; ResourceManager: STARTED. STARTED means started, and STOPPED means stopped.
    Remark String

    Remarks.
    SharedClusterId String

    Shared cluster ID.
    SharedClusterIdDesc String

    Description of the shared cluster ID.
    TimingResource Boolean

    Whether it is a scheduled termination resource.
    TkeClusterId String

    TKE cluster ID when the resource type (HardwareResourceType) is pod.
    ConfigurableServices Array of String

    Name list of services that can be configured when a new disk is mounted.
    NodeMark String

    Node annotation information, which is currently only provided for the Terraform platform.
    UnderwriteSetAutoRenew Boolean

    Whether the committed use resource supports setting auto-renewal.
    GpuDesc String

    GPU information.
    DiskHealthIssues Array of DiskHealthIssue

    Disk issue description.
    NodeGroupId String

    ID of the node group where the node resides.
    NodeGroupName String

    Name of the node group where the node resides.

    NodeMark

    Node tag information.

    Used by actions: CreateCluster, CreateInstance, ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    NodeType String No Node type. Valid values: master, core, task, and router.
    NodeNames Array of String No Node tag information: currently only used for the Terraform platform. It serves as an input parameter to differentiate information of nodes of the same type.
    Zone String No AZ name.

    NodeRenewPriceDetail

    Node renewal inquiry details.

    Used by actions: InquiryPriceRenewInstance.

    Name Type Description
    ChargeType Integer Billing mode. Valid values: 1 (monthly subscription) and 3 (committed use).
    EmrResourceId String EMR resource ID.
    NodeType String Node type.
    Ip String Node private network IP address.
    ExpireTime String Current expiration time.
    OriginalCost Float Original price.
    DiscountCost Float Discounted price.
    RenewPriceDetails Array of RenewPriceDetail Node sub-item renewal inquiry details list.

    NodeResource

    Specifications management, which includes the specifications type description.

    Used by actions: DescribeNodeResourceConfigFast.

    Name Type Description
    ResourceConfigId Integer

    Configuration ID.
    Resource Resource

    Resource
    CreateTime String

    Creation time.
    UpdateTime String

    Update time.
    IsDefault String

    Whether the default configuration applies. Valid values: DEFAULT and BACKUP.
    MaxResourceNum Integer

    Remaining of this type.
    PrepaidUnderwritePeriods Array of Integer

    Supported committed use duration.
    QuotaNum Integer

    Number of quotas.
    QuotaUnit String

    Quota unit.

    NodeResourceSpec

    Resource details.

    Used by actions: CreateCluster, ScaleOutCluster.

    Name Type Required Description
    InstanceType String Yes

    Specifications type, such as S2.MEDIUM8.
    SystemDisk Array of DiskSpecInfo Yes

    System disk. The number of system disks does not exceed 1.
    Tags Array of Tag No

    List of tags to be bound.
    DataDisk Array of DiskSpecInfo No

    Cloud data disk. The total number of cloud data disks does not exceed 15.
    LocalDataDisk Array of DiskSpecInfo No

    Local data disk.
    SoftwareConfig Array of ServiceDeploy No

    Node configuration information. Currently provided only for the Terraform platform to validate parameters.
    CustomNodeName String No

    Custom hostname.

    NodeSelector

    Selection criteria for forcibly scheduled Pod nodes.

    Used by actions: InstallSoftware.

    Name Type Required Description
    NodeSelectorTerms Array of NodeSelectorTerm No Selection criteria for forcibly scheduled Pod nodes.

    NodeSelectorRequirement

    Pod node selector requirement.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Key String No Key of the node selector requirement.
    Operator String No Operator value of the node selector requirement. Supported operators: In, NotIn, Exists, DoesNotExist, Gt, and Lt.
    Values Array of String No Values of the node selector requirement.

    NodeSelectorTerm

    Pod node option set.

    Used by actions: InstallSoftware.

    Name Type Required Description
    MatchExpressions Array of NodeSelectorRequirement No Node option expression set.

    NodeSpecDisk

    Node disk type.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    Count Integer No Number.
    Name String No Name.
    DiskType String No Disk type.
    DefaultDiskSize Integer No Specified disk size.
    IsSpecialDisk Boolean No Whether it is a special data disk, for example, a single-replica disk.

    NodeSpecDiskV2

    Node disk type.

    Used by actions: AttachDisks.

    Name Type Required Description
    Count Integer No Quantity.
    Name String No Name.
    DiskType String No Disk type.
    DefaultDiskSize Integer No Specified disk size.

    NodeSpecFamily

    Instance specification family.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    InstanceFamily String Yes Instance specification.
    FamilyName String Yes Instance specification name.
    Order Integer No Sorting order.
    InstanceTypes Array of NodeSpecInstanceType No List of instance types.

    NodeSpecInstanceType

    Node specifications type.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    InstanceType String Yes

    Specifications.
    Cpu Integer Yes

    4
    Memory Integer Yes

    8, unit: GB.
    Order Integer No

    Sorting order. Smaller values come first.
    Num Integer No

    Quantity.
    SellOutReason String No

    Sold-out reason.
    SystemDisk Array of NodeSpecDisk No

    System disk.
    DataDisk Array of NodeSpecDisk No

    Data disk.
    LocalDataDisk Array of NodeSpecDisk No

    Local data disk.
    SoldOutReason String No

    Sold-out reason.
    InstanceFamily String No

    Instance family.
    NodeName String No

    Node name.
    NodeType String No

    Node type.
    Type String No

    Category.
    TypeName String No

    Category name.
    FamilyName String No

    Category classification.
    CpuType String No

    CPU type.
    Remark String No

    RunOut: sold out; Less: low inventory; Enough: sufficient inventory
    OriginPrice Float No

    Original price.
    PrepaidUnderwritePeriods Array of Integer No

    Purchase duration supported by instance types using the committed use billing mode.
    GpuDesc String No

    GPU information.
    QuotaNum Integer No

    Number of quotas.
    QuotaUnit String No

    Quota unit.
    NeedHpcClusterId Boolean No

    Whether a high-performance computing cluster needs to be provided.
    IsGpuInstance Boolean No

    Whether it is a GPU instance type.
    GpuResourceKey String No

    GPU resource definition in the Kubernetes scenario.
    GpuNum Integer No

    Number of GPU cards.

    NodeSpecType

    Node instance type.

    Used by actions: DescribeNodeSpec.

    Name Type Required Description
    Type String Yes Instance type series.
    TypeName String Yes Instance type series name.
    Order Integer No Sorting order.
    InstanceFamilies Array of NodeSpecFamily No Array of instance families.

    NotRepeatStrategy

    Context of the rule for executing auto scaling once.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAt String Yes Exact time when the task was executed. Format: "2020-07-13 00:00:00".

    OpScope

    Operation scope.

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    ServiceInfoList Array of ServiceBasicRestartInfo No Operation scope, with information of the service to be operated.

    OperationLog

    Operation log description.

    Used by actions: DescribeInstanceOplog.

    Name Type Description
    InstanceId Integer

    EMR instance ID.
    Operation String

    Operation name.
    OperationType Integer

    Operation type.
    UserType Integer

    User type.
    Operator String

    Operator.
    CreateTime String

    Operation time.
    Operand String

    Operation object.
    OperationDesc String

    Operation details.
    SecurityLevel String

    Security level.
    OperatorName String

    Operator name.

    Order

    Sort description, used for sorting.

    Used by actions: DescribeGroupsSTD.

    Name Type Required Description
    Name String No Sorting field.
    Direction String No Desc or Asc.

    OtherAccountInfo

    Other account information.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    OtherUin String No UIN of another account.
    RoleName String No Authorized role name of another account.

    OverviewMetricData

    Overview data.

    Used by actions: DescribeEmrOverviewMetrics.

    Name Type Required Description
    Metric String No Metric name.
    First Integer No First data timestamp.
    Last Integer No Last data timestamp.
    Interval Integer No Sampling point time interval.
    DataPoints Array of String No Sampling point data.
    Tags MetricTags No Metric tags.

    OverviewRow

    Return of the HBase TableMetric overview.

    Used by actions: DescribeHBaseTableOverview.

    Name Type Description
    Table String Table name.
    ReadRequestCount Float Number of read requests.
    WriteRequestCount Float Number of write requests.
    MemstoreSize Float Size of the current MemStore.
    StoreFileSize Float Size of the StoreFile in the current region.
    Operation String Regions. Click to jump.
    StoreFileNum Float Number of StoreFiles.

    PartDetailPriceItem

    Prices of node components used for the cluster creation price list.

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    InstanceType String Type. Valid values: node (node), rootDisk (system disk), dataDisk (cloud data disk), and metaDB.
    Price Float Unit price (original price).
    RealCost Float Unit price (discounted price).
    RealTotalCost Float Total price (discounted price).
    Policy Float Discount.
    GoodsNum Integer Quantity.

    Period

    Serverless HBase monthly subscription duration.

    Used by actions: CreateSLInstance.

    Name Type Required Description
    TimeSpan Integer Yes Time span.
    TimeUnit String No Time unit. "m" stands for month(s).

    PersistentVolume

    Volume directory.

    Used by actions: DescribeDynamicInstanceDetail.

    Name Type Required Description
    CBSVolumes Array of CBSVolume No

    CBS storage volume.
    CFSVolumes Array of CFSVolume No

    CFS storage volume.
    COSVolumes Array of COSVolume No

    COS storage volume.
    StorageVolumeName Array of String No

    Storage volume name (the YAML submission has no storage volume type).
    VolumeMounts Array of VolumeMount No

    Storage volume list.
    StorageVolumeDetail Array of StorageVolumeDetail No

    Storage volume details.
    CFSTurboVolumes Array of CFSTurboVolume No

    CFS Turbo storage volume.
    GooseFSVolumes Array of GooseFSVolume No

    GooseFS volume mount information.

    PersistentVolumeContext

    Description of the Pod PVC storage method.

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    DiskSize Integer No Disk size (GB).
    DiskType String No Disk type. Valid values: CLOUD_PREMIUM and CLOUD_SSD.
    DiskNum Integer No Number of disks.
    ExtraPerformance Integer No Cloud disk additional performance.

    Placement

    Description of cluster location information.

    Used by actions: CreateCluster, CreateInstance, InquiryPriceCreateInstance, InquiryPriceRenewInstance, InquiryPriceUpdateInstance.

    Name Type Required Description
    Zone String Yes AZ of the instance, such as ap-guangzhou-1. This parameter can also be obtained from the Zone field in the return value of DescribeZones.
    ProjectId Integer No ID of the project to which the instance belongs. This parameter can be obtained from the projectId field in the return value of DescribeProject. If not specified, the default project is used.

    PodAffinitySpec

    Pod affinity.

    Used by actions: InstallSoftware.

    Name Type Required Description
    RequiredDuringSchedulingIgnoredDuringExecution Array of PodAffinityTerm No

    Hard affinity rule for scheduling.
    PreferredDuringSchedulingIgnoredDuringExecution Array of WeightedPodAffinityTerm No

    Soft affinity rule for scheduling.

    PodAffinityTerm

    Pod affinity item.

    Used by actions: InstallSoftware.

    Name Type Required Description
    LabelSelector LabelSelector No

    Label selector.
    Namespaces Array of String No

    Namespace list.
    TopologyKey String No

    Topology domain key.
    NamespaceSelector LabelSelector No

    Namespace selector.

    PodNewParameter

    Pod custom permission and parameter.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    InstanceId String Yes TKE or EKS cluster ID.
    Config String Yes Custom permission.
    Example:
    {
    "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 Yes Custom parameter.
    Example:
    {
    "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

    Resource description, which is used during a container resource scale-out.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    ResourceProviderIdentifier String Yes Identifier of the external resource provider, for example, "cls-a1cd23fa".
    ResourceProviderType String Yes Type of the external resource provider, for example, "tke". Currently, only "tke" is supported.
    NodeFlag String Yes Purpose of the resource, that is, the node type. Currently only "TASK" is supported.
    Cpu Integer Yes Number of CPU cores.
    Memory Integer Yes Memory size (GB).
    CpuType String No CPU type for the EKS cluster, currently supporting intel and amd.
    PodVolumes Array of PodVolume No Mounting information of the node data directory on Pod.
    EnableDynamicSpecFlag Boolean No Whether it is a floating specification. Default: false. Valid values:
  • true: yes
  • false: no
    		•
    DynamicPodSpec DynamicPodSpec No Floating specification.
    VpcId String No Unique ID of the VPC.
    SubnetId String No Unique ID of the VPC subnet.
    PodName String No pod name
    OtherAccountInfo OtherAccountInfo No Other account authorization information.

    PodParameter

    Pod custom permission and parameter.

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    ClusterId String Yes TKE or EKS cluster ID.
    Config String Yes Custom permission.
    Example:
    {
    "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 Yes Custom parameter.
    Example:
    {
    "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"
    ]
    }
    ]
    }
    ]
    }
    }
    }
    }
    }
    }
    }

    PodSpec

    Resource description, which is used during a container resource scale-out.

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    ResourceProviderIdentifier String Yes Identifier of the external resource provider, for example, "cls-a1cd23fa".
    ResourceProviderType String Yes Type of the external resource provider, for example, "tke". Currently, only "tke" is supported.
    NodeType String Yes Purpose of the resource, that is, the node type. Currently only "TASK" is supported.
    Cpu Integer Yes Number of CPU cores.
    Memory Integer Yes Memory size (GB).
    DataVolumes Array of String No The mount point of the resource to the host. The specified mount point corresponds to the path on the host, and this mount point is used as the data storage directory in the Pod. This parameter has been deprecated.
    CpuType String No CPU type for the EKS cluster, currently supporting intel and amd.
    PodVolumes Array of PodVolume No Mounting information of the node data directory on Pod.
    IsDynamicSpec Integer No Whether it is a floating specification. Valid values: 1 (yes) and 0 (no).
    DynamicPodSpec DynamicPodSpec No Floating specification.
    VpcId String No Unique ID of the VPC.
    SubnetId String No Unique ID of the VPC subnet.
    PodName String No pod name

    PodSpecInfo

    Pod-related information.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    PodSpec PodNewSpec No Pod specifications and source information, which are specified when Pod resources are used for the scale-out.
    PodParameter PodNewParameter No Pod custom permission and parameter.

    PodVolume

    Description of the Pod storage device.

    Used by actions: ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    VolumeType String Yes Storage type. Valid values: "pvc" and "hostpath".
    PVCVolume PersistentVolumeContext No When VolumeType is set to "pvc", this parameter takes effect.
    HostVolume HostVolumeContext No When VolumeType is set to "hostpath", this parameter takes effect.

    PreExecuteFileSetting

    Pre-execution script configuration.

    Used by actions: DescribeBootScript, ModifyBootScript.

    Name Type Required Description
    Path String No Script path on COS.
    Args String No Script execution parameter.
    Bucket String No COS bucket name.
    Region String No COS region name.
    Domain String No COS domain data.
    RunOrder Integer No Execution order.
    WhenRun String No Whether resourceAfter or clusterAfter is used.
    CosFileName String No Script file name.
    CosFileURI String No Script's COS address.
    CosSecretId String No COS SecretId.
    CosSecretKey String No COS SecretKey.
    AppId String No COS APPID.
    Remark String No Remarks.

    PreExecuteFileSettings

    Pre-execution script configuration.

    Used by actions: CreateInstance, ScaleOutInstance.

    Name Type Required Description
    Path String No Script path on COS, which has been deprecated.
    Args Array of String No Script execution parameter.
    Bucket String No COS bucket name, which has been deprecated.
    Region String No COS region name, which has been deprecated.
    Domain String No COS domain data, which has been deprecated.
    RunOrder Integer No Execution order.
    WhenRun String No Whether resourceAfter or clusterAfter is used.
    CosFileName String No Script file name, which has been deprecated.
    CosFileURI String No COS address of the script.
    CosSecretId String No COS SecretId.
    CosSecretKey String No COS SecretKey.
    AppId String No COS APPID, which has been deprecated.
    Remark String No Remarks.

    PrePaySetting

    Serverless HBase prepaid settings.

    Used by actions: CreateSLInstance.

    Name Type Required Description
    Period Period Yes Time.
    AutoRenewFlag Integer Yes Auto-renewal flag. Valid values: 0 (notifies before expiration but does not trigger auto-renewal), 1 (notifies before expiration and triggers auto-renewal), and 2 (does not notify before expiration and does not trigger auto-renewal).

    PreferredSchedulingTerm

    Option for the Pod toleration scheduling node.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Weight Integer No Weight. Value range: 1–100.
    Preference NodeSelectorTerm No Node selection expression.

    PriceDetail

    Price details.

    Used by actions: InquiryPriceRenewInstance, InquiryPriceUpdateInstance.

    Name Type Description
    ResourceId String Node ID.
    Formula String Price calculation formula.
    OriginalCost Float Original price.
    DiscountCost Float Discounted price.

    PriceResource

    Inquiry resources.

    Used by actions: InquiryPriceScaleOutInstance.

    Name Type Description
    Spec String Required specifications.
    StorageType Integer Hard disk type.
    DiskType String Hard disk type.
    RootSize Integer System disk size.
    MemSize Integer Memory size.
    Cpu Integer Number of cores.
    DiskSize Integer Hard disk size.
    MultiDisks Array of MultiDisk Cloud disk list.
    DiskCnt Integer Number of disks.
    InstanceType String Specifications.
    Tags Array of Tag Tag.
    DiskNum Integer Number of disks.
    LocalDiskNum Integer Number of local disks.
    GpuDesc String GPU information.

    PriceResult

    Price inquiry result.

    Used by actions: InquiryPriceUpdateInstance.

    Name Type Required Description
    OriginalCost Float No Original price.
    DiscountCost Float No Discounted price.

    RayCluster

    RayCluster

    Used by actions: DescribeDynamicInstanceList.

    Name Type Required Description
    RayClusterName String No

    RayCluster cluster name.
    RayClusterId Integer No

    RayCluster cluster ID.
    PodCount Integer No

    Number of Pods.
    CreateTime String No

    Cluster creation time.
    RedisCount Integer No

    Number of Redis instances.
    SubmitType Integer No

    Creation type.

    Enumeration values:

    • 1: form creation
    • 2: YAML creation
    DashboardUrl String No

    Head access address, which is also the dashboard address.
    Namespace String No

    Namespace.
    StorageCount Integer No

    Number of volumes mounted by the RayCluster.

    RedisInstance

    Redis instance information.

    Used by actions: DescribeDynamicInstanceDetail.

    Name Type Required Description
    Id String No Redis instance ID.
    Host String No Instance IP address.
    Port Integer No Instance port.

    RenewPriceDetail

    Node sub-item renewal inquiry details.

    Used by actions: InquiryPriceRenewInstance.

    Name Type Description
    BillingName String Billable item name.
    Policy Float Discount.
    Quantity Integer Quantity.
    OriginalCost Float Original price.
    DiscountCost Float Discounted price.

    RepeatStrategy

    Scheduled scaling task policy.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    RepeatType String Yes The valid values DAY, DOW, DOM, and NONE respectively indicate repetition by day, repetition by week, repetition by month, and one-time execution. This parameter is required.
    DayRepeat DayRepeatStrategy No Daily repetition rule, effective when RepeatType is set to DAY.
    WeekRepeat WeekRepeatStrategy No Weekly repetition rule, effective when RepeatType is set to DOW.
    MonthRepeat MonthRepeatStrategy No Monthly repetition rule, effective when RepeatType is set to DOM.
    NotRepeat NotRepeatStrategy No One-time execution rule, effective when RepeatType is set to NONE.
    Expire String No Rule expiration time. After this time is due, the rule will be automatically set to the suspended status. The format is 2020-07-23 00:00:00. It is required.
    StartTime String No Periodic rule start time.

    Resource

    Resource details.

    Used by actions: AddNodeResourceConfig, CreateInstance, DescribeNodeResourceConfigFast, InquiryPriceCreateInstance.

    Name Type Required Description
    Spec String Yes

    Node specification description, such as CVM.SA2.
    StorageType Integer Yes

    Valid values:
    "LOCAL_SSD" 3 // Local SSD
    "CLOUD_SSD" 4 // Cloud SSD
    "CLOUD_PREMIUM" 5 // Premium Disk
    "CLOUD_HSSD" 6 // Enhanced SSD
    "CLOUD_THROUGHPUT" 11// Throughput-Optimized Cloud Disk
    "CLOUD_TSSD" 12 // Tremendous SSD
    "CLOUD_BSSD" 13 // Balanced SSD
    "CLOUD_BIGDATA" 14 // Big Data Cloud Disk
    "CLOUD_HIGHIO" 15 // High-IO Cloud Disk

    This field is invalid. The actual system disk type is determined based on the data disk type and node type. If the node supports the selected data disk type, the system disk type is consistent with the data disk. It is recommended to use the CreateCluster API.
    DiskType String Yes

    Data disk type. Valid values:

    CLOUD_SSD: Cloud SSD

    CLOUD_PREMIUM: Premium Disk

    CLOUD_BASIC: Cloud Basic Disk

    LOCAL_BASIC: Local Basic Disk

    LOCAL_SSD: Local SSD

    CLOUD_HSSD: Enhanced SSD

    CLOUD_THROUGHPUT: Throughput-Optimized Cloud Disk

    CLOUD_TSSD: Tremendous SSD

    CLOUD_BIGDATA: Big Data Cloud Disk

    CLOUD_HIGHIO: High-IO Cloud Disk

    CLOUD_BSSD: Balanced SSD

    REMOTE_SSD: Remote SSD Disk
    MemSize Integer Yes

    Memory capacity (MB).
    Cpu Integer Yes

    Number of CPU cores.
    DiskSize Integer Yes

    Data disk capacity.
    RootSize Integer No

    System disk capacity.
    MultiDisks Array of MultiDisk No

    Cloud disk list. When the data disk is a single cloud disk, use the DiskType and DiskSize parameters directly. Use MultiDisks for extra disks.
    Tags Array of Tag No

    List of tags to be bound.
    InstanceType String No

    Specifications type, such as S2.MEDIUM8.
    LocalDiskNum Integer No

    Number of local disks. This field has been deprecated.
    DiskNum Integer No

    Number of local disks, such as 2.
    GpuDesc String No

    GPU information.
    PartitionNumber Integer No

    Number of partitions in a placement group.
    HCCHpcClusterId String No

    High-performance cluster ID.
    CustomNodeName String No

    Custom hostname.
    GpuImageDriver GpuImageDriverSpec No

    GPU image driver configuration.

    ResourceDetail

    Resource details.

    Used by actions: DescribeInstances.

    Name Type Description
    Spec String Specifications.
    SpecName String Specifications name.
    StorageType Integer Hard disk type.
    DiskType String Hard disk type.
    RootSize Integer System disk size.
    MemSize Integer Memory size.
    Cpu Integer Number of CPU cores.
    DiskSize Integer Hard disk size.
    InstanceType String Specifications.

    RestartPolicy

    Component restart policy.

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    Name String Restart policy name.
    DisplayName String Policy display name.
    Describe String Policy description.
    BatchSizeRange Array of Integer Optional range for the number of nodes restarted in batches.
    IsDefault String Whether it is the default policy.

    ResultItem

    Response result of the user group.

    Used by actions: CreateGroupsSTD, DeleteGroupsSTD.

    Name Type Required Description
    Item String No User group name.
    Result Boolean No Whether the user group is created successfully.
    Reason String No If the creation fails, specify the reason for the failure.

    SLInstance

    Serverless Instance

    Used by actions: DescribeSLInstance.

    Name Type Description
    InstanceId String EMR Instance Id
    ClusterId Integer EMR Numeric Instance Id
    InstanceName String Instance Name
    RegionId Integer Region id
    Zone String Zone Name
    PayMode Integer Pay Mode
    DiskType String Disk Type
    DiskSize Integer Disk Size
    NodeType String Node Type
    NodeNum Integer Node Number
    ExpireTime String Expire Time
    IsolateTime String Isolate Time
    CreateTime String Create Time
    AutoRenewFlag Integer Auto Renew Flag
    Status Integer EMR Numeric Instance Status
    ZoneSettings Array of ZoneSetting Zone Setting
    Tags Array of Tag Bound Tags
    DeployRole String Deploy Role

    SLInstanceInfo

    Serverless HBase instance information.

    Used by actions: DescribeSLInstanceList.

    Name Type Description
    ClusterId String Cluster string ID.
    Id Integer Cluster ID.
    StatusDesc String Status description.
    HealthStatus String Health status.
    ClusterName String Instance name.
    RegionId Integer Region ID.
    ZoneId Integer Primary AZ ID.
    Zone String Primary AZ.
    AppId Integer User APPID.
    VpcId Integer Primary AZ VPC ID.
    VpcName String Primary AZ VPC name.
    SubnetId Integer Primary AZ subnet ID.
    SubnetName String Primary AZ subnet name.
    Status Integer Status code.
    AddTime String Creation time.
    PayMode Integer Cluster billing type. 0 indicates pay-as-you-go. 1 indicates yearly/monthly subscription.
    ZoneSettings Array of ZoneSetting Multi-AZ information.
    Tags Array of Tag Instance tag.
    AutoRenewFlag Integer Auto-renewal flag. Valid values: 0 (notify before expiration but do not auto-renew), 1 (notify before expiration and auto-renew), and 2 (do not notify before expiration and do not auto-renew). If the business does not support renewal, the value is 0.
    IsolateTime String Isolation time. For instances that are not isolated, 0000-00-00 00:00:00 is returned.
    ExpireTime String Expiration time. For postpaid instances, 0000-00-00 00:00:00 is returned.
    DeployRole String Primary/standby deployment role.
    WebUIUrl String WebUI address.

    ScaleOutNodeConfig

    Scale-out node type and quantity.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    NodeFlag String Yes Valid values for the scale-out node type:
  • MASTER

  • TASK

  • CORE

  • ROUTER
    		•
    NodeCount Integer Yes Number of scale-out nodes.

    ScaleOutServiceConfGroupsInfo

    Configuration group specified for scale-out.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    ServiceComponentName String No Component version name, for example, HDFS-2.8.5.
    ConfGroupName String No Configuration group name, such as hdfs-core-defaultGroup. The ConfGroupName parameter is passed in to represent the configuration group dimension.
    If the ConfGroupName parameter is not passed, the cluster dimension is used.

    SceneSoftwareConfig

    Cluster application scenario and supported deployment component information.

    Used by actions: CreateCluster.

    Name Type Required Description
    Software Array of String Yes List of deployed components. Different EMR product versions (ProductVersion) have different optional component lists. For details about how to query the optional component lists for different product versions, see Component Version.
    Example values: hive and flink.
    SceneName String No Default Hadoop-Default. For details about the scenario-based values, see Scenario Query:
    Hadoop-Kudu
    Hadoop-Zookeeper
    Hadoop-Presto
    Hadoop-Hbase
    Hadoop-Default

    SchedulerTaskDetail

    Scheduling task details.

    Used by actions: DescribeYarnScheduleHistory.

    Name Type Description
    Step String Step.
    Progress String Progress.
    FailReason String Failure information.
    JobId Integer ID used to obtain details.

    SchedulerTaskInfo

    YARN resource scheduling history.

    Used by actions: DescribeYarnScheduleHistory.

    Name Type Description
    SchedulerName String Scheduler type.
    OperatorName String Operation type.
    CreateTime String Start time.
    EndTime String End time.
    State Integer Status.
    Details Array of SchedulerTaskDetail Details.

    ScriptBootstrapActionConfig

    Bootstrap addition.

    Used by actions: CreateCluster, ScaleOutCluster.

    Name Type Required Description
    CosFileURI String Yes COS address of the script. Format: https://beijing-111111.cos.ap-beijing.myqcloud.com/data/test.sh. To query the COS bucket list, refer to Bucket List.
    ExecutionMoment String Yes Time range for the bootstrap script execution.
  • resourceAfter: after node initialization
  • clusterAfter: after cluster startup
  • clusterBefore: before cluster startup
    		•
    Args Array of String No Execution script parameters. For the parameter format, follow standard Shell specifications.
    CosFileName String No Script file name.
    Remark String No Remarks.

    SearchItem

    Searching field.

    Used by actions: DescribeClusterNodes, DescribeInstanceOplog, DescribeServiceNodeInfos.

    Name Type Required Description
    SearchType String Yes Searchable type.
    SearchValue String Yes Searchable value.

    ServiceBasicRestartInfo

    Scope of service operations.

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    ServiceName String No Service name, required. Example: HDFS.
    ComponentInfoList Array of ComponentBasicRestartInfo No If not provided, it indicates all processes.

    ServiceDeploy

    Node deployment configuration information, which is provided for the Terraform team.

    Used by actions: ScaleOutCluster.

    Name Type Required Description
    SoftwareName String No

    Component name.
    Roles Array of String No

    Role name under the component.

    ServiceDeployInfo

    Service deployment information.

    Used by actions: InstallSoftware.

    Name Type Required Description
    ServiceName String No Service name.
    ComponentDeployInfoList Array of ComponentDeployInfo No List of role deployment information.

    ServiceNodeDetailInfo

    Service process information.

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    Ip String Process node IP address.
    NodeType Integer Process type.
    NodeName String Process name.
    ServiceStatus Integer Service component status.
    MonitorStatus Integer Process monitoring status.
    Status Integer Service component status.
    PortsInfo String Process port information.
    LastRestartTime String Latest restart time.
    Flag Integer Node type.
    ConfGroupId Integer Configuration group ID.
    ConfGroupName String Configuration group name.
    ConfStatus Integer Whether the node needs to be restarted.
    ServiceDetectionInfo Array of ServiceProcessFunctionInfo Process detection information.
    NodeFlagFilter String Node type.
    HealthStatus HealthStatus Process health status.
    IsSupportRoleMonitor Boolean Whether the role supports monitoring.
    StopPolicies Array of RestartPolicy Suspension policy.
    HAState String Strong validation of the API in a test environment. This strong validation does not exist on the current network, but it does exist in the data returned by the emrcc API. If it is not applied, an error will be reported.
    NameService String NameService name.
    IsFederation Boolean Whether the federation is supported.
    DataNodeMaintenanceState Integer Whether the DataNode is in the maintenance status.

    ServiceProcessFunctionInfo

    Process detection information.

    Used by actions: DescribeServiceNodeInfos.

    Name Type Description
    DetectAlert String Detection alarm level.
    DetectFunctionKey String Detection feature description.
    DetectFunctionValue String Detection feature result.
    DetectTime String Detection result.

    ShortNodeInfo

    Node information.

    Used by actions: DescribeInstances.

    Name Type Required Description
    NodeType String No Node type. Valid values: Master/Core/Task/Router/Common.
    NodeSize Integer No Number of nodes.

    SoftDependInfo

    External client component dependency information.

    Used by actions: DescribeInstancesList.

    Name Type Description
    SoftName String Component name.
    Required Boolean Whether it is required.

    SparkApplicationsList

    Spark task list.

    Used by actions: DescribeSparkApplications.

    Name Type Description
    ID String Application ID.
    Name String Application name.
    User String User.
    StartTime Integer Start time.
    EndTime Integer End time.
    Duration Integer Duration.
    State String Status.
    ApplicationType String Type.
    CoreSeconds Integer Number of cores multiplied by seconds.
    MemorySeconds String Memory MB multiplied by seconds.
    Insight String Insight result.

    SparkQuery

    Spark query details.

    Used by actions: DescribeSparkQueries.

    Name Type Description
    Statement String Execution statement.
    Duration Integer Execution duration (ms).
    Status String Execution status.
    Id String Query ID.
    ScanPartitionNum Integer Number of scanned partitions.
    ScanRowNum Integer Total number of scanned rows.
    ScanFileNum Integer Total number of scanned files.
    ScanTotalData Integer Total scanned and queried data volume (bytes).
    ApplicationId Array of String Application ID.
    OutputRowNum Integer Total number of output rows.
    OutputFileNum Integer Total number of output files.
    OutputPartitionNum Integer Number of output partitions.
    OutputTotalData Integer Total output data volume (bytes).
    BeginTime Integer Start time.
    EndTime Integer End time.

    StageInfoDetail

    Task step details.

    Used by actions: DescribeClusterFlowStatusDetail.

    Name Type Description
    Stage String Step.
    Name String Step name.
    IsShow Boolean Whether it is displayed.
    IsSubFlow Boolean Whether it is a sub-flow.
    SubFlowFlag String Sub-flow tag.
    Status Integer Step running status. Valid values: 0 (not started), 1 (in progress), 2 (completed), 3 (partially completed), and -1 (failed).
    Desc String Step running status description.
    Progress Float Running progress.
    Starttime Timestamp Start time.
    Endtime Timestamp End time.
    HadWoodDetail Boolean Whether detailed information is included.
    WoodJobId Integer Wood sub-flow ID.
    LanguageKey String Multi-language version key.
    FailedReason String Reason for the stage failure.
    TimeConsuming String Step duration.
    Id Integer ID used by the frontend.

    StarRocksQueryInfo

    StarRocks query information.

    Used by actions: DescribeStarRocksQueryInfo.

    Name Type Description
    ClientIP String Submission IP address.
    CPUCost Integer Total CPU time (ns).
    DefaultDB String Default database.
    EndTime Integer End time.
    ExecutionIP String Execution IP address.
    QueryID String Query ID.
    QueryType String Query type.
    MemCost Integer Total memory consumed (bytes).
    PlanCpuCosts Integer CPU consumption in the plan phase (ns).
    PlanMemCosts Integer Memory consumption in the plan phase (bytes).
    QueryTime Integer Execution duration.
    ResourceGroup String Resource group.
    ReturnRows Integer Number of rows obtained.
    ScanBytes Integer Scanned data volume (bytes).
    ScanRows Integer Number of scanned rows.
    BeginTime Integer Start time.
    ExecutionState String Execution status.
    ExecutionStatement String Execution statement.
    User String User.
    ErrorCode String Error code.

    StopParams

    Parameters used for stopping services.

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    StopPolicy String No Security mode: safe.
    Default mode: default.
    ThreadCount Integer No Number of threads.
    GraceDownTime Integer No Graceful stop timeout period (s).

    StorageSummaryDistribution

    HDFS file storage details.

    Used by actions: DescribeHDFSStorageInfo.

    Name Type Required Description
    MetricItem String No Data item.
    MetricName String No Data item description.
    Dps Array of Dps No Sampling value.

    StorageVolumeDetail

    Storage volume details.

    Used by actions: DescribeDynamicInstanceDetail.

    Name Type Required Description
    VolumeName String No Storage volume name.
    VolumeType String No Storage volume type.
    Desc String No Storage volume details.

    StrategyConfig

    Configuration for restarting services/stopping services/starting services/monitoring data.

    Used by actions: StartStopServiceOrMonitor.

    Name Type Required Description
    RollingRestartSwitch Integer No 0: disables rolling restart.
    1: enables rolling start.
    BatchSize Integer No Number of instances to restart per batch for rolling restart. Maximum value: 99999.
    TimeWait Integer No Stop and wait time for rolling restart per batch. Maximum interval: 5 minutes. Unit: seconds.
    DealOnFail Integer No Operation failure processing policy. Valid values: 0 (blocking upon the failure) and 1 (automatically skipping the failure).
    Args Array of Arg No Parameters required in the instruction.

    StringMap

    Common string map.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Key String No

    Key.
    Value String No

    Value.

    SubnetInfo

    Subnet information.

    Used by actions: DescribeClusterNodes, DescribeInstances.

    Name Type Required Description
    SubnetName String No Subnet information (name).
    SubnetId String No Subnet information (ID).

    TableSchemaItem

    Table schema information.

    Used by actions: DescribeHBaseTableOverview.

    Name Type Description
    Name String Column identifier.
    Sortable Boolean Whether it is sortable by this column.
    WithFilter Boolean Whether it is filterable.
    Candidates Array of String Filtered candidate set.
    Clickable Boolean Whether it is clickable.
    Title String Display name.

    Tag

    Tag.

    Used by actions: AddMetricScaleStrategy, AddNodeResourceConfig, CreateCluster, CreateInstance, CreateSLInstance, DescribeAutoScaleStrategies, DescribeClusterNodes, DescribeInstances, DescribeInstancesList, DescribeSLInstance, DescribeSLInstanceList, InquiryPriceScaleOutInstance, InstallSoftware, ModifyAutoScaleStrategy, ModifyResourcesTags, ScaleOutCluster, ScaleOutInstance.

    Name Type Required Description
    TagKey String No Tag key.
    TagValue String No Tag value.

    TagInfo

    Tag information.

    Used by actions: DescribeNodeDataDisks.

    Name Type Required Description
    Key String No Tag key.
    Value String No Tag value.

    Taint

    Kubernetes Taint

    Used by actions: ScaleOutInstance.

    Name Type Required Description
    Key String No Taint Key
    Value String No Taint Value
    Effect String No Taint Effect

    TaskSettings

    Inspection task parameter.

    Used by actions: ModifyInspectionSettings.

    Name Type Required Description
    Name String No Parameter name.
    Value String No Parameter value.
    Key String No Unique parameter identifier.
    Editable String No Whether it is editable. Valid values: true and false.

    TimeAutoScaleStrategy

    Rule for time-based scaling.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    StrategyName String Yes Policy name, which is unique within one cluster.
    IntervalTime Integer Yes Cooldown time after the policy is triggered, during which auto scaling cannot be triggered.
    ScaleAction Integer Yes Scaling action. Valid values: 1 (scale-out) and 2 (scale-in).
    ScaleNum Integer Yes Number of scaling operations.
    StrategyStatus Integer Yes (Required) Rule status. Valid values: 1 (valid), 2 (invalid), and 3 (suspended).
    Priority Integer Yes Rule priority. A smaller value indicates a higher priority.
    RetryValidTime Integer Yes When multiple rules are triggered at the same time and some are not really executed, retries are performed within this time range.
    RepeatStrategy RepeatStrategy Yes Time scaling repetition policy.
    StrategyId Integer No Unique policy ID.
    GraceDownFlag Boolean No Graceful scale-in switch.
    GraceDownTime Integer No Graceful scale-in wait time.
    GraceDownProtectFlag Boolean No Whether to enable task protection.
    Tags Array of Tag No Bound tag list.
    ConfigGroupAssigned String No Preset configuration group.
    MeasureMethod String No Calculation method for scaled‑out resources. Valid values: "DEFAULT", "INSTANCE", "CPU", and "MEMORYGB".
    "DEFAULT" indicates the default calculation method, which is identical to "INSTANCE".
    "INSTANCE" indicates the calculation method based on nodes. This is the default method.
    "CPU" indicates the calculation method based on the number of cores of the machine.
    "MEMORYGB" indicates the calculation method based on the memory size of the machine.
    TerminatePolicy String No Termination policy. "DEFAULT" indicates the default policy with which the scale-in is triggered by using scale-in rules. "TIMING" indicates scheduled termination.
    MaxUse Integer No Maximum usage time. The minimum value is 1 hour, and the maximum value is 24 hours.
    SoftDeployInfo Array of Integer No List of services deployed on the node. Valid values: HDFS and YARN. For details, see Mapping Table for Component Names.
    ServiceNodeInfo Array of Integer No Startup process list.
    CompensateFlag Integer No Compensatory scale-out. Valid values: 0 (disabled) and 1 (enabled).
    GroupId Integer No Scaling group ID.
    GraceDownLabel Array of TkeLabel No Pod tag for the graceful scale-in business. Nodes are scaled in when the Pod mentioned above is not found on the node or the graceful scale-in time has elapsed.
    GraceDownProtectTime Integer No Task protection time.

    TkeLabel

    Kubernetes Label

    Used by actions: AddMetricScaleStrategy, CreateDynamicInstance, DescribeAutoScaleStrategies, InstallSoftware, ModifyAutoScaleStrategy, ModifyDynamicInstance, ScaleOutInstance.

    Name Type Required Description
    Name String No Label Name
    Value String No Label Value

    Toleration

    Tolerations

    Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    Key String No Key.
    Value String No Value.
    Operator String No Operator.
    Effect String No Taint repel effect.
    TolerationSeconds Integer No Eviction wait time.

    TopologyInfo

    Cluster node topology information.

    Used by actions: DescribeInstances.

    Name Type Required Description
    ZoneId Integer No AZ ID.
    Zone String No AZ information.
    SubnetInfoList Array of SubnetInfo No Subnet information.
    NodeInfoList Array of ShortNodeInfo No Node information.

    TopologySpreadConstraint

    Scheduling topology distribution.

    Used by actions: InstallSoftware.

    Name Type Required Description
    MaxSkew Integer No

    Maximum deviation value.
    TopologyKey String No

    Topology domain key.
    WhenUnsatisfiable String No

    Handling policy, which is used when constraints are not met.
    LabelSelector LabelSelector No

    Tag selector.
    MinDomains Integer No

    Minimum number of topology domains.
    NodeAffinityPolicy String No

    Node affinity policy.
    NodeTaintsPolicy String No

    Node taint policy.
    MatchLabelKeys Array of String No

    List of tag keys to be matched.

    TriggerCondition

    Rule trigger condition.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    CompareMethod Integer Yes Condition comparison method. Valid values: 1 for greater than, 2 for less than, 3 for greater than or equal to, and 4 for less than or equal to.
    Threshold Float No Condition threshold.

    TrinoQueryInfo

    Trino query information.

    Used by actions: DescribeTrinoQueryInfo.

    Name Type Description
    Catalog String catalog
    ClientIpAddr String Submission IP address.
    CompletedSplits String Number of segments.
    CpuTime Integer CPU time.
    CumulativeMemory Integer Cumulative memory.
    DurationMillis Integer Execution duration.
    EndTime Integer End time (s).
    Id String Query ID.
    InternalNetworkBytes Integer Internal transmission volume.
    OutputBytes Integer Number of output bytes.
    PeakUserMemoryBytes Integer Peak memory.
    PhysicalInputBytes Integer Physical input volume.
    ProcessedInputBytes Integer Processed input volume.
    SqlCompileTime Integer Compilation duration.
    StartTime Integer Start time (s).
    State String Execution status.
    Statement String Execution statement.
    User String Submission user.
    WrittenBytes Integer Number of bytes written.
    ErrorMessage String Error log.

    UpdateInstanceSettings

    Changed resource specifications.

    Used by actions: InquiryPriceUpdateInstance.

    Name Type Required Description
    Memory Integer Yes Memory capacity, in GB.
    CPUCores Integer Yes Number of CPU cores.
    ResourceId String Yes Machine resource ID (EMR resource identifier).
    InstanceType String No Changed machine specifications.

    UserInfoForUserManager

    List of added user information.

    Used by actions: AddUsersForUserManager.

    Name Type Required Description
    UserName String Yes Username.
    UserGroup String Yes Group to which the user belongs.
    PassWord String Yes Password.
    ReMark String No Remarks.
    Groups Array of String No User subgroup.

    UserManagerFilter

    User management list filter.

    Used by actions: DescribeUsersForUserManager.

    Name Type Required Description
    UserName String No Username.
    UserType String No User source.
    Groups String No Group name.

    UserManagerUserBriefInfo

    Brief information of users in user management.

    Used by actions: DescribeUsersForUserManager.

    Name Type Description
    UserName String

    Username.
    UserGroup String

    Group to which the user belongs.
    UserType String

    Manager indicates an administrator, and NormalUser indicates a regular user.
    CreateTime String

    User creation time.
    SupportDownLoadKeyTab Boolean

    Whether to download the keytab file of the corresponding user. This is only meaningful for clusters with Kerberos enabled.
    DownLoadKeyTabUrl String

    Download URL of the keytab file.
    Groups Array of String

    User group.
    Uin String

    Customer UIN.
    State Integer

    User status.
    DisplayPasswdUpdateTime Boolean

    Whether to display the password update time.
    PasswdUpdateTime String

    Latest password update time.
    PasswdUsedDay Integer

    Number of days used.

    Unit: days.
    PasswdUsedHour Integer

    Number of hours used.

    Unit: hours.

    VPCSettings

    VPC parameter.

    Used by actions: CreateInstance, CreateSLInstance, DescribeSLInstance, DescribeSLInstanceList, InquiryPriceCreateInstance, InstallSoftware.

    Name Type Required Description
    VpcId String Yes VPC ID
    SubnetId String Yes Subnet ID

    VirtualPrivateCloud

    VPC parameter.

    Used by actions: CreateCluster.

    Name Type Required Description
    VpcId String Yes VPC ID
    SubnetId String Yes Subnet ID

    VolumeMount

    Mount volume.

    Used by actions: CreateDynamicInstance, DescribeDynamicInstanceDetail, InstallSoftware, ModifyDynamicInstance.

    Name Type Required Description
    MountName String No Mount volume name.
    MountPath String No Mount path.
    SubPathMode String No Mount type.
    SubPath String No Sub-path.
    MountMode String No Mounting mode. Valid values: ReadWrite and OnlyRead.

    VolumeSetting

    Data volume directory settings.

    Used by actions: InstallSoftware.

    Name Type Required Description
    VolumeType String No Data volume type.
  • HOST_PATH indicates support for the local path.
  • NEW_PVC indicates creating a PVC.

    • For the data volume types supported by component roles, see the EMR on TKE cluster deployment instructions: Deployment Instructions.
    HostPath HostPathVolumeSource No Host path information.

    WebUIInfo

    WebUI access information.

    Used by actions: DescribeDynamicInstanceList.

    Name Type Required Description
    Url String No

    Access address, which may be left empty.
    WebUIStatus Integer No

    WebUI status. Valid values:
    -1: indicates that the current service does not have WebUI;
    0: indicates that the current service has WebUI but does not have the KNOX service installed;
    1: indicates that the current service has WebUI and has the KNOX service installed, but it does not have public network access enabled for the KNOX service;
    2: indicates that the current service has WebUI, has the KNOX service installed, and has public network access enabled.
    ServiceName String No

    Service name.

    WeekRepeatStrategy

    Weekly repetition task policy for scheduled scale-outs.

    Used by actions: AddMetricScaleStrategy, DescribeAutoScaleStrategies, ModifyAutoScaleStrategy.

    Name Type Required Description
    ExecuteAtTimeOfDay String Yes Specific time for repetition task execution, for example, 01:02:00.
    DaysOfWeek Array of Integer Yes Description of the day within a week. For example, [1,3,4] indicates Monday, Wednesday, and Thursday.

    WeightedPodAffinityTerm

    Weighted Pod affinity item.

    Used by actions: InstallSoftware.

    Name Type Required Description
    Weight Integer No

    Weight.
    PodAffinityTerm PodAffinityTerm No

    Pod affinity condition.

    ZoneDetailPriceResult

    Price list for cluster creation, which contains price details in different AZs.

    Used by actions: InquiryPriceCreateInstance.

    Name Type Description
    ZoneId String AZ ID.
    NodeDetailPrice Array of NodeDetailPriceResult Price details for different nodes.

    ZoneResourceConfiguration

    AZ configuration information.

    Used by actions: CreateCluster.

    Name Type Required Description
    VirtualPrivateCloud VirtualPrivateCloud No VPC-related information configuration. This parameter can be used to specify the VPC ID and subnet ID.
    Placement Placement No Location of the instance. This parameter can be used to specify attributes such as the AZ and associated project of the instance.
    AllNodeResourceSpec AllNodeResourceSpec No Specifications of all node resources.
    ZoneTag String No In single-AZ deployment, ZoneTag can be left empty. In dual-AZ deployment mode, select master for the first AZ's ZoneTag and standby for the second. In three-AZ deployment mode, select master for the first AZ's ZoneTag, standby for the second, and third-party for the third. Valid values:
  • master

  • standby

  • third-party
    		•

    ZoneSetting

    AZ configuration description.

    Used by actions: CreateSLInstance, DescribeSLInstance, DescribeSLInstanceList.

    Name Type Required Description
    Zone String Yes AZ name.
    VPCSettings VPCSettings Yes AZ VPC and subnet.
    NodeNum Integer Yes Number of AZ nodes.
    Topik sebelumnya: DescribeYarnQueueTopik selanjutnya: Error Codes

    Bantuan dan Dukungan

    Apakah halaman ini membantu?

    masukan

    Search
      Enter keywords to search documentation