forked from docs/mapreduce-service
Compare commits
3 Commits
main
...
propose-mr
| Author | SHA1 | Date | |
|---|---|---|---|
| aad9ec00c7 | |||
| bf823a143a | |||
| af30c87347 |
14
api-ref/source/apis/auto_scaling_apis_v2/index.rst
Normal file
14
api-ref/source/apis/auto_scaling_apis_v2/index.rst
Normal file
@ -0,0 +1,14 @@
|
||||
:original_name: mrs_02_0199.html
|
||||
|
||||
.. _mrs_02_0199:
|
||||
|
||||
Auto Scaling APIs (V2)
|
||||
======================
|
||||
|
||||
- :ref:`Viewing Auto Scaling Policies <mrs_02_0200>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
viewing_auto_scaling_policies
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -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 <mrs_02_0011>`. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
|
||||
| cluster_id | Yes | String | The cluster ID. For details about how to obtain the cluster ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
|
||||
+------------+-----------+--------+------------------------------------------------------------------------------------------------------------------+
|
||||
|
||||
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 <mrs_02_0015>`.
|
||||
|
||||
Error Codes
|
||||
-----------
|
||||
|
||||
See :ref:`Error Code <mrs_02_0014>`.
|
||||
@ -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 <https://docs.otc.t-systems.com/en-us/endpoint/index.html>`__. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 <mrs_02_0101__tbbd2986d18874f82a8ab886ac25a57f8>`. |
|
||||
+------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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 <mrs_02_0101__table3419221413>`. |
|
||||
+------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| bootstrap_scripts | No | Array of BootstrapScript | Bootstrap action script information. For more parameter description, see :ref:`Table 8 <mrs_02_0101__table1258382865010>`. |
|
||||
| | | | |
|
||||
| | | | 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 <mrs_02_0101__t8ded0b3ae11742cea98a467ce26fd093>`. |
|
||||
+------------------------+-----------------+--------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
@ -475,12 +440,8 @@ Request
|
||||
| resources_plans | No | List | Resource plan list. For details, see :ref:`Table 11 <mrs_02_0101__table10281451162111>`. 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 <mrs_02_0101__table1921110172216>`. 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 <mrs_02_0101__t4c9e3e169631470d81d260543affb7e1>`. |
|
||||
| | | | |
|
||||
|
||||
@ -6,9 +6,11 @@ Cluster management APIs (V2)
|
||||
============================
|
||||
|
||||
- :ref:`Creating Clusters <mrs_02_0101>`
|
||||
- :ref:`Changing a Cluster Name <mrs_02_0201>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:hidden:
|
||||
|
||||
creating_clusters
|
||||
changing_a_cluster_name
|
||||
|
||||
@ -11,6 +11,7 @@ APIs
|
||||
- :ref:`Job Binary Object APIs <mrs_02_0033>`
|
||||
- :ref:`Job Object APIs (V1, Not Recommended) <mrs_02_0039>`
|
||||
- :ref:`Job Execution Object APIs (V1, Not Recommended) <mrs_02_0049>`
|
||||
- :ref:`Auto Scaling APIs (V2) <mrs_02_0199>`
|
||||
- :ref:`Job Object APIs (V2) <mrs_02_0084>`
|
||||
- :ref:`Auto Scaling APIs <mrs_02_0054>`
|
||||
- :ref:`Tag Management APIs <mrs_02_0070>`
|
||||
@ -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
|
||||
|
||||
@ -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 <mrs_02_0201>`. |
|
||||
| | |
|
||||
| | - Added an API for checking auto scaling policies. For details, see :ref:`Viewing Auto Scaling Policies <mrs_02_0200>`. |
|
||||
| | - Updated the description of the MRS cluster version based on the site requirements. For details, see :ref:`Creating Clusters <mrs_02_0101>` and :ref:`Creating a Cluster and Running a Job <mrs_02_0028>`. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2023-08-03 | - Modified the available specifications for MRS clusters. For details, see :ref:`ECS Specifications Used by MRS <mrs_01_9005>`. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 2023-05-04 | - Added the support for MRS 3.2.0-LTS.1. For details, see :ref:`Creating Clusters <mrs_02_0101>`. |
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user