forked from docs/mapreduce-service
proposalbot
11ba7ce113
1 Reviewed-by: Jiang, Beibei <beibei.jiang@t-systems.com> Co-authored-by: proposalbot <proposalbot@otc-service.com> Co-committed-by: proposalbot <proposalbot@otc-service.com>
139 lines
23 KiB
ReStructuredText
139 lines
23 KiB
ReStructuredText
:original_name: mrs_02_0007.html
|
|
|
|
.. _mrs_02_0007:
|
|
|
|
API Overview
|
|
============
|
|
|
|
:ref:`Table 1 <mrs_02_0007__table40115147113128>` describes MRS APIs that meet RESTful API design standards.
|
|
|
|
:ref:`Table 2 <mrs_02_0007__table521983381017>` lists MRS Manager APIs provided by MRS.
|
|
|
|
.. _mrs_02_0007__table40115147113128:
|
|
|
|
.. table:: **Table 1** APIs
|
|
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| API | Function | API URI |
|
|
+================================+======================================================================+=========================================================================================+
|
|
| Data source APIs | :ref:`Creating a Data Source <mrs_02_0022>` | POST /v1.1/{project_id}/data-sources |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Updating a Data Source <mrs_02_0023>` | PUT /v1.1/{project_id}/data-sources/{data_source_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Data Source List <mrs_02_0024>` | GET /v1.1/{project_id}/data-sources |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Data Source Details <mrs_02_0025>` | GET /v1.1/{project_id}/data-sources/{data_source_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Data Source <mrs_02_0026>` | DELETE /v1.1/{project_id}/data-sources/{data_source_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Cluster management APIs (V2) | :ref:`Creating Clusters <mrs_02_0101>` | POST /v2/{project_id}/clusters |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Cluster management APIs (V1) | :ref:`Creating a Cluster and Running a Job <mrs_02_0028>` | POST /v1.1/{project_id}/run-job-flow |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Resizing a Cluster <mrs_02_0029>` | PUT /v1.1/{project_id}/cluster_infos/{cluster_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a Cluster List <mrs_02_0030>` | GET /v1.1/{project_id}/cluster_infos |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Cluster Details <mrs_02_0031>` | GET /v1.1/{project_id}/cluster_infos/{cluster_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Cluster <mrs_02_0032>` | DELETE /v1.1/{project_id}/clusters/{cluster_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a Host List <mrs_02_0057>` | GET /v1.1/{project_id}/clusters/{cluster_id}/hosts |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Job binary object APIs | :ref:`Creating a Job Binary Object <mrs_02_0034>` | POST /v1.1/{project_id}/job-binaries |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Updating a Job Binary Object <mrs_02_0035>` | PUT /v1.1/{project_id}/job-binaries/{job_binary_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Binary Object List <mrs_02_0036>` | GET /v1.1/{project_id}/job-binaries |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Binary Object Details <mrs_02_0037>` | GET /v1.1/{project_id}/job-binaries/{job_binary_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Job Binary Object <mrs_02_0038>` | DELETE /v1.1/{project_id}/job-binaries/{job_binary_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Job object APIs (V1) | :ref:`Adding a Job and Executing the Job <mrs_02_0040>` | POST /v1.1/{project_id}/jobs/submit-job |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Creating a Job Object <mrs_02_0041>` | POST /v1.1/{project_id}/jobs |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Updating a Job Object <mrs_02_0042>` | PATCH /v1.1/{project_id}/jobs/{job_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Executing a Job Object <mrs_02_0043>` | POST /v1.1/{project_id}/jobs/{job_id}/execute |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Job Object List <mrs_02_0044>` | GET /v1.1/{project_id}/jobs |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Job Object Details <mrs_02_0045>` | GET /v1.1/{project_id}/jobs/{job_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying the exe Object List of Jobs <mrs_02_0046>` | GET /v1.1/{project_id}/job-exes |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying exe Object Details <mrs_02_0047>` | GET /v1.1/{project_id}/job-exes/{job_exe_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Job Object <mrs_02_0048>` | DELETE /v1.1/{project_id}/jobs/{job_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Job execution object APIs (V1) | :ref:`Querying the Job Execution Object List <mrs_02_0050>` | GET /v1.1/{project_id}/job-executions |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Job Execution Object Details <mrs_02_0051>` | GET /v1.1/{project_id}/job-executions/{job_execution_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Canceling Job Execution <mrs_02_0052>` | GET /v1.1/{project_id}/job-executions/{job_execution_id}/cancel |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Job Execution Object <mrs_02_0053>` | DELETE /v1.1/{project_id}/job-executions/{job_execution_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Job object APIs (V2) | :ref:`Adding and Executing a Job <mrs_02_0085>` | POST /v2/{project_id}/clusters/{cluster_id}/job-executions |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Information About a Job <mrs_02_0086>` | GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a List of Jobs <mrs_02_0087>` | GET /v2/{project_id}/clusters/{cluster_id}/job-executions |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Terminating a Job <mrs_02_0088>` | POST /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/kill |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting Jobs in Batches <mrs_02_0089>` | POST /v2/{project_id}/clusters/{cluster_id}/job-executions/batch-delete |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Obtain the SQL Result <mrs_02_0090>` | GET /v2/{project_id}/clusters/{cluster_id}/job-executions/{job_execution_id}/sql-result |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Auto scaling APIs | :ref:`Configuring an Auto Scaling Rule <mrs_02_0056>` | POST /v1.1/{project_id}/autoscaling-policy/{cluster_id} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| Tag Management APIs | :ref:`Adding a Tag to a Specified Cluster <mrs_02_0071>` | POST /v1.1/{project_id}/clusters/{cluster_id}/tags |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Deleting a Tag of a Specified Cluster <mrs_02_0072>` | DELETE /v1.1/{project_id}/clusters/{cluster_id}/tags/{key} |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying Tags of a Specified Cluster <mrs_02_0073>` | GET /v1.1/{project_id}/clusters/{cluster_id}/tags |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Adding or Deleting Cluster Tags in Batches <mrs_02_0074>` | POST /v1.1/{project_id}/clusters/{cluster_id}/tags/action |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying All Tags <mrs_02_0075>` | GET /v1.1/{project_id}/clusters/tags |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
| | :ref:`Querying a List of Clusters with Specified Tags <mrs_02_0076>` | POST /v1.1/{project_id}/clusters/resource_instances/action |
|
|
+--------------------------------+----------------------------------------------------------------------+-----------------------------------------------------------------------------------------+
|
|
|
|
.. _mrs_02_0007__table521983381017:
|
|
|
|
.. table:: **Table 2** MRS Manager API
|
|
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| API | Function | API URI |
|
|
+=====================+===========================================================================+=========================================================================+
|
|
| MRS Manager CAS API | :ref:`Logging In to the CAS <mrs_02_1084>` | POST /cas/login |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Logging Out of the CAS <mrs_02_1085>` | POST /cas/logout |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| MRS Manager WEB API | :ref:`Checking the Login <mrs_02_1087>` | GET /web/v1/access/login_check |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Modifying the Password of the Current Login User <mrs_02_1088>` | POST /web/v1/access/modify_self_password |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Health Status of a Specified Cluster <mrs_02_1089>` | GET /web/v1/cluster/{cluster_id}/status |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Querying Basic Information About a Specified Cluster <mrs_02_1090>` | GET /web/v1/clusters |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Querying the Command Execution Progress <mrs_02_1091>` | GET /web/v1/common/command/{command_id}/progress |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Saving Configurations <mrs_02_1092>` | POST /web/v1/config/cluster/{cluster_id}/save |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Logging Out Of a Session <mrs_02_1093>` | GET /web/v1/logout_action |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Starting a Service <mrs_02_1094>` | POST /web/v1/maintain/cluster/{cluster_id}/service/{service_name}/start |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Stopping a Service <mrs_02_1095>` | POST /web/v1/maintain/cluster/{cluster_id}/service/{service_name}/stop |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Querying Monitoring Data <mrs_02_1096>` | GET /web/v1/monitor/metrics_info |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|
|
| | :ref:`Querying Summary of a Specified Service <mrs_02_1097>` | GET /web/v1/cluster/{cluster_id}/services/{service_name} |
|
|
+---------------------+---------------------------------------------------------------------------+-------------------------------------------------------------------------+
|