mikacur/MRS-operation-guide-lts
1
0
Fork 0
forked from docs/mapreduce-service
Code Pull Requests Activity

Update content

Browse Source
This commit is contained in:
OpenTelekomCloud Proposal Bot 2022-10-31 11:02:23 +00:00
parent 464bc6ed53
commit 82fa80b52c
12 changed files with 130 additions and 133 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
api-ref/source/apis/cluster_management_apis_v1/creating_a_cluster_and_running_a_job.rst
View File

@ -184,7 +184,7 @@ Request
| | | | - Lowercase letters | | | | | - Lowercase letters |
| | | | - Uppercase letters | | | | | - Uppercase letters |
| | | | - Digits | | | | | - Digits |
| | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\|[{}];:'",<.>/?` and space | | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\\|[{}];:'",<.>/?` and space |
| | | | | | | | | |
| | | | - Cannot be the username or the username spelled backwards. | | | | | - Cannot be the username or the username spelled backwards. |
| | | | | | | | | |

2
api-ref/source/apis/cluster_management_apis_v2/creating_clusters.rst
View File

@ -154,7 +154,7 @@ Request
| | | | - Lowercase letters | | | | | - Lowercase letters |
| | | | - Uppercase letters | | | | | - Uppercase letters |
| | | | - Digits | | | | | - Digits |
| | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\|[{}];:'",<.>/?` | | | | | - Special characters: :literal:`\`~!@#$%^&*()-_=+\\|[{}];:'",<.>/?` |
| | | | - Spaces | | | | | - Spaces |
| | | | | | | | | |
| | | | - Cannot be the username or the username spelled backwards. | | | | | - Cannot be the username or the username spelled backwards. |

2
api-ref/source/apis/job_object_apis_v2/adding_and_executing_a_job.rst
View File

@ -73,7 +73,7 @@ Request
+-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------+-----------------+-----------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| properties | No | Object | Program system parameter. | | 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 Response

36
api-ref/source/apis/job_object_apis_v2/querying_a_list_of_jobs.rst
View File

@ -101,22 +101,22 @@ Response
.. table:: **Table 4** Job parameter description .. table:: **Table 4** Job parameter description
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+===============================================================================================================================================================================================================+ +=======================+=======================+================================================================================================================================================================================================================+
| job_id | String | Job ID | | job_id | String | Job ID |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user | String | Name of the user who submits a job. | | 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_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. | | job_result | String | Final result of a job. |
| | | | | | | |
| | | - **FAILED**: indicates that the job fails to be executed. | | | | - **FAILED**: indicates that the job fails to be executed. |
| | | - **KILLED**: indicates that the job is manually terminated during execution. | | | | - **KILLED**: indicates that the job is manually terminated during execution. |
| | | - **UNDEFINED**: indicates that the job is being executed. | | | | - **UNDEFINED**: indicates that the job is being executed. |
| | | - **SUCCEEDED**: indicates that the job has been successfully executed. | | | | - **SUCCEEDED**: indicates that the job has been successfully executed. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_state | String | Execution status of a job. | | job_state | String | Execution status of a job. |
| | | | | | | |
| | | - **FAILED**: indicates that the job fails to be executed. | | | | - **FAILED**: indicates that the job fails to be executed. |
@ -127,9 +127,9 @@ Response
| | | - **ACCEPTED**: indicates that the job is accepted. | | | | - **ACCEPTED**: indicates that the job is accepted. |
| | | - **RUNNING**: indicates that the job is running. | | | | - **RUNNING**: indicates that the job is running. |
| | | - **FINISHED**: indicates that the job is completed. | | | | - **FINISHED**: indicates that the job is completed. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_progress | Float | Job execution progress. | | job_progress | Float | Job execution progress. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_type | String | Type of a job. | | job_type | String | Type of a job. |
| | | | | | | |
| | | - MapReduce | | | | - MapReduce |
@ -140,23 +140,23 @@ Response
| | | - SparkScript | | | | - SparkScript |
| | | - SparkSql | | | | - SparkSql |
| | | - Flink | | | | - Flink |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| started_time | Long | Start time to run a job. Unit: milliseconds | | started_time | Long | Start time to run a job. Unit: milliseconds |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| submitted_time | Long | Time when a job is submitted. Unit: milliseconds | | submitted_time | Long | Time when a job is submitted. Unit: milliseconds |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| finished_time | Long | End time to run a job. Unit: milliseconds | | finished_time | Long | End time to run a job. Unit: milliseconds |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| elapsed_time | Long | Running duration of 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. | | 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. | | 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. | | launcher_id | String | Launcher job ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| app_id | String | Actual job ID. | | app_id | String | Actual job ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Example
------- -------

36
api-ref/source/apis/job_object_apis_v2/querying_information_about_a_job.rst
View File

@ -53,22 +53,22 @@ Response
.. table:: **Table 3** Job parameter description .. table:: **Table 3** Job parameter description
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Type | Description | | Parameter | Type | Description |
+=======================+=======================+===============================================================================================================================================================================================================+ +=======================+=======================+================================================================================================================================================================================================================+
| job_id | String | Job ID. | | job_id | String | Job ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| user | String | Name of the user who submits a job. | | 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_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. | | job_result | String | Final result of a job. |
| | | | | | | |
| | | - **FAILED**: indicates that the job fails to be executed. | | | | - **FAILED**: indicates that the job fails to be executed. |
| | | - **KILLED**: indicates that the job is manually terminated during execution. | | | | - **KILLED**: indicates that the job is manually terminated during execution. |
| | | - **UNDEFINED**: indicates that the job is being executed. | | | | - **UNDEFINED**: indicates that the job is being executed. |
| | | - **SUCCEEDED**: indicates that the job has been successfully executed. | | | | - **SUCCEEDED**: indicates that the job has been successfully executed. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_state | String | Execution status of a job. | | job_state | String | Execution status of a job. |
| | | | | | | |
| | | - FAILED: failed | | | | - FAILED: failed |
@ -79,9 +79,9 @@ Response
| | | - **ACCEPTED**: indicates that the job is accepted. | | | | - **ACCEPTED**: indicates that the job is accepted. |
| | | - **RUNNING**: indicates that the job is running. | | | | - **RUNNING**: indicates that the job is running. |
| | | - **FINISHED**: indicates that the job is completed. | | | | - **FINISHED**: indicates that the job is completed. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_progress | Float | Job execution progress. | | job_progress | Float | Job execution progress. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| job_type | String | Type of a job. | | job_type | String | Type of a job. |
| | | | | | | |
| | | - MapReduce | | | | - MapReduce |
@ -92,23 +92,23 @@ Response
| | | - SparkScript | | | | - SparkScript |
| | | - SparkSql | | | | - SparkSql |
| | | - Flink | | | | - Flink |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| started_time | Long | Start time to run a job. Unit: ms. | | started_time | Long | Start time to run a job. Unit: ms. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| submitted_time | Long | Time when a job is submitted. Unit: ms. | | submitted_time | Long | Time when a job is submitted. Unit: ms. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| finished_time | Long | End time to run a job. Unit: ms. | | finished_time | Long | End time to run a job. Unit: ms. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| elapsed_time | Long | Running duration of 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. | | 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. | | 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. | | launcher_id | String | Launcher job ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| app_id | String | Actual job ID. | | app_id | String | Actual job ID. |
+-----------------------+-----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ +-----------------------+-----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
Example Example
------- -------

20
api-ref/source/appendix/ecs_specifications_used_by_mrs.rst
View File

@ -114,15 +114,15 @@ Specifications
+---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+ +---------+---------+-------------+-------------------------+---------------------+-----------------+------------------------------------------+
| Type | vCPUs | Memory (GB) | Flavor | Virtualization Type | Local Disk (GB) | Hardware | | 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 .. table:: **Table 8** D2 ECS specifications
@ -130,15 +130,15 @@ Specifications
+---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+ +---------+---------+-------------+------------------------+---------------------+-----------------+------------------------------------------+
| Type | vCPUs | Memory (GB) | Flavor | Virtualization Type | Local Disk (GB) | Hardware | | 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 .. table:: **Table 9** H1 ECS specifications

1
api-ref/source/before_you_start/concepts.rst
View File

@ -31,7 +31,6 @@ Concepts
.. figure:: /_static/images/en-us_image_0000001351245889.gif .. figure:: /_static/images/en-us_image_0000001351245889.gif
:alt: **Figure 1** Project isolation model :alt: **Figure 1** Project isolation model
**Figure 1** Project isolation model **Figure 1** Project isolation model
- Checkpoint - Checkpoint

4
api-ref/source/calling_apis/authentication.rst
View File

@ -79,7 +79,6 @@ Decompress the downloaded package and reference the obtained JAR files as depend
.. figure:: /_static/images/en-us_image_0000001351446161.png .. figure:: /_static/images/en-us_image_0000001351446161.png
:alt: **Figure 1** Adding the API Gateway signing SDK :alt: **Figure 1** Adding the API Gateway signing SDK
**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**.) #. 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 .. figure:: /_static/images/en-us_image_0000001298566184.png
:alt: **Figure 2** Selecting Existing Projects into Workspace :alt: **Figure 2** Selecting Existing Projects into Workspace
**Figure 2** Selecting Existing Projects into Workspace **Figure 2** Selecting Existing Projects into Workspace
.. figure:: /_static/images/en-us_image_0000001298725832.png .. figure:: /_static/images/en-us_image_0000001298725832.png
:alt: **Figure 3** Selecting the demo project :alt: **Figure 3** Selecting the demo project
**Figure 3** Selecting the demo project **Figure 3** Selecting the demo project
.. figure:: /_static/images/en-us_image_0000001351245885.png .. figure:: /_static/images/en-us_image_0000001351245885.png
:alt: **Figure 4** Structure of the demo project :alt: **Figure 4** Structure of the demo project
**Figure 4** Structure of the demo project **Figure 4** Structure of the demo project
#. Sign the request. #. Sign the request.

2
api-ref/source/calling_apis/making_an_api_request.rst
View File

@ -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. 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 <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, 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 <mrs_02_0011>`. In the case of the API used to `obtain a user token <https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html>`__, 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 <mrs_02_0011>`.
.. note:: .. note::

1
api-ref/source/calling_apis/response.rst
View File

@ -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 .. figure:: /_static/images/en-us_image_0000001298246380.png
:alt: **Figure 1** Header fields of the response to the request for obtaining a user token :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 **Figure 1** Header fields of the response to the request for obtaining a user token
(Optional) Response Body (Optional) Response Body

3
api-ref/source/conf.py
View File

@ -35,6 +35,9 @@ sys.path.insert(0, os.path.abspath('../'))
sys.path.insert(0, os.path.abspath('./')) sys.path.insert(0, os.path.abspath('./'))
# -- General configuration ---------------------------------------------------- # -- 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 # Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones.