Compare commits

..

4 Commits

4035 changed files with 3180 additions and 151146 deletions

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

File diff suppressed because it is too large Load Diff

View File

@ -1,14 +0,0 @@
:original_name: mrs_02_0054.html
.. _mrs_02_0054:
Auto Scaling APIs
=================
- :ref:`Configuring an Auto Scaling Rule <mrs_02_0056>`
.. toctree::
:maxdepth: 1
:hidden:
configuring_an_auto_scaling_rule

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,81 +0,0 @@
:original_name: mrs_02_0032.html
.. _mrs_02_0032:
Deleting a Cluster
==================
Function
--------
This API is used to delete a cluster after data processing and analysis are completed or the cluster is abnormal. This API is compatible with Sahara.
Clusters in any of the following states cannot be terminated:
- scaling-out
- scaling-in
- starting
- terminating
- terminated
- failed
URI
---
- Format
DELETE /v1.1/{project_id}/clusters/{cluster_id}
- Parameter description
.. table:: **Table 1** URI parameter description
+------------+-----------+-----------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Description |
+============+===========+===========================================================================================================+
| project_id | Yes | Project ID. For details on how to obtain the project ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+------------+-----------+-----------------------------------------------------------------------------------------------------------+
| cluster_id | Yes | Cluster ID |
+------------+-----------+-----------------------------------------------------------------------------------------------------------+
Request
-------
**Request parameters**
None.
Response
--------
**Response parameters**
None.
Example
-------
- Example request
None.
- Example response
None.
Status Code
-----------
:ref:`Table 2 <mrs_02_0032__table1584477916050>` describes the status code of this API.
.. _mrs_02_0032__table1584477916050:
.. table:: **Table 2** Status code
=========== =============================================
Status Code Description
=========== =============================================
204 The cluster has been successfully terminated.
=========== =============================================
For the description about error status codes, see :ref:`Status Codes <mrs_02_0015>`.

View File

@ -1,24 +0,0 @@
:original_name: mrs_02_0027.html
.. _mrs_02_0027:
Cluster management APIs (V1)
============================
- :ref:`Creating a Cluster and Running a Job <mrs_02_0028>`
- :ref:`Resizing a Cluster <mrs_02_0029>`
- :ref:`Querying a Cluster List <mrs_02_0030>`
- :ref:`Querying Cluster Details <mrs_02_0031>`
- :ref:`Deleting a Cluster <mrs_02_0032>`
- :ref:`Querying a Host List <mrs_02_0057>`
.. toctree::
:maxdepth: 1
:hidden:
creating_a_cluster_and_running_a_job
resizing_a_cluster
querying_a_cluster_list
querying_cluster_details
deleting_a_cluster
querying_a_host_list

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

@ -1,16 +0,0 @@
:original_name: mrs_02_0100.html
.. _mrs_02_0100:
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

@ -1,74 +0,0 @@
:original_name: mrs_02_0026.html
.. _mrs_02_0026:
Deleting a Data Source
======================
Function
--------
This API is used to delete a data source. This API is compatible with Sahara.
URI
---
- Format
DELETE /v1.1/{project_id}/data-sources/{data_source_id}
- Parameter description
.. table:: **Table 1** URI parameter description
+----------------+-----------+-----------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Description |
+================+===========+===========================================================================================================+
| project_id | Yes | Project ID. For details on how to obtain the project ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+----------------+-----------+-----------------------------------------------------------------------------------------------------------+
| data_source_id | Yes | Data source ID |
+----------------+-----------+-----------------------------------------------------------------------------------------------------------+
Request
-------
**Request parameters**
None.
Response
--------
**Response parameters**
None.
Example
-------
- Example request
.. code-block:: text
DELETE /v1.1/{project_id}/data-sources/{data_source_id}
- Example response
None.
Status Code
-----------
:ref:`Table 2 <mrs_02_0026__table1584477916050>` describes the status code of this API.
.. _mrs_02_0026__table1584477916050:
.. table:: **Table 2** Status code
=========== ========================================
Status Code Description
=========== ========================================
204 The data source is deleted successfully.
=========== ========================================
For the description about error status codes, see :ref:`Status Codes <mrs_02_0015>`.

View File

@ -1,22 +0,0 @@
:original_name: mrs_02_0021.html
.. _mrs_02_0021:
Data Source APIs
================
- :ref:`Creating a Data Source <mrs_02_0022>`
- :ref:`Updating a Data Source <mrs_02_0023>`
- :ref:`Querying the Data Source List <mrs_02_0024>`
- :ref:`Querying the Data Source Details <mrs_02_0025>`
- :ref:`Deleting a Data Source <mrs_02_0026>`
.. toctree::
:maxdepth: 1
:hidden:
creating_a_data_source
updating_a_data_source
querying_the_data_source_list
querying_the_data_source_details
deleting_a_data_source

View File

@ -1,32 +0,0 @@
:original_name: mrs_02_0020.html
.. _mrs_02_0020:
APIs
====
- :ref:`Data Source APIs <mrs_02_0021>`
- :ref:`Cluster management APIs (V2) <mrs_02_0100>`
- :ref:`Cluster management APIs (V1) <mrs_02_0027>`
- :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>`
.. toctree::
:maxdepth: 1
:hidden:
data_source_apis/index
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_v2/index
auto_scaling_apis/index
tag_management_apis/index

View File

@ -1,72 +0,0 @@
:original_name: mrs_02_0038.html
.. _mrs_02_0038:
Deleting a Job Binary Object
============================
Function
--------
This API is used to delete a binary object. This API is compatible with Sahara.
URI
---
- Format
DELETE /v1.1/{project_id}/job-binaries/{job_binary_id}
- Parameter description
.. table:: **Table 1** URI parameter description
+---------------+-----------+-----------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Description |
+===============+===========+===========================================================================================================+
| project_id | Yes | Project ID. For details on how to obtain the project ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+---------------+-----------+-----------------------------------------------------------------------------------------------------------+
| job_binary_id | Yes | Job binary object ID |
+---------------+-----------+-----------------------------------------------------------------------------------------------------------+
Request
-------
**Request parameters**
None
Response
--------
**Response parameters**
None
Example
-------
- Example request
None
- Example response
None
Status Code
-----------
:ref:`Table 2 <mrs_02_0038__table1584477916050>` describes the status code of this API.
.. _mrs_02_0038__table1584477916050:
.. table:: **Table 2** Status code
=========== ==========================================
Status code Description
=========== ==========================================
204 The binary object is deleted successfully.
=========== ==========================================
For the description about error status codes, see :ref:`Status Codes <mrs_02_0015>`.

View File

@ -1,22 +0,0 @@
:original_name: mrs_02_0033.html
.. _mrs_02_0033:
Job Binary Object APIs
======================
- :ref:`Creating a Job Binary Object <mrs_02_0034>`
- :ref:`Updating a Job Binary Object <mrs_02_0035>`
- :ref:`Querying the Binary Object List <mrs_02_0036>`
- :ref:`Querying the Binary Object Details <mrs_02_0037>`
- :ref:`Deleting a Job Binary Object <mrs_02_0038>`
.. toctree::
:maxdepth: 1
:hidden:
creating_a_job_binary_object
updating_a_job_binary_object
querying_the_binary_object_list
querying_the_binary_object_details
deleting_a_job_binary_object

View File

@ -1,72 +0,0 @@
:original_name: mrs_02_0053.html
.. _mrs_02_0053:
Deleting a Job Execution Object
===============================
Function
--------
This API is used to delete a job execution object. This API is compatible with Sahara.
URI
---
- Format
DELETE /v1.1/{project_id}/job-executions/{job_execution_id}
- Parameter description
.. table:: **Table 1** URI parameter description
+------------------+-----------+-----------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Description |
+==================+===========+===========================================================================================================+
| project_id | Yes | Project ID. For details on how to obtain the project ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+------------------+-----------+-----------------------------------------------------------------------------------------------------------+
| job_execution_id | Yes | Job ID |
+------------------+-----------+-----------------------------------------------------------------------------------------------------------+
Request
-------
**Request parameters**
None.
Response
--------
**Response parameters**
None.
Example
-------
- Example request
None.
- Example response
None.
Status Code
-----------
:ref:`Table 2 <mrs_02_0053__table1584477916050>` describes the status code of this API.
.. _mrs_02_0053__table1584477916050:
.. table:: **Table 2** Status code
=========== =================================================
Status Code Description
=========== =================================================
204 The job execution object is deleted successfully.
=========== =================================================
For the description about error status codes, see :ref:`Status Codes <mrs_02_0015>`.

View File

@ -1,20 +0,0 @@
:original_name: mrs_02_0049.html
.. _mrs_02_0049:
Job Execution Object APIs (V1, Not Recommended)
===============================================
- :ref:`Querying the Job Execution Object List <mrs_02_0050>`
- :ref:`Querying Job Execution Object Details <mrs_02_0051>`
- :ref:`Canceling Job Execution <mrs_02_0052>`
- :ref:`Deleting a Job Execution Object <mrs_02_0053>`
.. toctree::
:maxdepth: 1
:hidden:
querying_the_job_execution_object_list
querying_job_execution_object_details
canceling_job_execution
deleting_a_job_execution_object

View File

@ -1,72 +0,0 @@
:original_name: mrs_02_0048.html
.. _mrs_02_0048:
Deleting a Job Object
=====================
Function
--------
This API is used to delete a job object. This API is compatible with Sahara.
URI
---
- Format
DELETE /v1.1/{project_id}/jobs/{job_id}
- Parameter description
.. table:: **Table 1** URI parameter description
+------------+-----------+-----------------------------------------------------------------------------------------------------------+
| Parameter | Mandatory | Description |
+============+===========+===========================================================================================================+
| project_id | Yes | Project ID. For details on how to obtain the project ID, see :ref:`Obtaining a Project ID <mrs_02_0011>`. |
+------------+-----------+-----------------------------------------------------------------------------------------------------------+
| job_id | Yes | Job object ID |
+------------+-----------+-----------------------------------------------------------------------------------------------------------+
Request
-------
**Request parameters**
None.
Response
--------
**Response parameters**
None.
Example
-------
- Example request
None.
- Example response
None.
Status Code
-----------
:ref:`Table 2 <mrs_02_0048__table1584477916050>` describes the status code of this API.
.. _mrs_02_0048__table1584477916050:
.. table:: **Table 2** Status code
=========== =============================================
Status Code Description
=========== =============================================
204 The job object has been successfully deleted.
=========== =============================================
For the description about error status codes, see :ref:`Status Codes <mrs_02_0015>`.

View File

@ -1,30 +0,0 @@
:original_name: mrs_02_0039.html
.. _mrs_02_0039:
Job Object APIs (V1, Not Recommended)
=====================================
- :ref:`Adding a Job and Executing the Job <mrs_02_0040>`
- :ref:`Creating a Job Object <mrs_02_0041>`
- :ref:`Updating a Job Object <mrs_02_0042>`
- :ref:`Executing a Job Object <mrs_02_0043>`
- :ref:`Querying the Job Object List <mrs_02_0044>`
- :ref:`Querying Job Object Details <mrs_02_0045>`
- :ref:`Querying the exe Object List of Jobs <mrs_02_0046>`
- :ref:`Querying exe Object Details <mrs_02_0047>`
- :ref:`Deleting a Job Object <mrs_02_0048>`
.. toctree::
:maxdepth: 1
:hidden:
adding_a_job_and_executing_the_job
creating_a_job_object
updating_a_job_object
executing_a_job_object
querying_the_job_object_list
querying_job_object_details
querying_the_exe_object_list_of_jobs
querying_exe_object_details
deleting_a_job_object

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