diff --git a/api-ref/source/apis/auto_scaling_apis_v2/index.rst b/api-ref/source/apis/auto_scaling_apis_v2/index.rst new file mode 100644 index 0000000..21972fc --- /dev/null +++ b/api-ref/source/apis/auto_scaling_apis_v2/index.rst @@ -0,0 +1,14 @@ +:original_name: mrs_02_0199.html + +.. _mrs_02_0199: + +Auto Scaling APIs (V2) +====================== + +- :ref:`Viewing Auto Scaling Policies ` + +.. toctree:: + :maxdepth: 1 + :hidden: + + viewing_auto_scaling_policies diff --git a/api-ref/source/apis/auto_scaling_apis_v2/viewing_auto_scaling_policies.rst b/api-ref/source/apis/auto_scaling_apis_v2/viewing_auto_scaling_policies.rst new file mode 100644 index 0000000..80d8768 --- /dev/null +++ b/api-ref/source/apis/auto_scaling_apis_v2/viewing_auto_scaling_policies.rst @@ -0,0 +1,257 @@ +:original_name: mrs_02_0200.html + +.. _mrs_02_0200: + +Viewing Auto Scaling Policies +============================= + +Function +-------- + +This API is used to view all auto scaling policies of a specified cluster. + +URI +--- + +GET /v2/{project_id}/autoscaling-policy/{cluster_id} + +.. table:: **Table 1** URI parameters + + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+==================================================================================================================+ + | project_id | Yes | String | The project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ + | cluster_id | Yes | String | The cluster ID. For details about how to obtain the cluster ID, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +None + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 2** Response body parameter + + +-----------------+--------------------------------------+------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=================+======================================+============================================================================================================+ + | [Array element] | Array of AutoScalingPolicyV2 objects | The auto scaling policy list. For details, see :ref:`Table 3 `. | + +-----------------+--------------------------------------+------------------------------------------------------------------------------------------------------------+ + +.. _mrs_02_0200__response_autoscalingpolicyv2: + +.. table:: **Table 3** AutoScalingPolicyV2 + + +---------------------+--------------------------+-----------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+==========================+=====================================================================================================+ + | node_group_name | String | The node group name. | + +---------------------+--------------------------+-----------------------------------------------------------------------------------------------------+ + | resource_pool_name | String | The resource plan name. | + +---------------------+--------------------------+-----------------------------------------------------------------------------------------------------+ + | auto_scaling_policy | AutoScalingPolicy object | The auto scaling policy. For details, see :ref:`Table 4 `. | + +---------------------+--------------------------+-----------------------------------------------------------------------------------------------------+ + +.. _mrs_02_0200__response_autoscalingpolicy: + +.. table:: **Table 4** AutoScalingPolicy + + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=====================+================================+=============================================================================================================================================================================================================================================================================================+ + | auto_scaling_enable | Boolean | Whether to enable the auto scaling policy. | + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | min_capacity | Integer | The minimum number of nodes reserved in the node group. The value ranges from 0 to 500. | + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_capacity | Integer | The maximum number of nodes in the node group. The value ranges from 0 to 500. | + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | resources_plans | Array of ResourcesPlan objects | The resource plan list. If this parameter is left blank, the resource plan is disabled. When **auto_scaling_enable** is set to **true**, either this parameter or **rules** must be configured. For details about this parameter, see :ref:`Table 5 `. | + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | rules | Array of Rule objects | List of auto scaling rules. When **auto_scaling_enable** is set to **true**, either this parameter or **resources_plans** must be configured. For details about this parameter, see :ref:`Table 6 `. | + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | exec_scripts | Array of ScaleScript objects | The list of custom scaling automation scripts. If this parameter is left blank, the automation script is disabled. For details, see :ref:`Table 8 `. | + +---------------------+--------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _mrs_02_0200__response_resourcesplan: + +.. table:: **Table 5** ResourcesPlan + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===============================================================================================================================================================================================+ + | period_type | String | The cycle type of a resource plan. Currently, only the following cycle type is supported: | + | | | | + | | | daily | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | start_time | String | 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. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | end_time | String | The end time of a resource plan. The value is in the same format as that of **start_time**. The interval between **end_time** and **start_time** must be greater than or equal to 30 minutes. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | min_capacity | Integer | The minimum number of reserved nodes in a node group in a resource plan. The value ranges from 0 to 500. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | max_capacity | Integer | The maximum number of reserved nodes in a node group in a resource plan. The value ranges from 0 to 500. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | effective_days | Array of strings | 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** | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _mrs_02_0200__response_rule: + +.. table:: **Table 6** Rule + + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================+ + | name | String | The name of an auto scaling rule. The name can contain only 1 to 64 characters. Only letters, numbers, hyphens (-), and underscores (_) are allowed. Rule names must be unique in a node group. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | description | String | The description about an auto scaling rule. It contains a maximum of 1,024 characters. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | adjustment_type | String | Auto scaling rule adjustment type. Possible values: | + | | | | + | | | - **scale_out**: cluster scale-out | + | | | - **scale_in**: cluster scale-in | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | cool_down_minutes | Integer | The cluster cooling time after an auto scaling rule is triggered, when no auto scaling operation is performed. The unit is minute. The value ranges from 0 to 10080. One week is equal to 10,080 minutes. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | scaling_adjustment | Integer | The number of cluster nodes that can be adjusted at a time. The value ranges from 1 to 100. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | trigger | Trigger object | The condition for triggering a rule. For details, see :ref:`Table 7 `. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _mrs_02_0200__response_trigger: + +.. table:: **Table 7** Trigger + + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+======================================================================================================================================================+ + | metric_name | String | The metric name. This triggering condition makes a judgment according to the value of the metric. A metric name contains a maximum of 64 characters. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | metric_value | String | The metric threshold to trigger a rule. | + | | | | + | | | The value must be an integer or a number with two decimal places. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | comparison_operator | String | The metric judgment logic operator. Possible values: | + | | | | + | | | - **LT**: less than | + | | | - **GT**: greater than | + | | | - **LTOE**: less than or equal to | + | | | - **GTOE**: greater than or equal to | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + | evaluation_periods | Integer | The number of consecutive five-minute periods, during which a metric threshold is reached. The value ranges from 1 to 288. | + +-----------------------+-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------+ + +.. _mrs_02_0200__response_scalescript: + +.. table:: **Table 8** ScaleScript + + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+===========================================================================================================================================================================================================================================+ + | name | String | The name of a custom automation script. Names must be unique in a cluster. The value can contain only numbers, letters, spaces, hyphens (-), and underscores (_) and cannot start with a space. The value can contain 1 to 64 characters. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | uri | String | The 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, for example, **obs://**\ *XXX*\ **/scale.sh**. | + | | | - Local VM path: Enter a script path. The script path must start with a slash (/) and end with **.sh**. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | parameters | String | Parameters of a custom automation script. Multiple parameters are separated by space. The following predefined system parameters can be transferred: | + | | | | + | | | - *${mrs_scale_node_num}*: The number of nodes to be added or removed | + | | | - *${mrs_scale_type}*: The 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}*: The name of the rule that triggers scaling. Other user-defined parameters are used in the same way as those of common shell scripts. Parameters are separated by spaces. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | nodes | Array of strings | The name of the node group where the custom automation script is executed. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | active_master | Boolean | Whether the custom automation script runs only on the active master node. The default value is **false**, indicating that the custom automation script can run on all master nodes. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | fail_action | String | Whether to continue executing subsequent scripts and creating a cluster after the custom automation script fails to execute. Notes: | + | | | | + | | | - 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. Possible values: | + | | | - **continue**: Continue to execute subsequent scripts. | + | | | - **errorout**: Stop the action. | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | action_stage | String | The time when a script is executed. Possible values: | + | | | | + | | | - **before_scale_out**: before scale-out | + | | | - **before_scale_in**: before scale-in | + | | | - **after_scale_out**: after scale-out | + | | | - **after_scale_in**: after scale-in | + +-----------------------+-----------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 9** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String Error codes. + error_msg String The error message. + ========== ====== ================== + +Example Request +--------------- + +None + +Example Response +---------------- + +**Status code: 200** + +Auto scaling policies are displayed. + +.. code-block:: + + { + "auto_scaling_policies" : [ { + "node_group_name" : "task_node_analysis_group", + "resource_pool_name" : "default", + "auto_scaling_policy" : { + "auto_scaling_enable" : true, + "min_capacity" : 0, + "max_capacity" : 1, + "resources_plans" : [ { + "period_type" : "daily", + "effective_days" : [ "SUNDAY" ], + "start_time" : "12:00", + "end_time" : "13:00", + "min_capacity" : 2, + "max_capacity" : 3 + } ], + "rules" : [ { + "name" : "default-expand-1", + "description" : "", + "adjustment_type" : "scale_out", + "cool_down_minutes" : 5, + "scaling_adjustment" : 1, + "trigger" : { + "metric_name" : "YARNAppRunning", + "metric_value" : 100, + "comparison_operator" : "GTOE", + "evaluation_periods" : 1 + } + } ] + } + } ] + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Code `. diff --git a/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst b/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst index 540de03..e96c032 100644 --- a/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst +++ b/api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst @@ -18,50 +18,34 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 < .. table:: **Table 1** Obtaining resources - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Resource | How to Obtain | - +===================================+=======================================================================================================================================================================================+ - | 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*. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Region | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints `__. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Currently, the following versions are supported: MRS 1.6.3, MRS 1.7.2, MRS 1.9.2, MRS 2.1.0, MRS 3.1.0-LTS.1, MRS 3.1.2-LTS.3 and MRS3.2.0-LTS.1. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | - MRS 3.1.2-LTS.3 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | - | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | - | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, and ClickHouse. | - | | | - | | - MRS 3.1.0-LTS.1 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | - | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | - | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | | - | | - MRS 2.1.0 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Hive, Hue, Loader, Tez, Flink. | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, and Flink. | - | | | - | | - MRS 1.9.2 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Opentsdb, Hive, Hue, Loader, Tez, Flink, Alluxio and Ranger | - | | - The streaming cluster contains the following components: Kafka, KafkaManager, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, Kafka, Flink, and Ranger. | - | | | - | | - The following table lists the components supported by MRS 1.7.2, MRS 1.6.3: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark, HBase, Hive, Hue, and Loader | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | - +-----------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Resource | How to Obtain | + +===================================+==================================================================================================================================================================================================+ + | 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*. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Region | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints `__. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Version | Currently, the following versions are supported: MRS 3.1.2-LTS.3 and MRS 3.2.0-LTS.2. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Component | - MRS 3.2.0-LTS.2 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: CDL, Hadoop, Spark2x, HBase, Hive, Hue, Loader, IoTDB, Kafka, Flume, Flink, Oozie, ZooKeeper, HetuEngine, Ranger, Tez, and ClickHouse. | + | | | + | | - MRS 3.1.2-LTS.3 supports the following components: | + | | | + | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | + | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | + | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | + | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, and ClickHouse. | + +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ URI --- @@ -94,8 +78,17 @@ Request +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | available_zone_id | Yes | String | AZ ID. For details, see `Regions and Endpoints `__. | | | | | | - | | | | - AZ1(eu-de-01):bf84aba586ce4e948da0b97d9a7d62fb | - | | | | - AZ2(eu-de-02):bf84aba586ce4e948da0b97d9a7d62fc | + | | | | - Region: eu-de | + | | | | | + | | | | - AZ1(eu-de-01): eu-de-01 | + | | | | - AZ2(eu-de-02): eu-de-02 | + | | | | - AZ3(eu-de-03): eu-de-03 | + | | | | | + | | | | - Region: eu-nl | + | | | | | + | | | | - AZ1(eu-nl-01): eu-nl-01 | + | | | | - AZ2(eu-nl-02): eu-nl-02 | + | | | | - AZ3(eu-nl-03): eu-nl-03 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_name | Yes | String | Cluster name. It must be unique. | | | | | | @@ -151,13 +144,8 @@ Request | | | | | | | | | Possible values are as follows: | | | | | | - | | | | - MRS 1.6.3 | - | | | | - MRS 1.7.2 | - | | | | - MRS 1.9.2 | - | | | | - MRS 2.1.0 | - | | | | - MRS 3.1.0-LTS.1 | | | | | - MRS 3.1.2-LTS.3 | - | | | | - MRS 3.2.0-LTS.1 | + | | | | - MRS 3.2.0-LTS.2 | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_type | No | Integer | Cluster type | | | | | | @@ -172,10 +160,6 @@ Request | | | | | | | | | - **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 these functions, the users must obtain the relevant permissions from the MRS Manager administrator. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For MRS 1.7.2 or earlier, the request body contains the **cluster_admin_secret** field only when **safe_mode** is set to **1**. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_admin_secret | Yes | String | Password of the MRS Manager administrator | | | | | | @@ -188,10 +172,6 @@ Request | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\\|[{}];:'",<.>/?` and space | | | | | | | | | | - Cannot be the username or the username spelled backwards. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For MRS 1.7.2 or earlier, this parameter is mandatory only when **safe_mode** is set to **1**. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | login_mode | Yes | Integer | Cluster login mode | | | | | | @@ -202,10 +182,6 @@ Request | | | | | | | | | - 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. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | This parameter is valid only for clusters of MRS 1.6.3 or later instead of clusters of versions earlier than MRS 1.6.3. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_master_secret | No | String | Password of user **root** for logging in to a cluster node | | | | | | @@ -241,8 +217,6 @@ Request | add_jobs | No | Array | Jobs can be submitted when a cluster is created. Currently, only one job can be created. For details about job parameters, see :ref:`Table 8 `. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bootstrap_scripts | No | Array | Bootstrap action script information. For more parameter description, see :ref:`Table 15 `. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +-----------------------+-----------------+-----------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. _mrs_02_0028__table3419221413: @@ -502,12 +476,8 @@ Request | resources_plans | No | List | Resource plan list. For details, see :ref:`Table 10 `. If this parameter is left blank, the resource plan is disabled. | | | | | | | | | | When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured. | - | | | | | - | | | | MRS 1.6.3 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | exec_scripts | No | List | List of custom scaling automation scripts. For details, see :ref:`Table 11 `. If this parameter is left blank, a hook script is disabled. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rules | No | List | List of auto scaling rules. For details, see :ref:`Table 12 `. | | | | | | diff --git a/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst b/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst index 5a13025..ff3a4c5 100644 --- a/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst +++ b/api-ref/source/apis/cluster_management_apis_v1/querying_a_cluster_list.rst @@ -247,123 +247,59 @@ Response .. table:: **Table 4** **componentList** parameter description - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | componentId | String | Component ID | - | | | | - | | | - Component IDs of MRS 3.2.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.2.0-LTS.1_001: Hadoop | - | | | - MRS 3.2.0-LTS.1_002: HBase | - | | | - MRS 3.2.0-LTS.1_003: Hive | - | | | - MRS 3.2.0-LTS.1_004: Spark2x | - | | | - MRS 3.2.0-LTS.1_006: Flink | - | | | - MRS 3.2.0-LTS.1_008: Kafka | - | | | - MRS 3.2.0-LTS.1_009: Flume | - | | | - MRS 3.2.0-LTS.1_013: Loader | - | | | - MRS 3.2.0-LTS.1_014: Hue | - | | | - MRS 3.2.0-LTS.1_015: Ooize | - | | | - MRS 3.2.0-LTS.1_018: DBService | - | | | - MRS 3.2.0-LTS.1_019: ZooKeeper | - | | | - MRS 3.2.0-LTS.1_022: Ranger | - | | | - MRS 3.2.0-LTS.1_023: HetuEngine | - | | | - MRS 3.2.0-LTS.1_024: Tez | - | | | - MRS 3.2.0-LTS.1_025: ClickHouse | - | | | - MRS 3.2.0-LTS.1_026: IoTDB | - | | | - MRS 3.2.0-LTS.1_028: CDL | - | | | | - | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | - | | | | - | | | - MRS 3.1.2-LTS.3_001: Hadoop | - | | | - MRS 3.1.2-LTS.3_002: HBase | - | | | - MRS 3.1.2-LTS.3_003: Hive | - | | | - MRS 3.1.2-LTS.3_004: Spark2x | - | | | - MRS 3.1.2-LTS.3_006: Flink | - | | | - MRS 3.1.2-LTS.3_008: Kafka | - | | | - MRS 3.1.2-LTS.3_009: Flume | - | | | - MRS 3.1.2-LTS.3_013: Loader | - | | | - MRS 3.1.2-LTS.3_014: Hue | - | | | - MRS 3.1.2-LTS.3_015: Ooize | - | | | - MRS 3.1.2-LTS.3_018: DBService | - | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | - | | | - MRS 3.1.2-LTS.3_022: Ranger | - | | | - MRS 3.1.2-LTS.3_023: HetuEngine | - | | | - MRS 3.1.2-LTS.3_024: Tez | - | | | - MRS 3.1.2-LTS.3_025: ClickHouse | - | | | | - | | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.1.0-LTS.1_001: Hadoop | - | | | - MRS 3.1.0-LTS.1_002: HBase | - | | | - MRS 3.1.0-LTS.1_003: Hive | - | | | - MRS 3.1.0-LTS.1_004: Spark2x | - | | | - MRS 3.1.0-LTS.1_006: Flink | - | | | - MRS 3.1.0-LTS.1_008: Kafka | - | | | - MRS 3.1.0-LTS.1_009: Flume | - | | | - MRS 3.1.0-LTS.1_013: Loader | - | | | - MRS 3.1.0-LTS.1_014: Hue | - | | | - MRS 3.1.0-LTS.1_015: Ooize | - | | | - MRS 3.1.0-LTS.1_018: DBService | - | | | - MRS 3.1.0-LTS.1_019: ZooKeeper | - | | | - MRS 3.1.0-LTS.1_022: Ranger | - | | | - MRS 3.1.0-LTS.1_023: HetuEngine | - | | | - MRS 3.1.2-LTS.3_024: Tez | - | | | | - | | | - Component IDs of MRS 2.1.0 are as follows: | - | | | | - | | | - MRS 2.1.0_001: Hadoop | - | | | - MRS 2.1.0_002: Spark | - | | | - MRS 2.1.0_003: HBase | - | | | - MRS 2.1.0_004: Hive | - | | | - MRS 2.1.0_005: Hue | - | | | - MRS 2.1.0_006: Kafka | - | | | - MRS 2.1.0_007: Storm | - | | | - MRS 2.1.0_008: Loader | - | | | - MRS 2.1.0_009: Flume | - | | | - MRS 2.1.0_010: Tez | - | | | - MRS 2.1.0_011: Presto | - | | | - MRS 2.1.0_014: Flink | - | | | | - | | | - Component IDs of MRS 1.9.2 are as follows: | - | | | | - | | | - MRS 1.9.2_001: Hadoop | - | | | - MRS 1.9.2_002: Spark | - | | | - MRS 1.9.2_003: HBase | - | | | - MRS 1.9.2_004: Hive | - | | | - MRS 1.9.2_005: Hue | - | | | - MRS 1.9.2_006: Kafka | - | | | - MRS 1.9.2_007: Storm | - | | | - MRS 1.9.2_008: Loader | - | | | - MRS 1.9.2_009: Flume | - | | | - MRS 1.9.2_010: Presto | - | | | - MRS 1.9.2_011: KafkaManager | - | | | - MRS 1.9.2_012: Flink | - | | | - MRS 1.9.2_013: OpenTSDB | - | | | - MRS 1.9.2_015: Alluxio | - | | | - MRS 1.9.2_16: Ranger | - | | | - MRS 1.9.2_17: Tez | - | | | | - | | | - Component IDs of MRS 1.7.2 and MRS 1.6.3 are as follows: | - | | | | - | | | - MRS 1.7.2_001: Hadoop | - | | | - MRS 1.7.2_002: Spark | - | | | - MRS 1.7.2_003: HBase | - | | | - MRS 1.7.2_004: Hive | - | | | - MRS 1.7.2_005: Hue | - | | | - MRS 1.7.2_006: Kafka | - | | | - MRS 1.7.2_007: Storm | - | | | - MRS 1.7.2_008: Loader | - | | | - MRS 1.7.2_009: Flume | - | | | | - | | | For example, the **component_id** of Hadoop is **MRS 2.1.0_001**, **MRS 1.9.2_001**, **MRS 1.7.2_001**, **MRS 1.6.3_001**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentName | String | Component name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentVersion | String | Component version | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentDesc | String | Component description | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+=============================================================================+ + | componentId | String | Component ID | + | | | | + | | | - Component IDs of MRS 3.2.0-LTS.2 are as follows: | + | | | | + | | | - MRS 3.2.0-LTS.2_001: Hadoop | + | | | - MRS 3.2.0-LTS.2_002: HBase | + | | | - MRS 3.2.0-LTS.2_003: Hive | + | | | - MRS 3.2.0-LTS.2_004: Spark2x | + | | | - MRS 3.2.0-LTS.2_006: Flink | + | | | - MRS 3.2.0-LTS.2_008: Kafka | + | | | - MRS 3.2.0-LTS.2_009: Flume | + | | | - MRS 3.2.0-LTS.2_013: Loader | + | | | - MRS 3.2.0-LTS.2_014: Hue | + | | | - MRS 3.2.0-LTS.2_015: Ooize | + | | | - MRS 3.2.0-LTS.2_018: DBService | + | | | - MRS 3.2.0-LTS.2_019: ZooKeeper | + | | | - MRS 3.2.0-LTS.2_022: Ranger | + | | | - MRS 3.2.0-LTS.2_023: HetuEngine | + | | | - MRS 3.2.0-LTS.2_024: Tez | + | | | - MRS 3.2.0-LTS.2_025: ClickHouse | + | | | - MRS 3.2.0-LTS.2_026: IoTDB | + | | | - MRS 3.2.0-LTS.2_028: CDL | + | | | | + | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | + | | | | + | | | - MRS 3.1.2-LTS.3_001: Hadoop | + | | | - MRS 3.1.2-LTS.3_002: HBase | + | | | - MRS 3.1.2-LTS.3_003: Hive | + | | | - MRS 3.1.2-LTS.3_004: Spark2x | + | | | - MRS 3.1.2-LTS.3_006: Flink | + | | | - MRS 3.1.2-LTS.3_008: Kafka | + | | | - MRS 3.1.2-LTS.3_009: Flume | + | | | - MRS 3.1.2-LTS.3_013: Loader | + | | | - MRS 3.1.2-LTS.3_014: Hue | + | | | - MRS 3.1.2-LTS.3_015: Ooize | + | | | - MRS 3.1.2-LTS.3_018: DBService | + | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | + | | | - MRS 3.1.2-LTS.3_022: Ranger | + | | | - MRS 3.1.2-LTS.3_023: HetuEngine | + | | | - MRS 3.1.2-LTS.3_024: Tez | + | | | - MRS 3.1.2-LTS.3_025: ClickHouse | + | | | | + | | | For example, the **component_id** of Hadoop is **MRS** **3.2.0-LTS.2_001**. | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | componentName | String | Component name | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | componentVersion | String | Component version | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ + | componentDesc | String | Component description | + +-----------------------+-----------------------+-----------------------------------------------------------------------------+ .. _mrs_02_0030__t8c0e29f53f5d4b5da5cba38419aac352: diff --git a/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst b/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst index aa05e07..bd3ea1b 100644 --- a/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst +++ b/api-ref/source/apis/cluster_management_apis_v1/querying_cluster_details.rst @@ -127,8 +127,6 @@ Response | slaveSecurityGroupsId | String | Security group ID of a non-Master node. Currently, one MRS cluster uses only one security group. Therefore, this field has been discarded. This field returns the same value as **securityGroupsId** does for compatibility consideration. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bootstrap_scripts | Array | Bootstrap action script information. For more parameter description, see :ref:`Table 5 `. | - | | | | - | | | MRS 1.7.2 or later supports this parameter. | +-----------------------+-----------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | stageDesc | String | Cluster operation progress description. | | | | | @@ -234,123 +232,59 @@ Response .. table:: **Table 3** **componentList** parameter description - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+============================================================================================================================+ - | componentId | String | Component ID | - | | | | - | | | - Component IDs of MRS 3.2.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.2.0-LTS.1_001: Hadoop | - | | | - MRS 3.2.0-LTS.1_002: HBase | - | | | - MRS 3.2.0-LTS.1_003: Hive | - | | | - MRS 3.2.0-LTS.1_004: Spark2x | - | | | - MRS 3.2.0-LTS.1_006: Flink | - | | | - MRS 3.2.0-LTS.1_008: Kafka | - | | | - MRS 3.2.0-LTS.1_009: Flume | - | | | - MRS 3.2.0-LTS.1_013: Loader | - | | | - MRS 3.2.0-LTS.1_014: Hue | - | | | - MRS 3.2.0-LTS.1_015: Ooize | - | | | - MRS 3.2.0-LTS.1_018: DBService | - | | | - MRS 3.2.0-LTS.1_019: ZooKeeper | - | | | - MRS 3.2.0-LTS.1_022: Ranger | - | | | - MRS 3.2.0-LTS.1_023: HetuEngine | - | | | - MRS 3.2.0-LTS.1_024: Tez | - | | | - MRS 3.2.0-LTS.1_025: ClickHouse | - | | | - MRS 3.2.0-LTS.1_026: IoTDB | - | | | - MRS 3.2.0-LTS.1_028: CDL | - | | | | - | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | - | | | | - | | | - MRS 3.1.2-LTS.3_001: Hadoop | - | | | - MRS 3.1.2-LTS.3_002: HBase | - | | | - MRS 3.1.2-LTS.3_003: Hive | - | | | - MRS 3.1.2-LTS.3_004: Spark2x | - | | | - MRS 3.1.2-LTS.3_006: Flink | - | | | - MRS 3.1.2-LTS.3_008: Kafka | - | | | - MRS 3.1.2-LTS.3_009: Flume | - | | | - MRS 3.1.2-LTS.3_013: Loader | - | | | - MRS 3.1.2-LTS.3_014: Hue | - | | | - MRS 3.1.2-LTS.3_015: Ooize | - | | | - MRS 3.1.2-LTS.3_018: DBService | - | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | - | | | - MRS 3.1.2-LTS.3_022: Ranger | - | | | - MRS 3.1.2-LTS.3_023: HetuEngine | - | | | - MRS 3.1.2-LTS.3_024: Tez | - | | | - MRS 3.1.2-LTS.3_025: ClickHouse | - | | | | - | | | - Component IDs of MRS 3.1.0-LTS.1 are as follows: | - | | | | - | | | - MRS 3.1.0-LTS.1_001: Hadoop | - | | | - MRS 3.1.0-LTS.1_002: Spark2x | - | | | - MRS 3.1.0-LTS.1_003: HBase | - | | | - MRS 3.1.0-LTS.1_004: Hive | - | | | - MRS 3.1.0-LTS.1_005: Hue | - | | | - MRS 3.1.0-LTS.1_006: Loader | - | | | - MRS 3.1.0-LTS.1_007: Kafka | - | | | - MRS 3.1.0-LTS.1_008: Flume | - | | | - MRS 3.1.0-LTS.1_009: Flink | - | | | - MRS 3.1.0-LTS.1_010: Oozie | - | | | - MRS 3.1.0-LTS.1_011: ZooKeeper | - | | | - MRS 3.1.0-LTS.1_012: HetuEngine | - | | | - MRS 3.1.0-LTS.1_013: Ranger | - | | | - MRS 3.1.0-LTS.1_014: Tez | - | | | - MRS 3.1.0-LTS.1_015: ClickHouse | - | | | | - | | | - Component IDs of MRS 2.1.0 are as follows: | - | | | | - | | | - MRS 2.1.0_001: Hadoop | - | | | - MRS 2.1.0_002: Spark | - | | | - MRS 2.1.0_003: HBase | - | | | - MRS 2.1.0_004: Hive | - | | | - MRS 2.1.0_005: Hue | - | | | - MRS 2.1.0_006: Kafka | - | | | - MRS 2.1.0_007: Storm | - | | | - MRS 2.1.0_008: Loader | - | | | - MRS 2.1.0_009: Flume | - | | | - MRS 2.1.0_010: Tez | - | | | - MRS 2.1.0_011: Presto | - | | | - MRS 2.1.0_014: Flink | - | | | | - | | | - Component IDs of MRS 1.9.2 are as follows: | - | | | | - | | | - MRS 1.9.2_001: Hadoop | - | | | - MRS 1.9.2_002: Spark | - | | | - MRS 1.9.2_003: HBase | - | | | - MRS 1.9.2_004: Hive | - | | | - MRS 1.9.2_005: Hue | - | | | - MRS 1.9.2_006: Kafka | - | | | - MRS 1.9.2_007: Storm | - | | | - MRS 1.9.2_008: Loader | - | | | - MRS 1.9.2_009: Flume | - | | | - MRS 1.9.2_010: Presto | - | | | - MRS 1.9.2_011: KafkaManager | - | | | - MRS 1.9.2_012: Flink | - | | | - MRS 1.9.2_013: OpenTSDB | - | | | - MRS 1.9.2_015: Alluxio | - | | | - MRS 1.9.2_16: Ranger | - | | | - MRS 1.9.2_17: Tez | - | | | | - | | | - Component IDs of MRS 1.7.2 and MRS 1.6.3 are as follows: | - | | | | - | | | - MRS 1.7.2_001: Hadoop | - | | | - MRS 1.7.2_002: Spark | - | | | - MRS 1.7.2_003: HBase | - | | | - MRS 1.7.2_004: Hive | - | | | - MRS 1.7.2_005: Hue | - | | | - MRS 1.7.2_006: Kafka | - | | | - MRS 1.7.2_007: Storm | - | | | - MRS 1.7.2_008: Loader | - | | | - MRS 1.7.2_009: Flume | - | | | | - | | | For example, the **component_id** of Hadoop is **MRS 2.1.0_001**, **MRS 1.9.2_001**, **MRS 1.7.2_001**, **MRS 1.6.3_001**. | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentName | String | Component name | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentVersion | String | Component version | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ - | componentDesc | String | Component description | - +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+==========================================================================+ + | componentId | String | Component ID | + | | | | + | | | - Component IDs of MRS 3.2.0-LTS.2 are as follows: | + | | | | + | | | - MRS 3.2.0-LTS.2_001: Hadoop | + | | | - MRS 3.2.0-LTS.2_002: HBase | + | | | - MRS 3.2.0-LTS.2_003: Hive | + | | | - MRS 3.2.0-LTS.2_004: Spark2x | + | | | - MRS 3.2.0-LTS.2_006: Flink | + | | | - MRS 3.2.0-LTS.2_008: Kafka | + | | | - MRS 3.2.0-LTS.2_009: Flume | + | | | - MRS 3.2.0-LTS.2_013: Loader | + | | | - MRS 3.2.0-LTS.2_014: Hue | + | | | - MRS 3.2.0-LTS.2_015: Ooize | + | | | - MRS 3.2.0-LTS.2_018: DBService | + | | | - MRS 3.2.0-LTS.2_019: ZooKeeper | + | | | - MRS 3.2.0-LTS.2_022: Ranger | + | | | - MRS 3.2.0-LTS.2_023: HetuEngine | + | | | - MRS 3.2.0-LTS.2_024: Tez | + | | | - MRS 3.2.0-LTS.2_025: ClickHouse | + | | | - MRS 3.2.0-LTS.2_026: IoTDB | + | | | - MRS 3.2.0-LTS.2_028: CDL | + | | | | + | | | - Component IDs of MRS 3.1.2-LTS.3 are as follows: | + | | | | + | | | - MRS 3.1.2-LTS.3_001: Hadoop | + | | | - MRS 3.1.2-LTS.3_002: HBase | + | | | - MRS 3.1.2-LTS.3_003: Hive | + | | | - MRS 3.1.2-LTS.3_004: Spark2x | + | | | - MRS 3.1.2-LTS.3_006: Flink | + | | | - MRS 3.1.2-LTS.3_008: Kafka | + | | | - MRS 3.1.2-LTS.3_009: Flume | + | | | - MRS 3.1.2-LTS.3_013: Loader | + | | | - MRS 3.1.2-LTS.3_014: Hue | + | | | - MRS 3.1.2-LTS.3_015: Ooize | + | | | - MRS 3.1.2-LTS.3_018: DBService | + | | | - MRS 3.1.2-LTS.3_019: ZooKeeper | + | | | - MRS 3.1.2-LTS.3_022: Ranger | + | | | - MRS 3.1.2-LTS.3_023: HetuEngine | + | | | - MRS 3.1.2-LTS.3_024: Tez | + | | | - MRS 3.1.2-LTS.3_025: ClickHouse | + | | | | + | | | For example, the **component_id** of Hadoop is **MRS 3.2.0-LTS.2\_001**. | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | componentName | String | Component name | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | componentVersion | String | Component version | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ + | componentDesc | String | Component description | + +-----------------------+-----------------------+--------------------------------------------------------------------------+ .. _mrs_02_0031__t985f9eb1ce0c4e0186e16ed2a6c7e731: diff --git a/api-ref/source/apis/cluster_management_apis_v2/changing_a_cluster_name.rst b/api-ref/source/apis/cluster_management_apis_v2/changing_a_cluster_name.rst new file mode 100644 index 0000000..a190a31 --- /dev/null +++ b/api-ref/source/apis/cluster_management_apis_v2/changing_a_cluster_name.rst @@ -0,0 +1,95 @@ +:original_name: mrs_02_0201.html + +.. _mrs_02_0201: + +Changing a Cluster Name +======================= + +Function +-------- + +This API is used to change a cluster name. + +URI +--- + +PUT /v2/{project_id}/clusters/{cluster_id}/cluster-name + +.. table:: **Table 1** URI parameters + + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ + | Parameter | Mandatory | Type | Description | + +============+===========+========+==================================================================================================================+ + | project_id | Yes | String | The project ID. For details about how to obtain the project ID, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ + | cluster_id | Yes | String | The cluster ID. For details about how to obtain the cluster ID, see :ref:`Obtaining a Project ID `. | + +------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+ + +Request Parameters +------------------ + +.. table:: **Table 2** Request body parameter + + ============ ========= ====== ===================== + Parameter Mandatory Type Description + ============ ========= ====== ===================== + cluster_name Yes String The new cluster name. + ============ ========= ====== ===================== + +Response Parameters +------------------- + +**Status code: 200** + +.. table:: **Table 3** Response body parameter + + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +===========+========+==================================================================================================================================================================================+ + | result | String | The operation result of the mapping update request. Value \**succeeded*\* indicates that the operation is successful, and value \**failed*\* indicates that the operation fails. | + +-----------+--------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +**Status code: 400** + +.. table:: **Table 4** Response body parameters + + ========== ====== ================== + Parameter Type Description + ========== ====== ================== + error_code String The error code. + error_msg String The error message. + ========== ====== ================== + +Example Request +--------------- + +Change the MRS cluster name to **mrs_jdRU_dm01**. + +.. code-block:: + + { + "cluster_name" : "mrs_jdRU_dm01" + } + +Example Response +---------------- + +**Status code: 200** + +The cluster name is changed. + +.. code-block:: + + { + "result" : "succeeded" + } + +Status Codes +------------ + +See :ref:`Status Codes `. + +Error Codes +----------- + +See :ref:`Error Code `. diff --git a/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst b/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst index 5b8ae0f..b13e385 100644 --- a/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst +++ b/api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst @@ -27,9 +27,9 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 < +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Zone | Obtain the region and AZ information. For more information about regions and AZs, see `Regions and Endpoints `__. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Version | Currently, MRS 1.6.3, MRS 1.7.2, MRS 1.9.2 MRS 2.1.0, MRS 3.1.0-LTS.1, MRS 3.1.2-LTS.3 and MRS3.2.0-LTS.1 are supported. | + | Version | Currently, MRS 3.1.2-LTS.3 and MRS 3.2.0-LTS.2 are supported. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Component | - MRS 3.2.0-LTS.1 supports the following components: | + | Component | - MRS 3.2.0-LTS.2 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. | @@ -43,30 +43,6 @@ Before using the API, you need to obtain the resources listed in :ref:`Table 1 < | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, Tez, and ClickHouse. | - | | | - | | - MRS 3.1.0-LTS.1 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | - The streaming cluster contains the following components: Kafka, Flume, ZooKeeper, and Ranger. | - | | - The hybrid cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Flink, Oozie, ZooKeeper, Ranger, Tez, Kafka, and Flume. | - | | - A custom cluster contains the following components: Hadoop, Spark2x, HBase, Hive, Hue, HetuEngine, Loader, Kafka, Flume, Flink, Oozie, ZooKeeper, Ranger, and Tez. | - | | | - | | - MRS 2.1.0 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Hive, Hue, Loader, Tez, Flink. | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, and Flink. | - | | | - | | - MRS 1.9.2 supports the following components: | - | | | - | | - The analysis cluster contains the following components: Presto, Hadoop, Spark, HBase, Opentsdb, Hive, Hue, Loader, Tez, Flink, Alluxio and Ranger | - | | - The streaming cluster contains the following components: Kafka, KafkaManager, Storm, and Flume. | - | | - The hybrid cluster contains the following components: Hadoop, Hive, Presto, Spark, Tez, Kafka, Flink, and Ranger. | - | | | - | | - MRS 1.7.2 and MRS 1.6.3 support the following components: | - | | | - | | - The analysis cluster contains the following components: Hadoop, Spark, HBase, Hive, Hue, and Loader | - | | - The streaming cluster contains the following components: Kafka, Storm, and Flume. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ URI @@ -98,13 +74,8 @@ Request | | | | | | | | | Possible values are as follows: | | | | | | - | | | | - MRS 1.6.3 | - | | | | - MRS 1.7.2 | - | | | | - MRS 1.9.2 | - | | | | - MRS 2.1.0 | - | | | | - MRS 3.1.0-LTS.1 | | | | | - MRS 3.1.2-LTS.3 | - | | | | - MRS 3.2.1-LTS.1 | + | | | | - MRS 3.2.0-LTS.2 | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | cluster_name | Yes | String | Cluster name. It must be unique. | | | | | | @@ -139,7 +110,7 @@ Request | | | | | | | | | On the **Virtual Private Cloud** page, obtain the subnet name of the VPC from the list. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | components | Yes | String | List of component names, which are separated by commas (,). For details about the component names, see the component list of each version in Table 4-1. | + | components | Yes | String | List of component names, which are separated by commas (,). For details about the component names, see the component list of each version in :ref:`Table 1 `. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | availability_zone | Yes | String | Name of an AZ. | | | | | | @@ -167,10 +138,6 @@ Request | | | | - Spaces | | | | | | | | | | - Cannot be the username or the username spelled backwards. | - | | | | | - | | | | .. note:: | - | | | | | - | | | | For MRS 1.7.2 or earlier, this parameter is mandatory only when **safe_mode** is set to **KERBEROS**. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | login_mode | Yes | String | Node login mode. | | | | | | @@ -215,8 +182,6 @@ Request | node_groups | Yes | Array of NodeGroup | Information about the node groups in the cluster. For details about the parameters, see :ref:`Table 5 `. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | bootstrap_scripts | No | Array of BootstrapScript | Bootstrap action script information. For more parameter description, see :ref:`Table 8 `. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | add_jobs | No | Array of AddJobReq | Jobs can be submitted when a cluster is created. Currently, only one job can be created. For details about job parameters, see :ref:`Table 9 `. | +------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ @@ -475,12 +440,8 @@ Request | resources_plans | No | List | Resource plan list. For details, see :ref:`Table 11 `. If this parameter is left blank, the resource plan is disabled. | | | | | | | | | | When auto scaling is enabled, either a resource plan or an auto scaling rule must be configured. | - | | | | | - | | | | MRS 1.6.3 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | exec_scripts | No | List | List of custom scaling automation scripts. For details, see :ref:`Table 12 `. If this parameter is left blank, a hook script is disabled. | - | | | | | - | | | | MRS 1.7.2 or later supports this parameter. | +---------------------+-----------------+-----------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | rules | No | List | List of auto scaling rules. For details, see :ref:`Table 13 `. | | | | | | diff --git a/api-ref/source/apis/cluster_management_apis_v2/index.rst b/api-ref/source/apis/cluster_management_apis_v2/index.rst index cde11b9..356b83a 100644 --- a/api-ref/source/apis/cluster_management_apis_v2/index.rst +++ b/api-ref/source/apis/cluster_management_apis_v2/index.rst @@ -6,9 +6,11 @@ Cluster management APIs (V2) ============================ - :ref:`Creating Clusters ` +- :ref:`Changing a Cluster Name ` .. toctree:: :maxdepth: 1 :hidden: creating_clusters + changing_a_cluster_name diff --git a/api-ref/source/apis/index.rst b/api-ref/source/apis/index.rst index 4259ebf..1843f82 100644 --- a/api-ref/source/apis/index.rst +++ b/api-ref/source/apis/index.rst @@ -11,6 +11,7 @@ APIs - :ref:`Job Binary Object APIs ` - :ref:`Job Object APIs (V1, Not Recommended) ` - :ref:`Job Execution Object APIs (V1, Not Recommended) ` +- :ref:`Auto Scaling APIs (V2) ` - :ref:`Job Object APIs (V2) ` - :ref:`Auto Scaling APIs ` - :ref:`Tag Management APIs ` @@ -25,6 +26,7 @@ APIs job_binary_object_apis/index job_object_apis_v1_not_recommended/index job_execution_object_apis_v1_not_recommended/index + auto_scaling_apis_v2/index job_object_apis_v2/index auto_scaling_apis/index tag_management_apis/index diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index 6a836d2..4aa5ad1 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -8,6 +8,11 @@ Change History +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | Release Date | What's New | +===================================+==============================================================================================================================================================================================================+ +| 2023-09-06 | - Added an API for changing a cluster name. For details, see :ref:`Changing a Cluster Name `. | +| | | +| | - Added an API for checking auto scaling policies. For details, see :ref:`Viewing Auto Scaling Policies `. | +| | - Updated the description of the MRS cluster version based on the site requirements. For details, see :ref:`Creating Clusters ` and :ref:`Creating a Cluster and Running a Job `. | ++-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-08-03 | - Modified the available specifications for MRS clusters. For details, see :ref:`ECS Specifications Used by MRS `. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2023-05-04 | - Added the support for MRS 3.2.0-LTS.1. For details, see :ref:`Creating Clusters `. |