forked from docs/mapreduce-service
Update content
This commit is contained in:
parent
54945e8a61
commit
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
@ -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>`.
|
@ -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,10 @@ 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>`. |
|
||||
+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
||||
| 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