Update content

api-ref/source/apis/auto_scaling_apis_v2/index.rst

@@ -1,14 +0,0 @@
-: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

api-ref/source/apis/cluster_management_apis_v2/changing_a_cluster_name.rst

@@ -1,95 +0,0 @@
-: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>`.

api-ref/source/apis/cluster_management_apis_v2/index.rst

@@ -6,11 +6,9 @@ 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

api-ref/source/apis/index.rst

@@ -11,7 +11,6 @@ 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>`
@@ -24,9 +23,8 @@ APIs
    cluster_management_apis_v2/index
    cluster_management_apis_v1/index
    job_binary_object_apis/index
-   job_object_apis_v1_not_recommended/index
+   job_object_apis_v1,_not_recommended/index
-   job_execution_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

api-ref/source/appendix/index.rst

@@ -7,11 +7,10 @@ Appendix
 
 -  :ref:`ECS Specifications Used by MRS <mrs_01_9005>`
 -  :ref:`Status Codes <mrs_02_0015>`
--  :ref:`Error Code <mrs_02_0014>`
 -  :ref:`Obtaining a Project ID <mrs_02_0011>`
 -  :ref:`Obtaining Account ID <mrs_02_0016>`
 -  :ref:`Obtain MRS Cluster Information <mrs_02_0091>`
--  :ref:`Roles and components supported by MRS <mrs_02_0106>`
+-  :ref:`Roles and components supported by MRS11 <mrs_02_0106>`
 
 .. toctree::
    :maxdepth: 1
@@ -19,8 +18,7 @@ Appendix
 
    ecs_specifications_used_by_mrs
    status_codes
-   error_code
    obtaining_a_project_id
    obtaining_account_id
    obtain_mrs_cluster_information
-   roles_and_components_supported_by_mrs
+   roles_and_components_supported_by_mrs11

api-ref/source/appendix/roles_and_components_supported_by_mrs11.rst

@@ -2,8 +2,8 @@
 
 .. _mrs_02_0106:
 
-Roles and components supported by MRS
+Roles and components supported by MRS11
-=====================================
+=======================================
 
 .. table:: **Table 1** Roles and components supported by MRS
 
@@ -52,11 +52,4 @@ Roles and components supported by MRS
    TezUI            Tez
    RangerAdmin      Ranger
    RangerUserSync   Ranger
-   HSBroker         HetuEngine
-   HSConsole        HetuEngine
-   QAS              HetuEngine
-   CDLConnector     CDL
-   CDLService       CDL
-   IoTDBServer      IoTDB
-   ConfigNode       IoTDB
    ================ ==========

api-ref/source/calling_apis/making_an_api_request.rst

@@ -95,7 +95,7 @@ You can also add additional header fields to a request, such as the fields requi
    +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------------+
    | X-Project-Id    | Project ID. This field is used to obtain the token for each project.                                                                                                                                                                                        | No                                                                                          | e9993fc787d94b6c886cbaa340f9c0f4 |
    +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------------+
-   | X-Auth-Token    | User token.                                                                                                                                                                                                                                                 | No                                                                                          | ``-``                            |
+   | X-Auth-Token    | User token.                                                                                                                                                                                                                                                 | No                                                                                          | -                                |
    |                 |                                                                                                                                                                                                                                                             |                                                                                             |                                  |
    |                 | It is the response to the API used to `obtain request authentication <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__. This API is the only one that does not require authentication.                                          | This field is mandatory for token-based authentication.                                     |                                  |
    |                 |                                                                                                                                                                                                                                                             |                                                                                             |                                  |
@@ -105,7 +105,7 @@ You can also add additional header fields to a request, such as the fields requi
    |                 |                                                                                                                                                                                                                                                             |                                                                                             |                                  |
    |                 | **en-us**: English                                                                                                                                                                                                                                          |                                                                                             |                                  |
    +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------------+
-   | X-Domain-Id     | Domain ID                                                                                                                                                                                                                                                   | No                                                                                          | ``-``                            |
+   | X-Domain-Id     | Domain ID                                                                                                                                                                                                                                                   | No                                                                                          | -                                |
    +-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------------------------------------------------------------------------------+----------------------------------+
 
 .. note::

api-ref/source/change_history.rst

@@ -8,25 +8,14 @@ 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>`.                                                                                                  |
+| 2022-09-29                        | Modified the following content:                                                                                                                                                                              |
-|                                   |                                                                                                                                                                                                              |
-|                                   | -  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>`.                                                                                                           |
-|                                   | -  Added error code reference. For details, see :ref:`Error Code <mrs_02_0014>`.                                                                                                                             |
-+-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
-| 2022-9-29                         | Modified the following content:                                                                                                                                                                              |
 |                                   |                                                                                                                                                                                                              |
 |                                   | -  Added MRS 1.9.2 and MRS 2.1.0 hybrid cluster components. For details, see :ref:`Creating Clusters <mrs_02_0101>`.                                                                                         |
 |                                   | -  Add component lists for MRS 3.1.2-LTS.3 and 3.1.0-LTS.1. For details, see :ref:`Querying Cluster Details <mrs_02_0031>`.                                                                                  |
-|                                   | -  Rectified the ECS specification issue.                                                                                                                                                                    |
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 2022-07-05                        | Modified the following content:                                                                                                                                                                              |
 |                                   |                                                                                                                                                                                                              |
-|                                   | -  Added MRS 3.1.2-LTS.3. For details, see :ref:`Creating Clusters <mrs_02_0101>` and :ref:`Creating a Cluster and Running a Job <mrs_02_0028>`.                                                             |
+|                                   | -  Added MRS 3.1.2-LTS.3. For details, see :ref:`Creating Clusters <mrs_02_0101>`\  and :ref:`Creating a Cluster and Running a Job <mrs_02_0028>`.                                                           |
 +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
 | 2021-06-30                        | Modified the following content:                                                                                                                                                                              |
 |                                   |                                                                                                                                                                                                              |

api-ref/source/conf.py

@@ -18,28 +18,14 @@ import os
 import sys
 
 extensions = [
-    'otcdocstheme',
+    'otcdocstheme'
 ]
 
 otcdocs_auto_name = False
 otcdocs_auto_version = False
 
-project = 'MapReduce Service'
+project = 'Map Reduce Service'
 otcdocs_repo_name = 'docs/mapreduce-service'
-# Those variables are required for edit/bug links
-otcdocs_git_fqdn = 'gitea.eco.tsi-dev.otc-service.com'
-otcdocs_git_type = 'gitea'
-
-# Those variables are needed for indexing into OpenSearch
-otcdocs_doc_environment = 'internal'
-otcdocs_doc_link = '/mapreduce-service/api-ref/'
-otcdocs_doc_title = 'API Reference'
-otcdocs_doc_type = 'api-ref'
-otcdocs_service_category = 'big_data'
-otcdocs_service_title = 'MapReduce Service'
-otcdocs_service_type = 'mrs'
-otcdocs_search_environment = 'hc_de'
-otcdocs_search_url = "https://opensearch.eco.tsi-dev.otc-service.com/"
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -86,18 +72,17 @@ show_authors = False
 html_theme = 'otcdocs'
 
 # Theme options are theme-specific and customize the look and feel of a theme
-# further. For a list of options available for each theme, see the
+# further.  For a list of options available for each theme, see the
 # documentation.
 html_theme_options = {
-    "disable_search": True,
+    'disable_search': True,
-    "site_name": "Internal Documentation Portal",
+    'site_name': 'Internal Documentation Portal'
-    "logo_url": "https://docs-int.otc-service.com",
 }
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
 
-html_title = "MapReduce Service - API Reference"
+html_title = "Map Reduce Service - API Reference"
 
 
 # Add any paths that contain custom static files (such as style sheets) here,
@@ -105,13 +90,10 @@ html_title = "MapReduce Service - API Reference"
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ['_static']
 
-# Do not include sources into the rendered results
-html_copy_source = False
-
 # -- Options for PDF output --------------------------------------------------
 latex_documents = [
-    ('index',
+('index',
      'mrs-api-ref.tex',
-     u'MapReduce Service - API Reference',
+     u'Map Reduce Service - API Reference',
      u'OpenTelekomCloud', 'manual'),
-]
+]

api-ref/source/index.rst

@@ -1,6 +1,6 @@
-=================================
+==================================
-MapReduce Service - API Reference
+Map Reduce Service - API Reference
-=================================
+==================================
 
 .. toctree::
    :maxdepth: 1

doc/best-practice/source/docutils.conf

@@ -1,2 +0,0 @@
-[html writers]
-table-style: table, caption-top

doc/best-practice/source/index.rst

@@ -1,4 +0,0 @@
-=================================
-MapReduce Service - Best Practice
-=================================
-