Creating a Cluster

VPC

See operation instructions in Querying VPCs and Creating a VPC in the VPC API Reference.

Subnet

See operation instructions in Querying Subnets and Creating a Subnet in the VPC API Reference.

Key Pair

See operation instructions in Querying SSH Key Pairs and Creating and Importing an SSH Key Pair in the ECS API Reference.

Zone

See Endpoints for details about regions and AZs.

Version

Currently, MRS 1.9.2, 3.1.0, 3.1.5, 3.1.2-LTS.3, and 3.2.0-LTS.1 are supported.

Component

• MRS 3.2.0-LTS.1 supports the following components:
  • An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, and Guardian.
  • A streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger.
  • A hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, Kafka, Flume, and Guardian.
  • A custom cluster contains the following components: CDL, Hadoop, Spark2x, HBase, Hive, Hue, IoTDB, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, and ClickHouse, and Guardian.
• MRS 3.1.5 supports the following components:
  • An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, Kudu, Sqoop, and Guardian
  • A streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger.
  • A hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, Kudu, Sqoop, Guardian, Kafka, and Flume.
  • A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, ClickHouse, Kudu, Sqoop, and Guardian.
• MRS 3.1.2-LTS.3 supports the following components:
  • An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, and Tez.
  • A streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger.
  • A hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, Kafka, and Flume.
  • A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, and ClickHouse.
• MRS 3.1.0 supports the following components:
  • An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, and Kudu.
  • A streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger.
  • A hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, Kudu, Kafka, and Flume.
  • A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, ClickHouse, and Kudu.
• MRS 3.0.5 supports the following components:
  • An analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, Kudu, and Alluxio.
  • A streaming cluster contains the following components: Kafka, Storm, Flume, ZooKeeper, and Ranger.
  • A hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, Kudu, Alluxio, Kafka, Storm, and Flume.
  • A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, Loader, Kafka, Storm, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, Impala, Presto, ClickHouse, Kudu, and Alluxio.
• MRS 2.1.0 supports the following components:
  • An analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Hive, Hue, Loader, Tez, Impala, Kudu, and Flink.
  • A streaming cluster contains the following components: Kafka, Storm, and Flume.
• MRS 1.9.2 supports the following components:
  • An analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, OpenTSDB, Hive, Hue, Loader, Tez, Flink, Alluxio, and Ranger.
  • A streaming cluster contains the following components: Kafka, KafkaManager, Storm, and Flume.

cluster_version

Yes

String

Explanation

Cluster version.

Constraints

None

Value range

• MRS 1.9.2
• MRS 3.1.0
• MRS 3.1.2-LTS.3
• MRS 3.1.5
• MRS 3.2.0-LTS.1

Default value

N/A

cluster_name

Yes

String

Explanation

Cluster name

Constraints

N/A

Value range

• The cluster name must globally unique.
• The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

cluster_type

Yes

String

Explanation

Cluster type.

Constraints

N/A

Value range

• ANALYSIS: analysis cluster
• STREAMING: streaming cluster
• MIXED: hybrid cluster
• CUSTOM: custom cluster, which is supported only by MRS 3.x.

Default value

N/A

charge_info

No

object

Explanation

The billing type. For details, see Table 5.

Constraints

N/A

region

Yes

String

Explanation

Information about the region where the cluster is located. For details, see Endpoints.

Constraints

N/A

Value range

N/A

Default value

N/A

is_dec_project

No

Boolean

Explanation

Whether the cluster is specific for the DeC.

Constraints

N/A

Value range

• true: The resource is a DeC resource.
• false: The resource is not a DeC resource.

Default value

false

vpc_name

Yes

String

Explanation

Name of the VPC where the subnet locates. Perform the following operations to obtain the VPC name from the VPC management console:

1. Log in to the management console.
2. Choose Virtual Private Cloud > My VPCs. On the Virtual Private Cloud page, obtain the VPC name from the list.

Constraints

N/A

Value range

N/A

Default value

N/A

subnet_id

No

String

Explanation

Subnet ID, which can be obtained by performing the following operations on the VPC management console:

1. Log in to the VPC management console.
2. Choose Virtual Private Cloud > My VPCs.
3. Locate the row that contains the target VPC and click the number in the Subnets column to view the subnet information.
4. Click the subnet name to obtain the network ID.

Constraints

At least one of subnet_id and subnet_name must be configured. If the two parameters are configured but do not match the same subnet, the cluster fails to create. subnet_id is recommended.

Value range

N/A

Default value

N/A

subnet_name

Yes

String

Subnet name. Perform the following operations to obtain the subnet name from the VPC management console:

1. Log in to the management console.
2. Choose Virtual Private Cloud > My VPCs.
3. Locate the row that contains the target VPC and click the number in the Subnets column to obtain the subnet name.

Constraints

At least one of subnet_id and subnet_name must be configured. If the two parameters are configured but do not match the same subnet, the cluster fails to create. If only subnet_name is configured and subnets with the same name exist in the VPC, the first subnet name in the VPC is used when a cluster is created. subnet_id is recommended.

Value range

N/A

Default value

N/A

components

Yes

String

Explanation

List of component names, which are separated by commas (,). For details about the component names, see the component list of each version in Table 1.

Constraints

N/A

Value range

N/A

Default value

N/A

external_datasources

No

Array of ClusterDataConnectorMap objects

Explanation

When deploying components such as Hive and Ranger, you can associate data connections and store metadata in associated databases. For details about the parameters, see Table 4.

Constraints

N/A

availability_zone

Yes

String

Explanation

AZ name. Multi-AZ clusters are not supported.

See Endpoints for details about AZs.

Constraints

N/A

Value range

N/A

Default value

N/A

security_groups_id

No

String

Explanation

Security group ID of the cluster.

• If this parameter is left blank, MRS automatically creates a security group, whose name starts with mrs_{cluster_name}.
• If this parameter is specified, a fixed security group is used to create a cluster. The passed ID must be the security group ID in the current tenant.
• Multiple security group IDs are supported and separated by commas (,).

Constraints

N/A

Value range

N/A

Default value

N/A

auto_create_default_security_group

No

Boolean

Explanation

Whether to create the default security group for the MRS cluster.

Constraints

If this parameter is set to true, the default security group will be created for the cluster regardless of whether security_groups_id is specified.

Value range

• true: The default security group is created for the MRS cluster.
• false: The default security group is not created.

Default value

false

safe_mode

Yes

String

Explanation

Run mode of an MRS cluster.

Constraints

N/A

Value range

• SIMPLE: normal cluster. In a normal cluster, Kerberos authentication is disabled, and users can use all functions provided by the cluster.
• KERBEROS: security cluster. In a security cluster, Kerberos authentication is enabled, and common users cannot use the file management and job management functions of an MRS cluster or view cluster resource usage and the job records of Hadoop and Spark. To use more functions, the users must obtain the relevant permissions from the Manager administrator.

Default value

N/A

manager_admin_password

Yes

String

Explanation

Password of the MRS Manager administrator.

Constraints

N/A

Value range

Default value

N/A

login_mode

Yes

String

Explanation

Node login mode.

Constraints

N/A

Value range

• PASSWORD: password-based login. If this value is selected, node_root_password cannot be left blank.
• KEYPAIR: specifies the key pair used for login. If this value is selected, node_keypair_name cannot be left blank.

Default value

N/A

node_root_password

No

String

Explanation

Password of user root for logging in to a cluster node.

Constraints

N/A

Value range

Default value

N/A

node_keypair_name

No

String

Explanation

Name of a key pair You can use a key pair to log in to the Master node in the cluster.

Constraints

N/A

Value range

N/A

Default value

N/A

enterprise_project_id

No

String

Explanation

Enterprise project ID.

When you create a cluster, associate the enterprise project ID with the cluster.

The default value is 0, indicating the default enterprise project.

To obtain the enterprise project ID, see the id value in the enterprise_project field data structure table in section Querying the Enterprise Project List of the Enterprise Management API Reference.

Constraints

N/A

Value range

N/A

Default value

The default value is 0, indicating the default enterprise project.

eip_address

No

String

Explanation

An EIP bound to an MRS cluster can be used to access MRS Manager. The EIP must have been created and must be in the same region as the cluster.

Constraints

N/A

Value range

N/A

Default value

N/A

eip_id

No

String

Explanation

ID of the bound EIP. This parameter is mandatory when eip_address is configured. To obtain the EIP ID, log in to the VPC console, choose Network > Elastic IP and Bandwidth > Elastic IP, click the EIP to be bound, and obtain the ID in the Basic Information area.

Constraints

N/A

Value range

N/A

Default value

N/A

mrs_ecs_default_agency

No

String

Explanation

Name of the agency bound to a cluster node by default. The value is fixed to MRS_ECS_DEFAULT_AGENCY.

An agency allows ECS or BMS to manage MRS resources. You can configure an agency of the ECS type to automatically obtain the AK/SK to access OBS.

The MRS_ECS_DEFAULT_AGENCY agency has the OBS OperateAccess permission of OBS and the CES FullAccess (for users who have enabled fine-grained policies), CES Administrator, and KMS Administrator permissions in the region where the cluster is located.

Constraints

N/A

Value range

N/A

Default value

N/A

template_id

No

String

Explanation

Template used for node deployment when the cluster type is CUSTOM.

• mgmt_control_combined_v2: template for jointly deploying the management and control nodes. The management and control roles are co-deployed on the Master node, and data instances are deployed in the same node group. This deployment mode applies to scenarios where the number of control nodes is less than 100, reducing costs.
• mgmt_control_separated_v2: The management and control roles are deployed on different master nodes, and data instances are deployed in the same node group. This deployment mode is applicable to a cluster with 100 to 500 nodes and delivers better performance in high-concurrency load scenarios.
• mgmt_control_data_separated_v2: The management role and control role are deployed on different Master nodes, and data instances are deployed in different node groups. This deployment mode is applicable to a cluster with more than 500 nodes. Components can be deployed separately, which can be used for a larger cluster scale.

Constraints

N/A

Value range

N/A

Default value

N/A

tags

No

Array of tag objects

Explanation

Cluster tag For more parameter description, see Table 6.

Constraints

A cluster allows a maximum of 10 tags. A tag name (key) must be unique in a cluster.

log_collection

No

Integer

Explanation

Whether to collect logs when cluster creation fails.

Constraints

N/A

Value range

• 0: Do not create an OBS bucket only for log collection when a cluster fails to be created.
• 1: Create an OBS bucket only for collect logs when a cluster fails to be created.

Default value

1

node_groups

Yes

Array of NodeGroupV2 objects

Explanation

Information about the node groups in the cluster. For details about the parameters, see Table 7.

Constraints

N/A

bootstrap_scripts

No

Array of BootstrapScript objects

Explanation

Bootstrap action script information. For more parameter description, see Table 9.

MRS 3.x does not support this parameter.

Constraints

N/A

add_jobs

No

Array of add_jobs objects

Explanation

You can submit a job when creating a cluster. Currently, only versions earlier than MRS 1.8.7 support this function. Currently, only one job can be submitted. You are advised to use the steps parameter in the Creating a Cluster and Submitting a Job API. For details about this parameter, see Table 10.

Constraints

There must be no more than 1 record.

log_uri

No

String

Explanation

The OBS path to which cluster logs are dumped. After the log dump function is enabled, the read and write permissions on the OBS path are required to upload logs. Configure the default agency MRS_ECS_DEFULT_AGENCY or customize an agency with the read and write permissions on the OBS path. For details, see Configuring a Storage-Compute Decoupled Cluster (Agency). This parameter is available only for cluster versions that support dumping cluster logs to OBS.

Constraints

N/A

Value range

N/A

Default value

N/A

component_configs

No

Array of ComponentConfig objects

Explanation

The custom configuration of cluster components. This parameter applies only to cluster versions that support the feature of creating a cluster by customizing component configurations. For details about this parameter, see ComponentConfig.

Constraints

The number of records cannot exceed 50.

smn_notify

No

SmnNotify object

Explanation

SMN alarm notifications. For details about this parameter, see Table 18.

Constraints

N/A

map_id

No

Integer

Explanation

Data connection association ID

Constraints

N/A

Value range

N/A

Default value

N/A

connector_id

No

String

Explanation

Data connection ID

Constraints

N/A

Value range

N/A

Default value

N/A

component_name

No

String

Explanation

Component name

Constraints

N/A

Value range

N/A

Default value

N/A

role_type

No

String

Explanation

Component role type.

Constraints

N/A

Value range

• hive_metastore: Hive Metastore role
• hive_data: Hive role
• hbase_data: HBase role
• ranger_data: Ranger role

Default value

N/A

source_type

No

String

Explanation

Data connection type.

Constraints

N/A

Value range

• LOCAL_DB: local metadata
• RDS_POSTGRES: RDS PostgreSQL database
• RDS_MYSQL: RDS MySQL database
• gaussdb-mysql: GaussDB(for MySQL)

Default value

N/A

cluster_id

No

String

Explanation

ID of the associated cluster

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Default value

N/A

status

No

Integer

Explanation

Data connection status.

Constraints

N/A

Value range

• 0: normal
• 1: in use

Default value

N/A

charge_mode

Yes

String

Explanation

Billing mode.

Constraints

N/A

Value range

• prePaid: indicates the yearly/monthly billing mode. (This mode is now supported for the API for creating a cluster, but is not supported for the API for creating a cluster and submitting a job.)
• postPaid: indicates the pay-per-use billing mode.

Default value

N/A

period_type

No

String

Explanation

Period type.

Constraints

N/A

Value range

• month: The cluster is billed by month.
• year: The cluster is billed by year.
• day: The cluster is billed on a pay-per-use basis.

Default value

N/A

period_num

No

Integer

Explanation

Number of periods.

Constraints

This parameter is valid and mandatory only when charge_mode is set to prePaid.

Value range

• If period_type is set to month, the value ranges from 1 to 9.
• If period_type is set to year, the value ranges from 1 to 3.

Default value

N/A

is_auto_pay

No

Boolean

Explanation

Whether the order will be automatically paid. This parameter is available for yearly/monthly mode. By default, the automatic payment is disabled.

Constraints

N/A

Value range

• true: The system automatically selects available discounts and coupons, and then pays for the order with the account balances. If the automatic payment fails, an order in Pending payment state is generated waiting for manual payment.
• false: The user needs to pay for the bill after using available discounts and coupons.

Default value

N/A

key

Yes

String

Explanation

Tag key.

Constraints

N/A

Value range

• A tag key can contain letters, digits, spaces, and special characters _.:=+-@, but cannot start or end with a space or start with _sys_.
• The tag key of a resource must be unique.
• It can contain a maximum of 128 Unicode characters and cannot be an empty string.

Default value

N/A

value

Yes

String

Explanation

Tag value.

Constraints

N/A

Value range

• The value can contain letters, digits, spaces, and special characters _.:=+-@, but cannot start or end with a space or start with _sys_.
• The value can contain a maximum of 255 Unicode characters and can be an empty string.

Default value

N/A

group_name

Yes

String

Explanation

Node group name.

Constraints

N/A

Value range

The value can contain a maximum of 64 characters, including uppercase and lowercase letters, digits and underscores (_). The rules for configuring node groups are as follows:

• master_node_default_group: master node group, which must be included in all cluster types.
• core_node_analysis_group: analysis core node group, which must be included in both analysis and hybrid clusters.
• core_node_streaming_group: streaming core node group, which must be included in both streaming and hybrid clusters.
• task_node_analysis_group: analysis task node group, which can be selected for analysis clusters and hybrid clusters as needed.
• task_node_streaming_group: streaming task node group, which can be selected for streaming clusters and hybrid clusters as needed.
• node_group{x}: node group of a custom cluster. A maximum of nine such node groups can be added for a custom cluster.

Default value

N/A

node_num

Yes

Integer

Explanation

Number of nodes.

Constraints

The total number of Core and Task nodes cannot exceed 500.

Value range

0-500

Default value

N/A

node_size

Yes

String

Explanation

Instance specifications of a node. Example: c3.4xlarge.2.linux.bigdata

The host specifications supported by MRS are determined by CPU, memory, and disk space. For details about instance specifications, see ECS Specifications Used by MRS and BMS Specifications Used by MRS.

Obtain the instance specifications of the corresponding version in the corresponding region from the cluster creation page of the MRS management console.

Constraints

N/A

Value range

N/A

Default value

N/A

root_volume

No

Volume object

Explanation

System disk information of the node. This parameter is optional for some VMs or the system disk of the BMS. This parameter is mandatory in other cases. For details about the parameter description, see Table 8.

Constraints

N/A

data_volume

No

Volume object

Explanation

Data disk information

Constraints

This parameter is mandatory when data_volume_count is not 0. For details about this parameter, see Table 8.

data_volume_count

No

Integer

Explanation

Number of data disks of a node.

Constraints

N/A

Value range

0-20

Default value

N/A

charge_info

No

ChargeInfo object

Explanation

The billing type of a node group. The billing types of master and core node groups are the same as those of the cluster. The billing type of the task node group can be different. For details about the parameters, see Table 5.

Constraints

N/A

auto_scaling_policy

No

auto_scaling_policy object

Explanation

Autoscaling rule corresponding to the node group. For details about the parameters, see Table 11.

Constraints

N/A

assigned_roles

No

Array of strings

Explanation

This parameter is mandatory when the cluster type is CUSTOM. You can specify the roles deployed in a node group. This parameter is a character string array. Each character string represents a role expression.

Role expression definition:

• If the role is deployed on all nodes in the node group, set this parameter to <role name>, for example, DataNode.
• If the role is deployed on a specified subscript node in the node group: <role name>:<index1>,<index2>..., <indexN>, for example, NameNode:1,2. The subscript starts from 1.

For details about available roles, see Roles and components supported by MRS.

Constraints

N/A

type

Yes

String

Explanation

Disk type.

Constraints

N/A

Value range

• SATA: common I/O disk
• SAS: high I/O disk
• SSD: ultra-high I/O disk
• GPSSD: general-purpose SSD disk

Default value

N/A

size

Yes

Integer

Explanation

Data disk size in GB.

Constraints

N/A

Value range

10-32768

Default value

N/A

name

Yes

String

Explanation

Name of a bootstrap action script.

Constraints

N/A

Value range

The names of bootstrap action scripts in the same cluster must be unique.

The value can contain only digits, letters, spaces, hyphens (-), and underscores (_) and must not start with a space.

The value can contain 1 to 64 characters.

Default value

N/A

uri

Yes

String

Explanation

Path of a bootstrap action script. Set this parameter to an OBS bucket path or a local VM path.

• OBS bucket path: Enter a script path manually. For example, enter the path of the public sample script provided by MRS. Example: s3a://bootstrap/presto/presto-install.sh. If dualroles is installed, the parameter of the presto-install.sh script is dualroles. If worker is installed, the parameter of the presto-install.sh script is worker. Based on the Presto usage habit, you are advised to install dualroles on the active master nodes and worker on the Core nodes.
• Local VM path: Enter a script path. The script path must start with a slash (/) and end with .sh.

Constraints

N/A

Value range

N/A

Default value

N/A

parameters

No

String

Explanation

Bootstrap action script parameters

Constraints

N/A

Value range

N/A

Default value

N/A

nodes

Yes

Array of strings

Explanation

Name of the node group where the bootstrap action script is executed

Constraints

N/A

active_master

No

Boolean

Explanation

Whether the bootstrap action script runs only on active Master nodes.

Constraints

N/A

Value range

• true: The bootstrap action script runs only on active Master nodes.
• false: The bootstrap action script can run on all Master nodes.

Default value

N/A

before_component_start

No

Boolean

Explanation

Time when the bootstrap action script is executed. Currently, the following two options are available: Before component start and After component start

Constraints

N/A

Value range

• true: The bootstrap action script is executed before the component starts.
• false: The bootstrap action script is executed after the component starts.

Default value

false

fail_action

Yes

String

Explanation

Whether to continue executing subsequent scripts and creating a cluster after the bootstrap action script fails to be executed. You are advised to set this parameter to continue in the commissioning phase so that the cluster can continue to be installed and started no matter whether the bootstrap action is successful.

Constraints

N/A

Value range

• continue: Continue to execute subsequent scripts.
• errorout: Stop the action.

Default value

N/A

start_time

No

Long

Explanation

Execution time of one boot operation script.

Constraints

N/A

Value range

N/A

Default value

N/A

state

No

String

Explanation

The running status of one bootstrap action script.

Constraints

N/A

Value range

• PENDING
• IN_PROGRESS
• SUCCESS
• FAILURE

Default value

N/A

action_stages

No

Array of strings

Explanation

Select the time when the bootstrap action script is executed.

Constraints

Enumerated values:

• BEFORE_COMPONENT_FIRST_START: before initial component starts
• AFTER_COMPONENT_FIRST_START: after initial component starts
• BEFORE_SCALE_IN: before scale-in
• AFTER_SCALE_IN: after scale-in
• BEFORE_SCALE_OUT: before scale-out
• AFTER_SCALE_OUT: after scale-out

job_type

Yes

Integer

Explanation

Job type code

Constraints

N/A

Value range

• MapReduce
• Spark
• Hive Script
• HiveSQL (not supported)
• DistCp: imports and exports data (not supported).
• Spark Script
• Spark SQL: submits SQL statements (not supported).

Default value

N/A

job_name

Yes

String

Explanation

Job name

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Identical job names are allowed but not recommended.

Default value

N/A

jar_path

No

String

Explanation

Path of the .jar file or .sql file to be executed.

Constraints

N/A

Value range

• Contains a maximum of 1023 characters, excluding special characters such as ;|&><'$. The parameter value cannot be empty or full of spaces.
• Files can be stored in HDFS or OBS. The path varies depending on the file system.
  • OBS: The path must start with s3a://. Files or programs encrypted by KMS are not supported.
  • HDFS: The path starts with a slash (/).
• Spark Script must end with .sql while MapReduce and Spark Jar must end with .jar. sql and jar are case-insensitive.

Default value

N/A

arguments

No

String

Explanation

Key parameter for program execution. The parameter is specified by the function of the user's program. MRS is only responsible for loading the parameter.

Constraints

N/A

Value range

The parameter can contain 0 to 150,000 characters, but special characters (;|&>'<$) are not allowed.

Default value

N/A

input

No

String

Explanation

Address for inputting data.

Constraints

N/A

Value range

The parameter contains a maximum of 1023 characters, excluding special characters such as ;|&>'<$, and can be left blank.

Default value

N/A

output

No

String

Explanation

Address for outputting data.

If the specified path does not exist, the system will automatically create it.

Constraints

N/A

Value range

The parameter contains a maximum of 1023 characters, excluding special characters such as ;|&>'<$, and can be left blank.

Default value

N/A

job_log

No

String

Explanation

Path for storing job logs that record job running status.

Constraints

N/A

Value range

The parameter contains a maximum of 1023 characters, excluding special characters such as ;|&>'<$, and can be left blank.

Default value

N/A

shutdown_cluster

No

Boolean

Explanation

Whether to delete the cluster after the job execution is complete.

Constraints

N/A

Value range

• true: Delete the cluster.
• false: Do not delete the cluster.

Default value

N/A

file_action

No

String

Explanation

The action to be performed on a file.

Constraints

N/A

Value range

• import: Import data.
• export: Export data.

Default value

N/A

submit_job_once_cluster_run

Yes

Boolean

Explanation

Whether to submit a job when creating a cluster. Set this parameter to true in this example.

Constraints

N/A

Value range

• true: Submit a job during cluster creation.
• false: Submit a job after the cluster is created.

Default value

N/A

hql

No

String

Explanation

HiveQL statement

Constraints

N/A

Value range

N/A

Default value

N/A

hive_script_path

No

String

Explanation

SQL program path. This parameter is needed by Spark Script and Hive Script jobs only,

Constraints

N/A

Value range

• Contains a maximum of 1023 characters, excluding special characters such as ;|&><'$. The address cannot be empty or full of spaces.
• Files can be stored in HDFS or OBS. The path varies depending on the file system.
  • OBS: The path must start with s3a://. Files or programs encrypted by KMS are not supported.
  • HDFS: The path starts with a slash (/).
• Ends with .sql. sql is case-insensitive.

Default value

N/A

auto_scaling_enable

Yes

Boolean

Explanation

Whether to enable the auto scaling rule.

Constraints

N/A

Value range

• true: Enable the auto scaling rule.
• false: Disable the autoscaling rule.

Default value

N/A

min_capacity

Yes

Integer

Explanation

Minimum number of nodes left in the node group.

Constraints

N/A

Value range

0-500

Default value

N/A

max_capacity

Yes

Integer

Explanation

Maximum number of nodes in the node group.

Constraints

N/A

Value range

0-500

Default value

N/A

resources_plans

No

Array of resources_plan objects

Explanation

Resource plan list. For details, see Table 12. If this parameter is left blank, the resource plan is disabled.

Constraints

When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured.

exec_scripts

No

Array of scale_script objects

Explanation

List of custom scaling automation scripts. For details, see Table 13. If this parameter is left blank, a hook script is disabled. This parameter is not available in the V2 API for creating and updating autoscaling policies.

Constraints

The number of records cannot exceed 10.

rules

No

Array of rules objects

Explanation

List of auto scaling rules. For details, see Table 14.

Constraints

When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured. The number of records cannot exceed 10.

period_type

Yes

String

Explanation

Cycle type of a resource plan. This parameter can be set to daily only.

Constraints

N/A

Value range

N/A

Default value

N/A

start_time

Yes

String

Explanation

The start time of a resource plan. The value is in the format of hour:minute, indicating that the time ranges from 00:00 to 23:59.

Constraints

N/A

Value range

N/A

Default value

N/A

end_time

Yes

String

Explanation

End time of a resource plan. The format is the same as that of start_time.

Constraints

The value cannot be earlier than the start_time, and the interval between start_time and start_time cannot be less than 30 minutes.

Value range

N/A

Default value

N/A

min_capacity

Yes

Integer

Explanation

Minimum number of the preserved nodes in a node group in a resource plan.

Constraints

N/A

Value range

0-500

Default value

N/A

max_capacity

Yes

Integer

Explanation

Maximum number of the preserved nodes in a node group in a resource plan.

Constraints

N/A

Value range

0-500

Default value

N/A

effective_days

No

Array of strings

Explanation

The effective date of a resource plan. If this parameter is left blank, it indicates that the resource plan takes effect every day. The options are as follows:

MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, and SUNDAY

Constraints

N/A

name

Yes

String

Explanation

Names of custom scaling automation scripts.

Constraints

N/A

Value range

The names in the same cluster must be unique.

The value can contain only digits, letters, spaces, hyphens (-), and underscores (_) and must not start with a space.

The value can contain 1 to 64 characters.

Default value

N/A

uri

Yes

String

Explanation

Path of a custom automation script. Set this parameter to an OBS bucket path or a local VM path.

• OBS bucket path: Enter a script path manually. for example, s3a://XXX/scale.sh.
• Local VM path: Enter a script path. The script path must start with a slash (/) and end with .sh.

Constraints

N/A

Value range

N/A

Default value

N/A

parameters

No

String

Explanation

Parameters of a custom automation script.

• Multiple parameters are separated by space.
• The following predefined system parameters can be transferred:
  • ${mrs_scale_node_num}: Number of the nodes to be added or removed
  • ${mrs_scale_type}: Scaling type. The value can be scale_out or scale_in.
  • ${mrs_scale_node_hostnames}: Host names of the nodes to be added or removed
  • ${mrs_scale_node_ips}: IP addresses of the nodes to be added or removed
  • ${mrs_scale_rule_name}: Name of the rule that triggers auto scaling
• Other user-defined parameters are used in the same way as those of common shell scripts. Parameters are separated by space.

Constraints

N/A

Value range

N/A

Default value

N/A

nodes

Yes

List<String>

Explanation

Type of a node where the custom automation script is executed. The node type can be Master, Core, or Task.

Constraints

N/A

active_master

No

Boolean

Explanation

Whether the custom automation script runs only on the active master node.

Constraints

N/A

Value range

• true: The custom automation script runs only on the active Master nodes.
• false: The custom automation script can run on all Master nodes.

Default value

false

action_stage

Yes

String

Explanation

Time when a script is executed.

Constraints

N/A

Value range

• before_scale_out: before scale-out
• before_scale_in: before scale-in
• after_scale_out: after scale-out
• after_scale_in: after scale-in

Default value

N/A

fail_action

Yes

String

Explanation

Whether to continue to execute subsequent scripts and create a cluster after the custom automation script fails to be executed. You are advised to set this parameter to continue in the commissioning phase so the cluster can continue to be installed and started no matter whether the custom automation script is executed successfully.

Constraints

The scale-in operation cannot be undone. fail_action must be set to continue for the scripts that are executed after scale-in.

Value range

• continue: Continue to execute subsequent scripts.
• errorout: Stop the action.

Default value

N/A

name

Yes

String

Explanation

Name of an auto scaling rule.

Constraints

N/A

Value range

The value can contain 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-).

Rule names must be unique in a node group.

Default value

N/A

description

No

String

Explanation

Description about an auto scaling rule.

Constraints

N/A

Value range

The value can contain 0 to 1024 characters.

Default value

N/A

adjustment_type

Yes

String

Explanation

Adjustment type of an auto scaling rule.

Constraints

N/A

Value range

• scale_out: cluster scale-out
• scale_in: cluster scale-in

Default value

N/A

cool_down_minutes

Yes

Integer

Explanation

Cluster cooling time after an auto scaling rule is triggered, when no auto scaling operation is performed. The unit is minute.

Constraints

N/A

Value range

The value ranges from 0 to 10080. 10080 indicates the number of minutes in a week.

Default value

N/A

scaling_adjustment

Yes

Integer

Explanation

Number of nodes that can be adjusted once.

Constraints

N/A

Value range

1-100

Default value

N/A

trigger

Yes

Trigger object

Explanation

Condition for triggering a rule. For details, see Table 15.

Constraints

N/A

metric_name

Yes

String

Explanation

Metric name. This triggering condition makes a judgment according to the value of the metric.

Constraints

N/A

Value range

The value can contain 0 to 64 characters.

Default value

N/A

metric_value

Yes

String

Explanation

Metric threshold to trigger a rule. The value must be an integer or a number with two decimal places.

Constraints

N/A

Value range

Only integers or numbers with two decimal places are allowed.

Default value

N/A

comparison_operator

No

String

Explanation

Metric judgment logic operator.

Constraints

N/A

Value range

• LT: less than
• GT: greater than
• LTOE: less than or equal to
• GTOE: greater than or equal to

Default value

N/A

evaluation_periods

Yes

Integer

Explanation

Number of consecutive five-minute periods, during which a metric threshold is reached

Constraints

N/A

Value range

1-288

Default value

N/A

component_name

Yes

String

Explanation

Component name

Constraints

N/A

Value range

N/A

Default value

N/A

configs

No

Array of Config objects

Explanation

The component configuration item list. For details about this parameter, see Table 17.

Constraints

The number of records cannot exceed 100.

key

Yes

String

Explanation

The configuration name. Only the configuration names displayed on the MRS component configuration page are supported.

Constraints

N/A

Value range

N/A

Default value

N/A

value

Yes

String

Explanation

Configuration value

Constraints

N/A

Value range

N/A

Default value

N/A

config_file_name

Yes

String

Explanation

Configuration file name. Only the file names displayed on the MRS component configuration page are supported.

Constraints

N/A

Value range

N/A

Default value

N/A

topic_urn

No

String

Explanation

SMN topic URN.

Constraints

Mandatory if alarm subscription needs to be enabled.

Value range

N/A

Default value

N/A

subscription_name

No

String

Explanation

Subscription rule name

Constraints

N/A

Value range

N/A

Default value

default_alert_rule

cluster_id

String

Explanation

Cluster ID, which is returned by the system after the cluster is created.

Value range

N/A