Compare commits

..

1 Commits
main ... confpy

Author SHA1 Message Date
626bed7fdf Update tox.ini && conf.py file
Performed-by: gitea/infra/otc-metadata/tools/generate_doc_confpy.py
2023-01-13 15:38:12 +00:00
2605 changed files with 2281 additions and 81177 deletions

View File

@ -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

View File

@ -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>`.

View File

@ -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

View File

@ -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_execution_object_apis_v1_not_recommended/index
auto_scaling_apis_v2/index
job_object_apis_v1,_not_recommended/index
job_execution_object_apis_v1,_not_recommended/index
job_object_apis_v2/index
auto_scaling_apis/index
tag_management_apis/index

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -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

View File

@ -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
================ ==========

View File

@ -8,21 +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>`. |
| | - 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: |
| | |

View File

@ -18,7 +18,7 @@ import os
import sys
extensions = [
'otcdocstheme',
'otcdocstheme'
]
otcdocs_auto_name = False
@ -30,17 +30,6 @@ otcdocs_repo_name = 'docs/mapreduce-service'
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
# documentation root, use os.path.abspath to make it absolute, like shown here.

View File

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

File diff suppressed because it is too large Load Diff

View File

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

View File

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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.2 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 21 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 127 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 3.1 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 330 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 6.5 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 8.9 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 574 B

Binary file not shown.

Before

Width:  |  Height:  |  Size: 1.0 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 893 B

Some files were not shown because too many files have changed in this diff Show More