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 d368eae..9a5c5de 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 @@ -184,7 +184,7 @@ Request | | | | - Lowercase letters | | | | | - Uppercase letters | | | | | - Digits | - | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\|[{}];:'",<.>/?` and space | + | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\\|[{}];:'",<.>/?` and space | | | | | | | | | | - Cannot be the username or the username spelled backwards. | | | | | | 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 c60d310..3ff5e20 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 @@ -154,7 +154,7 @@ Request | | | | - Lowercase letters | | | | | - Uppercase letters | | | | | - Digits | - | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\|[{}];:'",<.>/?` | + | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\\|[{}];:'",<.>/?` | | | | | - Spaces | | | | | | | | | | - Cannot be the username or the username spelled backwards. | diff --git a/api-ref/source/apis/job_object_apis_v2/adding_and_executing_a_job.rst b/api-ref/source/apis/job_object_apis_v2/adding_and_executing_a_job.rst index 5a77d9d..3c92b79 100644 --- a/api-ref/source/apis/job_object_apis_v2/adding_and_executing_a_job.rst +++ b/api-ref/source/apis/job_object_apis_v2/adding_and_executing_a_job.rst @@ -73,7 +73,7 @@ Request +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | properties | No | Object | Program system parameter. | | | | | | - | | | | The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\,` and can be left blank. | + | | | | The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\\,` and can be left blank. | +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Response diff --git a/api-ref/source/apis/job_object_apis_v2/querying_a_list_of_jobs.rst b/api-ref/source/apis/job_object_apis_v2/querying_a_list_of_jobs.rst index 5181e79..0c5f050 100644 --- a/api-ref/source/apis/job_object_apis_v2/querying_a_list_of_jobs.rst +++ b/api-ref/source/apis/job_object_apis_v2/querying_a_list_of_jobs.rst @@ -101,62 +101,62 @@ Response .. table:: **Table 4** Job parameter description - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================================================================================================================================================+ - | job_id | String | Job ID | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user | String | Name of the user who submits a job. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_result | String | Final result of a job. | - | | | | - | | | - **FAILED**: indicates that the job fails to be executed. | - | | | - **KILLED**: indicates that the job is manually terminated during execution. | - | | | - **UNDEFINED**: indicates that the job is being executed. | - | | | - **SUCCEEDED**: indicates that the job has been successfully executed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_state | String | Execution status of a job. | - | | | | - | | | - **FAILED**: indicates that the job fails to be executed. | - | | | - **KILLED**: indicates that the job is terminated. | - | | | - **New**: indicates that the job is created. | - | | | - **NEW_SAVING**: indicates that the job has been created and is being saved. | - | | | - **SUBMITTED**: indicates that the job is submitted. | - | | | - **ACCEPTED**: indicates that the job is accepted. | - | | | - **RUNNING**: indicates that the job is running. | - | | | - **FINISHED**: indicates that the job is completed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_progress | Float | Job execution progress. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | String | Type of a job. | - | | | | - | | | - MapReduce | - | | | - SparkSubmit | - | | | - HiveScript | - | | | - HiveSql | - | | | - DistCp, importing and exporting data | - | | | - SparkScript | - | | | - SparkSql | - | | | - Flink | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | started_time | Long | Start time to run a job. Unit: milliseconds | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | submitted_time | Long | Time when a job is submitted. Unit: milliseconds | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_time | Long | End time to run a job. Unit: milliseconds | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | elapsed_time | Long | Running duration of a job. Unit: milliseconds | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | arguments | Array | Run parameters. The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\,` and can be left blank. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | launcher_id | String | Launcher job ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_id | String | Actual job ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================================================================================================================================================+ + | job_id | String | Job ID | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | user | String | Name of the user who submits a job. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_result | String | Final result of a job. | + | | | | + | | | - **FAILED**: indicates that the job fails to be executed. | + | | | - **KILLED**: indicates that the job is manually terminated during execution. | + | | | - **UNDEFINED**: indicates that the job is being executed. | + | | | - **SUCCEEDED**: indicates that the job has been successfully executed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_state | String | Execution status of a job. | + | | | | + | | | - **FAILED**: indicates that the job fails to be executed. | + | | | - **KILLED**: indicates that the job is terminated. | + | | | - **New**: indicates that the job is created. | + | | | - **NEW_SAVING**: indicates that the job has been created and is being saved. | + | | | - **SUBMITTED**: indicates that the job is submitted. | + | | | - **ACCEPTED**: indicates that the job is accepted. | + | | | - **RUNNING**: indicates that the job is running. | + | | | - **FINISHED**: indicates that the job is completed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_progress | Float | Job execution progress. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_type | String | Type of a job. | + | | | | + | | | - MapReduce | + | | | - SparkSubmit | + | | | - HiveScript | + | | | - HiveSql | + | | | - DistCp, importing and exporting data | + | | | - SparkScript | + | | | - SparkSql | + | | | - Flink | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_time | Long | Start time to run a job. Unit: milliseconds | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | submitted_time | Long | Time when a job is submitted. Unit: milliseconds | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_time | Long | End time to run a job. Unit: milliseconds | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | elapsed_time | Long | Running duration of a job. Unit: milliseconds | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | arguments | Array | Run parameters. The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\\,` and can be left blank. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | launcher_id | String | Launcher job ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app_id | String | Actual job ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example ------- diff --git a/api-ref/source/apis/job_object_apis_v2/querying_information_about_a_job.rst b/api-ref/source/apis/job_object_apis_v2/querying_information_about_a_job.rst index 261e9ab..58987af 100644 --- a/api-ref/source/apis/job_object_apis_v2/querying_information_about_a_job.rst +++ b/api-ref/source/apis/job_object_apis_v2/querying_information_about_a_job.rst @@ -53,62 +53,62 @@ Response .. table:: **Table 3** Job parameter description - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | Parameter | Type | Description | - +=======================+=======================+===============================================================================================================================================================================================================+ - | job_id | String | Job ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | user | String | Name of the user who submits a job. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_result | String | Final result of a job. | - | | | | - | | | - **FAILED**: indicates that the job fails to be executed. | - | | | - **KILLED**: indicates that the job is manually terminated during execution. | - | | | - **UNDEFINED**: indicates that the job is being executed. | - | | | - **SUCCEEDED**: indicates that the job has been successfully executed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_state | String | Execution status of a job. | - | | | | - | | | - FAILED: failed | - | | | - **KILLED**: indicates that the job is terminated. | - | | | - **New**: indicates that the job is created. | - | | | - **NEW_SAVING**: indicates that the job has been created and is being saved. | - | | | - **SUBMITTED**: indicates that the job is submitted. | - | | | - **ACCEPTED**: indicates that the job is accepted. | - | | | - **RUNNING**: indicates that the job is running. | - | | | - **FINISHED**: indicates that the job is completed. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_progress | Float | Job execution progress. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | job_type | String | Type of a job. | - | | | | - | | | - MapReduce | - | | | - SparkSubmit | - | | | - HiveScript | - | | | - HiveSql | - | | | - DistCp, importing and exporting data | - | | | - SparkScript | - | | | - SparkSql | - | | | - Flink | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | started_time | Long | Start time to run a job. Unit: ms. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | submitted_time | Long | Time when a job is submitted. Unit: ms. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | finished_time | Long | End time to run a job. Unit: ms. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | elapsed_time | Long | Running duration of a job. Unit: ms. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | arguments | Array | Running parameter. The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\,` and can be left blank. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | launcher_id | String | Launcher job ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | app_id | String | Actual job ID. | - +-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | Parameter | Type | Description | + +=======================+=======================+================================================================================================================================================================================================================+ + | job_id | String | Job ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | user | String | Name of the user who submits a job. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_name | String | Job name. It contains 1 to 64 characters. Only letters, digits, hyphens (-), and underscores (_) are allowed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_result | String | Final result of a job. | + | | | | + | | | - **FAILED**: indicates that the job fails to be executed. | + | | | - **KILLED**: indicates that the job is manually terminated during execution. | + | | | - **UNDEFINED**: indicates that the job is being executed. | + | | | - **SUCCEEDED**: indicates that the job has been successfully executed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_state | String | Execution status of a job. | + | | | | + | | | - FAILED: failed | + | | | - **KILLED**: indicates that the job is terminated. | + | | | - **New**: indicates that the job is created. | + | | | - **NEW_SAVING**: indicates that the job has been created and is being saved. | + | | | - **SUBMITTED**: indicates that the job is submitted. | + | | | - **ACCEPTED**: indicates that the job is accepted. | + | | | - **RUNNING**: indicates that the job is running. | + | | | - **FINISHED**: indicates that the job is completed. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_progress | Float | Job execution progress. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | job_type | String | Type of a job. | + | | | | + | | | - MapReduce | + | | | - SparkSubmit | + | | | - HiveScript | + | | | - HiveSql | + | | | - DistCp, importing and exporting data | + | | | - SparkScript | + | | | - SparkSql | + | | | - Flink | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | started_time | Long | Start time to run a job. Unit: ms. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | submitted_time | Long | Time when a job is submitted. Unit: ms. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | finished_time | Long | End time to run a job. Unit: ms. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | elapsed_time | Long | Running duration of a job. Unit: ms. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | arguments | Array | Running parameter. The parameter contains a maximum of 4,096 characters, excluding special characters such as ``;|&>'<$,`` and can be left blank. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | properties | Object | Configuration parameter, which is used to configure **-d** parameters. The parameter contains a maximum of 2,048 characters, excluding special characters such as :literal:`><|'`&!\\,` and can be left blank. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | launcher_id | String | Launcher job ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ + | app_id | String | Actual job ID. | + +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ Example ------- diff --git a/api-ref/source/appendix/ecs_specifications_used_by_mrs.rst b/api-ref/source/appendix/ecs_specifications_used_by_mrs.rst index ec24881..a545ed1 100644 --- a/api-ref/source/appendix/ecs_specifications_used_by_mrs.rst +++ b/api-ref/source/appendix/ecs_specifications_used_by_mrs.rst @@ -114,15 +114,15 @@ Specifications +---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+ | Type | vCPUs | Memory (GB) | Flavor | Virtualization Type | Local Disk (GB) | Hardware | +=========+=========+=============+=========================+=====================+=================+==========================================+ - | D1 | 44 | 3232 | d1.xlarge.mrslinux.mrs | KVM | 3×1800 | CPU: Intel® Xeon® Gold 6151 Processor v5 | + | D1 | 44 | 3232 | d1.xlarge.mrslinux.mrs | KVM | 3x1800 | CPU: Intel® Xeon® Gold 6151 Processor v5 | | | | | | | | | - | | | | | | | Memory: 20 × 32 GB | + | | | | | | | Memory: 20 x 32 GB | +---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+ - | | 88 | 6464 | d1.2xlarge.mrslinux.mrs | KVM | 6×1800 | | + | | 88 | 6464 | d1.2xlarge.mrslinux.mrs | KVM | 6x1800 | | +---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+ - | | 16 | 128 | d1.4xlarge.linux.mrs | KVM | 12×1800 | | + | | 16 | 128 | d1.4xlarge.linux.mrs | KVM | 12x1800 | | +---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+ - | | 36 | 256 | d1.8xlarge.linux.mrs | KVM | 24×1800 | | + | | 36 | 256 | d1.8xlarge.linux.mrs | KVM | 24x1800 | | +---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+ .. table:: **Table 8** D2 ECS specifications @@ -130,15 +130,15 @@ Specifications +---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+ | Type | vCPUs | Memory (GB) | Flavor | Virtualization Type | Local Disk (GB) | Hardware | +=========+=========+=============+========================+=====================+=================+==========================================+ - | D2 | 4 | 32 | d2.xlarge.8.linux.mrs | KVM | 2×1800 | CPU: Intel® Xeon® Gold 6151 Processor v5 | + | D2 | 4 | 32 | d2.xlarge.8.linux.mrs | KVM | 2x1800 | CPU: Intel® Xeon® Gold 6151 Processor v5 | | | | | | | | | - | | | | | | | Memory: 20 × 32 GB | + | | | | | | | Memory: 20 x 32 GB | +---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+ - | | 8 | 64 | d2.2xlarge.8.linux.mrs | KVM | 4×1800 | | + | | 8 | 64 | d2.2xlarge.8.linux.mrs | KVM | 4x1800 | | +---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+ - | | 16 | 128 | d2.4xlarge.8.linux.mrs | KVM | 8×1800 | | + | | 16 | 128 | d2.4xlarge.8.linux.mrs | KVM | 8x1800 | | +---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+ - | | 32 | 256 | d2.8xlarge.8.linux.mrs | KVM | 16×1800 | | + | | 32 | 256 | d2.8xlarge.8.linux.mrs | KVM | 16x1800 | | +---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+ .. table:: **Table 9** H1 ECS specifications diff --git a/api-ref/source/before_you_start/concepts.rst b/api-ref/source/before_you_start/concepts.rst index 65b19c9..4a4fcf9 100644 --- a/api-ref/source/before_you_start/concepts.rst +++ b/api-ref/source/before_you_start/concepts.rst @@ -31,7 +31,6 @@ Concepts .. figure:: /_static/images/en-us_image_0000001351245889.gif :alt: **Figure 1** Project isolation model - **Figure 1** Project isolation model - Checkpoint diff --git a/api-ref/source/calling_apis/authentication.rst b/api-ref/source/calling_apis/authentication.rst index 794654b..9f8db3c 100644 --- a/api-ref/source/calling_apis/authentication.rst +++ b/api-ref/source/calling_apis/authentication.rst @@ -79,7 +79,6 @@ Decompress the downloaded package and reference the obtained JAR files as depend .. figure:: /_static/images/en-us_image_0000001351446161.png :alt: **Figure 1** Adding the API Gateway signing SDK - **Figure 1** Adding the API Gateway signing SDK #. Generate an AK/SK. (If an AK/SK file has already been obtained, skip this step and locate the downloaded AK/SK file. Generally, the file name will be **credentials.csv**.) @@ -107,21 +106,18 @@ Decompress the downloaded package and reference the obtained JAR files as depend .. figure:: /_static/images/en-us_image_0000001298566184.png :alt: **Figure 2** Selecting Existing Projects into Workspace - **Figure 2** Selecting Existing Projects into Workspace .. figure:: /_static/images/en-us_image_0000001298725832.png :alt: **Figure 3** Selecting the demo project - **Figure 3** Selecting the demo project .. figure:: /_static/images/en-us_image_0000001351245885.png :alt: **Figure 4** Structure of the demo project - **Figure 4** Structure of the demo project #. Sign the request. diff --git a/api-ref/source/calling_apis/making_an_api_request.rst b/api-ref/source/calling_apis/making_an_api_request.rst index a05256e..7e294a1 100644 --- a/api-ref/source/calling_apis/making_an_api_request.rst +++ b/api-ref/source/calling_apis/making_an_api_request.rst @@ -128,7 +128,7 @@ This part is optional. The body of a request is often sent in a structured forma The request body varies between APIs. Some APIs do not require the request body, such as the APIs requested using the GET and DELETE methods. -In the case of the API used to `obtain a user token `__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *username*, *domainname*, *\*******\** (login password), and *xxxxxxxxxxxxxxxxxx* *(project ID)* with the actual values. To learn how to obtain a project ID, see :ref:`Obtaining a Project ID `. +In the case of the API used to `obtain a user token `__, the request parameters and parameter description can be obtained from the API request. The following provides an example request with a body included. Replace *username*, *domainname*, ``********`` (login password), and *xxxxxxxxxxxxxxxxxx* *(project ID)* with the actual values. To learn how to obtain a project ID, see :ref:`Obtaining a Project ID `. .. note:: diff --git a/api-ref/source/calling_apis/response.rst b/api-ref/source/calling_apis/response.rst index 2d8b9a5..5dc7815 100644 --- a/api-ref/source/calling_apis/response.rst +++ b/api-ref/source/calling_apis/response.rst @@ -26,7 +26,6 @@ Similar to a request, a response also has a header, for example, **Content-Type* .. figure:: /_static/images/en-us_image_0000001298246380.png :alt: **Figure 1** Header fields of the response to the request for obtaining a user token - **Figure 1** Header fields of the response to the request for obtaining a user token (Optional) Response Body diff --git a/api-ref/source/change_history.rst b/api-ref/source/change_history.rst index a670fd9..a36eabf 100644 --- a/api-ref/source/change_history.rst +++ b/api-ref/source/change_history.rst @@ -15,7 +15,7 @@ Change History +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2022-07-05 | Modified the following content: | | | | -| | - Added MRS 3.1.2-LTS.3. For details, see :ref:`Creating Clusters `\ and :ref:`Creating a Cluster and Running a Job `. | +| | - Added MRS 3.1.2-LTS.3. For details, see :ref:`Creating Clusters `\ and :ref:`Creating a Cluster and Running a Job `. | +-----------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | 2021-06-30 | Modified the following content: | | | | diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py index 205766b..0b3a548 100644 --- a/api-ref/source/conf.py +++ b/api-ref/source/conf.py @@ -35,6 +35,9 @@ sys.path.insert(0, os.path.abspath('../')) sys.path.insert(0, os.path.abspath('./')) # -- General configuration ---------------------------------------------------- +# https://docutils.sourceforge.io/docs/user/smartquotes.html - it does not +# what it is expected +smartquotes = False # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.