Creating a Cluster and Executing a Job

VPC

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

Subnet

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

Key Pair

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

Zone

See Endpoints for details about regions and AZs.

Version

Currently, MRS 3.3.1-LTS is supported.

Component

cluster_version

Yes

String

Explanation

Cluster version.

Constraints

N/A

Value range

MRS 3.3.1-LTS

Default value

N/A

cluster_name

Yes

String

Explanation

Cluster name. It must be unique.

Constraints

N/A

Value range

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

Default value

N/A

master_node_num

No

Integer

Explanation

Number of Master nodes.

Constraints

If cluster HA is enabled, set this parameter to 2. If cluster HA is disabled, set this parameter to 1. This parameter cannot be set to 1 in MRS 3.x.

Value range

N/A

Default value

N/A

core_node_num

No

Integer

Explanation

Number of Core nodes. The default maximum number of core nodes is 500. If more than 500 core nodes are required, apply for a higher quota.

Constraints

N/A

Value range

1-500

Default value

N/A

data_center

Yes

String

Explanation

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

Constraints

N/A

Value range

N/A

Default value

N/A

vpc

Yes

String

Explanation

The name of the VPC where the subnet is located. Obtain the VPC name by performing the following operations on 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

master_node_size

No

String

Explanation

The instance specifications of master nodes, for example, c3.4xlarge.2.linux.bigdata. The host specifications supported by MRS are determined by CPU, memory, and disk space. You are advised to obtain the specifications supported by the corresponding version in the corresponding region from the cluster creation page on the MRS console.

Constraints

N/A

Value range

N/A

Default value

N/A

core_node_size

No

String

Explanation

The instance specifications of core nodes, for example, c3.4xlarge.2.linux.bigdata. You are advised to obtain the specifications supported by the corresponding version in the corresponding region from the cluster creation page on the MRS console.

Constraints

N/A

Value range

N/A

Default value

N/A

component_list

Yes

Array of component_list objects

Explanation

The list of service components to be installed. For details about the parameters, see Table 4.

Constraints

N/A

available_zone_id

Yes

String

Explanation

AZ ID.

Constraints

N/A

Value range

Default value

N/A

vpc_id

Yes

String

Explanation

The ID of the VPC where the subnet is located.

Obtain the VPC ID by performing the following operations on 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 ID from the list.

Constraints

N/A

Value range

N/A

Default value

N/A

subnet_id

Yes

String

Explanation

Subnet ID Obtain the subnet ID by performing the following operations on 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 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

Explanation

The subnet name.

Obtain the subnet name by performing the following operations on 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

security_groups_id

No

String

Explanation

The ID of the security group configured for 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 not left blank, a fixed security group is used to create a cluster. The transferred ID must be the security group ID owned by the current tenant. The security group must include an inbound rule in which all protocols and all ports are allowed and the source is the IP address of the specified node on the management plane.

Constraints

N/A

Value range

N/A

Default value

N/A

add_jobs

No

Array of add_jobs objects

Explanation

Jobs can be submitted when a cluster is created. Currently, only one job can be created. For details about the parameters, see Table 5.

Constraints

There must be no more than 1 record.

volume_size

No

Integer

Explanation

Data disk storage space of Master and Core nodes, in GB To increase the data storage capacity, you can add disks when creating a cluster. Select a proper disk storage space based on the following application scenarios:

• Storage-compute decoupling: Data is stored in the OBS system. Costs of clusters are relatively low but computing performance is poor. The clusters can be deleted at any time. It is recommended when data computing is infrequently performed.
• Storage-compute integration: Data is stored in the HDFS system. Costs of clusters are relatively high but computing performance is good. The clusters cannot be deleted in a short term. It is recommended when data computing is frequently performed.

Constraints

This parameter is not recommended. For details, see the description of the volume_type parameter.

Value range

100-32000

Default value

N/A

volume_type

No

String

Explanation

The data disk storage type of master and core nodes. Currently, SATA, SAS, SSD, and GPSSD are supported. Disk parameters can be represented by volume_type and volume_size, or multi-disk parameters. If the volume_type and volume_size parameters coexist with the multi-disk parameters, the system reads the volume_type and volume_size parameters first. You are advised to use the multi-disk parameters.

Constraints

N/A

Value range

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

Default value

N/A

master_data_volume_type

No

String

Explanation

This parameter is a multi-disk parameter, indicating the data disk storage type of the master node. Currently, SATA, SAS, SSD, and GPSSD are supported.

Constraints

N/A

Value range

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

Default value

N/A

master_data_volume_size

No

Integer

Explanation

This parameter is a multi-disk parameter, indicating the data disk storage space of master nodes. To increase the data storage capacity, you can add disks when creating a cluster. You only need to pass in a number without the unit GB.

Constraints

N/A

Value range

100-32000

Default value

N/A

master_data_volume_count

No

Integer

Explanation

This parameter is a multi-disk parameter, indicating the number of data disks of the master nodes.

Constraints

N/A

Value range

The value can only be 1.

Default value

1

core_data_volume_type

No

String

Explanation

This parameter is a multi-disk parameter, indicating the data disk storage type of core nodes. Currently, SATA, SAS, SSD, and GPSSD are supported.

Constraints

N/A

Value range

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

Default value

N/A

core_data_volume_size

No

Integer

Explanation

This parameter is a multi-disk parameter, indicating the data disk storage space of core nodes. To increase the data storage capacity, you can add disks when creating a cluster. You only need to pass in a number without the unit GB.

Constraints

N/A

Value range

100-32000

Default value

N/A

core_data_volume_count

No

Integer

Explanation

This parameter is a multi-disk parameter, indicating the number of data disks of the core nodes.

Constraints

N/A

Value range

1-20

Default value

N/A

task_node_groups

No

Array of task_node_groups objects

Explanation

The list of task nodes. For details about the parameters, see Table 6.

Constraints

There must be no more than 1 record.

bootstrap_scripts

No

Array of BootstrapScript objects

Explanation

The Bootstrap action script information. For details about the parameters, see Table 8.

Constraints

N/A

node_public_cert_name

No

String

Explanation

The name of a key pair. You can use a key pair to log in to a cluster node.

Constraints

If login_mode is set to 1, the request body contains the node_public_cert_name field.

Value range

N/A

Default value

N/A

cluster_admin_secret

No

String

Explanation

Password of the MRS Manager administrator.

Constraints

N/A

Value range

• Must contain 8 to 26 characters.
• Cannot be the username or the username spelled backwards.
• Must contain every type of the following:
  • Lowercase letters
  • Uppercase letters
  • Numbers
  • Special characters (!@$%^-_=+[{}]:,./?)

Default value

N/A

cluster_master_secret

No

String

Explanation

The password of user root for logging in to a cluster node.

Constraints

If login_mode is set to 0, the request body contains the cluster_master_secret field.

Value range

A password must meet the following complexity requirements:

• Must be 8 to 26 characters long.
• Must contain every type of the following: uppercase letters, lowercase letters, numbers, and special characters (!@$%^-_=+[{}]:,./?), but must not contain spaces.
• Cannot be the username or the username spelled backwards.

Default value

N/A

safe_mode

Yes

Integer

Explanation

The running mode of an MRS cluster.

Constraints

N/A

Value range

• 0: normal cluster. In a normal cluster, Kerberos authentication is disabled, and users can use all functions provided by the cluster.
• 1: 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 MRS Manager administrator.

Default value

N/A

tags

No

Array of tag objects

Explanation

The cluster tags. For details about the parameters, see Table 9.

Constraints

A maximum of 20 tags can be used in a cluster. The tag name (key) must be unique. The tag key and value can contain letters, digits, spaces, and special characters (_.:=+-@), but cannot start or end with a space or start with _sys_.

cluster_type

No

Integer

Explanation

The cluster type. Currently, hybrid clusters cannot be created using APIs.

Constraints

N/A

Value range

• 0: analysis cluster
• 1: streaming cluster

Default value

0

log_collection

No

Integer

Explanation

Whether to collect logs when cluster creation fails. The default value is 1, indicating that OBS buckets are created only for collecting logs when an MRS cluster fails to create.

Constraints

N/A

Value range

• 0: Do not collect logs.
• 1: Collect logs.

Default value

1

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.

Constraints

N/A

Value range

N/A

Default value

0

login_mode

No

Integer

Explanation

Cluster login mode.

Constraints

• If login_mode is set to 0, the request body contains the cluster_master_secret field.
• If login_mode is set to 1, the request body contains the node_public_cert_name field.

Value range

• 0: password
• 1: key pair

Default value

1

node_groups

No

Array of NodeGroupV11 objects

Explanation

List of nodes. For details about the parameters, see Table 10.

Constraints

Configure either this parameter or the following parameters:

master_node_num, master_node_size, core_node_num, core_node_size, master_data_volume_type, master_data_volume_size, master_data_volume_count, core_data_volume_type, core_data_volume_size, core_data_volume_count, volume_type, volume_size, task_node_groups

component_name

Yes

String

Explanation

Component name. For details, see the component information in Table 1.

Constraints

N/A

Value range

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

Default value

N/A

job_type

Yes

Integer

Explanation

Job type code.

Constraints

N/A

Value range

• 1: MapReduce
• 2: Spark
• 3: Hive Script
• 4: HiveQL (not supported currently)
• 5: DistCp for importing and exporting data (not supported currently)
• 6: Spark Script
• 7: Spark SQL for submitting Spark SQL statements (not supported currently)
  NOTE:

  Spark and Hive jobs can be created only in clusters that where Spark and Hive are installed.

Default value

N/A

job_name

Yes

String

Explanation

Job name.

Constraints

N/A

Value range

The value can contain 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

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

The value must meet the following requirements:

• The value contains a maximum of 1,023 characters. It cannot contain special characters (;|&>,<'$) and cannot be left blank or all 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

The 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

The data input path.

Constraints

N/A

Value range

The value can contain 0 to 1,023 characters, but special characters (;|&>'<$) are not allowed.

Default value

N/A

output

No

String

Explanation

The data output path.

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

Constraints

N/A

Value range

The value can contain 0 to 1,023 characters, but special characters (;|&>'<$) are not allowed.

Default value

N/A

job_log

No

String

Explanation

The path for storing job logs that record job running status.

Constraints

N/A

Value range

The value can contain 0 to 1,023 characters, but special characters (;|&>'<$) are not allowed.

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 after job execution is complete.
• false: Do not delete the cluster after the job execution is complete.

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 it to true.

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

The HQL script statement.

Constraints

N/A

Value range

N/A

Default value

N/A

hive_script_path

No

String

Explanation

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

Constraints

N/A

Value range

The value must meet the following requirements:

• The value contains a maximum of 1,023 characters. It cannot contain special characters (;|&><'$) and cannot be left blank or all 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

node_num

Yes

Integer

Explanation

Number of Task 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

The instance specifications of task nodes, for example, c3.4xlarge.2.linux.bigdatac6.4xlarge.4.linux.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

data_volume_type

Yes

String

Explanation

Data disk storage type of the Task node. Supported types include SATA, SAS, and SSD.

Constraints

N/A

Value range

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

Default value

N/A

data_volume_count

Yes

Integer

Explanation

Number of data disks of a Task node.

Constraints

N/A

Value range

0-20

Default value

N/A

data_volume_size

Yes

Integer

Explanation

Data disk storage space of a Task node. You only need to pass in a number without the unit GB.

Constraints

N/A

Value range

100-32000

Default value

N/A

auto_scaling_policy

No

auto_scaling_policy object

Explanation

The auto scaling policy. For details, see Table 7.

Constraints

N/A

auto_scaling_enable

Yes

Boolean

Explanation

Whether to enable the auto scaling policy.

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

The minimum number of nodes reserved in the node group.

Constraints

N/A

Value range

0-500

Default value

N/A

max_capacity

Yes

Integer

Explanation

The 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

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

Constraints

When auto_scaling_enable is set to true, either this parameter or rules must be configured. There must be no more than 5 records.

exec_scripts

No

Array of scale_script objects

Explanation

The list of custom scaling automation scripts. For details, see Table 14. If this parameter is left blank, a hook script is disabled.

Constraints

The number of records cannot exceed 10.

rules

No

Array of rules objects

Explanation

The list of auto scaling rules. For details, see Table 12.

Constraints

When auto_scaling_enable is set to true, either this parameter or resources_plans must be configured. The number of records cannot exceed 10.

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 1 to 64 characters, including only letters, digits, underscores (_), and hyphens (-), and cannot start with a space.

Default value

N/A

uri

Yes

String

Explanation

The 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. 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

The bootstrap action script parameters.

Constraints

N/A

Value range

N/A

Default value

N/A

nodes

Yes

Array of strings

Explanation

The type of a node where the bootstrap action script is executed. The value can be Master, Core, or Task.

Constraints

The node type must be represented in lowercase letters.

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

false

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

errorout

start_time

No

Long

Explanation

The execution time of one bootstrap action 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: The script is suspended.
• IN_PROGRESS: The script is being processed.
• SUCCESS
• FAILURE: The script fails to be executed.

Default value

N/A

action_stages

No

Array of strings

Explanation

Select the time when the bootstrap action script is executed.

• 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

Constraints

N/A

key

Yes

String

Explanation

Tag key.

Constraints

N/A

Value range

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

Default value

N/A

value

Yes

String

Explanation

Tag value.

Constraints

N/A

Value range

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

Default value

N/A

group_name

Yes

String

Explanation

The node group name.

Constraints

N/A

Value range

• master_node_default_group
• core_node_analysis_group
• core_node_streaming_group
• task_node_analysis_group
• task_node_streaming_group

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

The instance specifications of cluster nodes, for example, c3.4xlarge.2.linux.bigdata. The host specifications supported by MRS are determined by CPU, memory, and disk space. You are advised to obtain the specifications supported by the corresponding version in the corresponding region from the cluster creation page on the MRS console.

Constraints

N/A

Value range

N/A

Default value

N/A

root_volume_size

No

String

Explanation

The system disk storage space of a node.

Constraints

N/A

Value range

N/A

Default value

N/A

root_volume_type

No

String

Explanation

System disk storage type of a node. Supported types include SATA, SAS, and SSD.

Constraints

N/A

Value range

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

Default value

N/A

data_volume_type

No

String

Explanation

Data disk storage type of nodes. Supported types include SATA, SAS, and SSD.

Constraints

N/A

Value range

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

Default value

N/A

data_volume_count

No

Integer

Explanation

Number of data disks of a node.

Constraints

N/A

Value range

0-20

Default value

N/A

data_volume_size

No

Integer

Explanation

Data disk storage space of a node.

Unit: GB.

Constraints

N/A

Value range

100-32000

Default value

N/A

auto_scaling_policy

No

auto_scaling_policy object

Explanation

The auto scaling policy.

Constraints

The auto scaling rule information. This parameter is available only when group_name is set to task_node_analysis_group or task_node_streaming_group.

For details about the parameters, see Table 7.

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

name

Yes

String

Explanation

Name of an auto scaling rule.

Constraints

N/A

Value range

It contains only 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed.

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

It contains a maximum of 1024 characters.

Default value

N/A

adjustment_type

Yes

String

Explanation

Auto scaling rule adjustment type.

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 13.

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

A metric name contains a maximum of 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

The number of consecutive five-minute periods, during which a metric threshold is reached.

Constraints

N/A

Value range

1-200

Default value

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 1 to 64 characters, including only digits, letters, spaces, hyphens (-), and underscores (_), and cannot start with a space.

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. Separate multiple parameters by spaces. The following predefined 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

Array of 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. The scale-in operation cannot be undone. fail_action must be set to continue for the scripts that are executed after scale-in.

Constraints

N/A

Value range

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

Default value

N/A

cluster_id

String

Explanation

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

Value range

N/A

result

Boolean

Explanation

Operation result.

Value range

• true: The operation is successful.
• false: The operation failed.

msg

String

Explanation

System message, which can be empty.

Value range

N/A

200

The cluster has been created.