MRS API 2.0.38.SP20 version

Reviewed-by: gtema <artem.goncharov@gmail.com>
Co-authored-by: Yang, Tong <yangtong2@huawei.com>
Co-committed-by: Yang, Tong <yangtong2@huawei.com>
This commit is contained in:
Yang, Tong 2022-11-16 15:06:08 +00:00 committed by zuul
parent 1a4c1a720a
commit bd2b57f749
121 changed files with 23511 additions and 0 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,3 @@
version=""
language="en-us"
type=""

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 27 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 71 KiB

View File

@ -0,0 +1,21 @@
<a name="en-us_topic_0037324628"></a><a name="en-us_topic_0037324628"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body39451090"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0001.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0017.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0003.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0004.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0005.html">Concepts</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0006.html">Selecting an API Type</a></strong><br>
</li>
</ul>
</div>

View File

@ -0,0 +1,21 @@
<a name="mrs_01_9002"></a><a name="mrs_01_9002"></a>
<h1 class="topictitle1">Appendix</h1>
<div id="body1559185429881"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_01_9005.html">ECS Specifications Used by MRS</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0015.html">Status Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0011.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0016.html">Obtaining Account ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0091.html">Obtain MRS Cluster Information</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0106.html">Roles and components supported by MRS11</a></strong><br>
</li>
</ul>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,13 @@
<a name="mrs_02_0001"></a><a name="mrs_02_0001"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body1559185429880"><p id="mrs_02_0001__p187291720946">Welcome to <em id="mrs_02_0001__i2716182065718">MapReduce Service API Reference</em>. MapReduce Service (MRS) provides enterprise-level big data clusters on the cloud. Tenants can fully control the clusters and easily run big data components such as Hadoop, Spark, HBase, Kafka, and Storm in the clusters. </p>
<p id="mrs_02_0001__p4729420741">This document describes how to use application programming interfaces (APIs) to perform operations on MRS, such as creating or deleting clusters, adjusting nodes, as well as creating and executing jobs. For details about all supported operations, see <a href="mrs_02_0007.html">API Overview</a>.</p>
<p id="mrs_02_0001__en-us_topic_0170093943_p1297413722313">If you plan to access MRS through an API, ensure that you are familiar with MRS concepts. For details, see <strong id="mrs_02_0001__b795415342104">Service Overview</strong> in the <em id="mrs_02_0001__i1578181217712">MapReduce Service User Guide</em>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0037324628.html">Before You Start</a></div>
</div>
</div>

View File

@ -0,0 +1,15 @@
<a name="mrs_02_0002"></a><a name="mrs_02_0002"></a>
<h1 class="topictitle1">Calling APIs</h1>
<div id="body1559185429880"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0008.html">Making an API Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0009.html">Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0010.html">Response</a></strong><br>
</li>
</ul>
</div>

View File

@ -0,0 +1,12 @@
<a name="mrs_02_0003"></a><a name="mrs_02_0003"></a>
<h1 class="topictitle1">Endpoints</h1>
<div id="body1559185429880"><p id="mrs_02_0003__p101068593295">An endpoint is the <strong id="mrs_02_0003__b1336695864711">request address</strong> for calling an API. Endpoints vary depending on services and regions. For the endpoints of all services, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</p>
<p id="mrs_02_0003__p17803102841112">.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0037324628.html">Before You Start</a></div>
</div>
</div>

View File

@ -0,0 +1,11 @@
<a name="mrs_02_0004"></a><a name="mrs_02_0004"></a>
<h1 class="topictitle1">Constraints</h1>
<div id="body1559186694618"><ul id="mrs_02_0004__en-us_topic_0170093946_ul16164549183915"><li id="mrs_02_0004__en-us_topic_0170093946_li111641049203910">For more constraints, see API description.</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0037324628.html">Before You Start</a></div>
</div>
</div>

View File

@ -0,0 +1,20 @@
<a name="mrs_02_0005"></a><a name="mrs_02_0005"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body1559185429880"><ul id="mrs_02_0005__en-us_topic_0170093947_ul128965163312"><li id="mrs_02_0005__en-us_topic_0169294976_li489681620316">Domain<p id="mrs_02_0005__en-us_topic_0169294976_p1089611169316"><a name="mrs_02_0005__en-us_topic_0169294976_li489681620316"></a><a name="en-us_topic_0169294976_li489681620316"></a>A domain is created upon successful registration with the cloud platform. The domain has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The domain is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.</p>
</li><li id="mrs_02_0005__en-us_topic_0169294976_li15896816113116">User<p id="mrs_02_0005__en-us_topic_0169294976_p589691603117"><a name="mrs_02_0005__en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0169294976_li15896816113116"></a>A user is created using a domain to use cloud services. Each user has its own identity credentials (password and access keys).</p>
<p id="mrs_02_0005__en-us_topic_0169294976_p9896121653112">The domain username, and password will be required for API authentication.</p>
</li><li id="mrs_02_0005__en-us_topic_0169294976_li1564913617106">Region<p id="mrs_02_0005__en-us_topic_0169294976_p10588103711107"><a name="mrs_02_0005__en-us_topic_0169294976_li1564913617106"></a><a name="en-us_topic_0169294976_li1564913617106"></a>Regions are geographic areas isolated from each other. Resources are region-specific and cannot be used across regions through internal network connections. For low network latency and quick resource access, select the nearest region.</p>
</li><li id="mrs_02_0005__en-us_topic_0169294976_li1183783919109">AZ<p id="mrs_02_0005__en-us_topic_0169294976_p061084051014"><a name="mrs_02_0005__en-us_topic_0169294976_li1183783919109"></a><a name="en-us_topic_0169294976_li1183783919109"></a>An AZ contains one or more physical data centers. Each AZ has independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Within an AZ, computing, network, storage, and other resources are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to support cross-AZ high-availability systems.</p>
</li><li id="mrs_02_0005__en-us_topic_0169294976_li3896216123113">Project<p id="mrs_02_0005__en-us_topic_0169294976_p10896181643118"><a name="mrs_02_0005__en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0169294976_li3896216123113"></a>Projects group and isolate resources (including compute, storage, and network resources) across physical regions. A default project is provided for each region, and sub-projects can be created under each default project. Users can be granted permissions to access all resources in a specific project in your domain. For more refined access control, create sub-projects under a project and create resources in the sub-projects. Users can then be assigned permissions to access only specific resources in the sub-projects.</p>
<div class="fignone" id="mrs_02_0005__en-us_topic_0169294976_fig1189614168311"><span class="figcap"><b>Figure 1 </b>Project isolation model</span><br><span><img id="mrs_02_0005__en-us_topic_0169294976_image689661615316" src="en-us_image_0000001351245889.gif"></span></div>
</li><li id="mrs_02_0005__li121713717135">Checkpoint<p id="mrs_02_0005__p18235107134"><a name="mrs_02_0005__li121713717135"></a><a name="li121713717135"></a>Checkpoint: When an application consumes data, the latest SN of the consumed data is recorded as a checkpoint. When the data is reconsumed, the consumption can be continued based on this checkpoint.</p>
</li><li id="mrs_02_0005__li1889621216137">App<p id="mrs_02_0005__p152424143135"><a name="mrs_02_0005__li1889621216137"></a><a name="li1889621216137"></a>Application: Multiple applications can access data in the same stream. Checkpoints generated for each application are used to record the consumed data in the stream by each application.</p>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0037324628.html">Before You Start</a></div>
</div>
</div>

View File

@ -0,0 +1,15 @@
<a name="mrs_02_0006"></a><a name="mrs_02_0006"></a>
<h1 class="topictitle1">Selecting an API Type</h1>
<div id="body1559185429880"><p id="mrs_02_0006__p732811110593">Currently, MRS provides two types (V1 and V2) of APIs for cloud services with customized specifications. Only part of V2 APIs is available and mainly used for submitting jobs and SQL statements. If the API functions are the same, you are advised to use the V2 APIs first.</p>
<p id="mrs_02_0006__p15700131314378">All MRS versions support the V1 APIs. MRS 1.9.2 or later supports the V2 APIs.</p>
<p id="mrs_02_0006__p85341957192919">Based on the V1 APIs, the V2 APIs have the following enhancements:</p>
<ul id="mrs_02_0006__ul73634545311"><li id="mrs_02_0006__li1836045135318">Jobs can be submitted in a security cluster.</li><li id="mrs_02_0006__li1360456531">The HiveSQL, Spark Python, and Flink jobs are supported.</li><li id="mrs_02_0006__li193664520538">The SparkSQL and SparkScript results can be queried.</li></ul>
<p id="mrs_02_0006__p153525714299">For details about the APIs and their functions, see <a href="mrs_02_0007.html">API Overview</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0037324628.html">Before You Start</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,39 @@
<a name="mrs_02_0010"></a><a name="mrs_02_0010"></a>
<h1 class="topictitle1">Response</h1>
<div id="body1559185429880"><div class="section" id="mrs_02_0010__en-us_topic_0170155703_section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0010__en-us_topic_0170155703_p4624111624411">After sending a request, you will receive a response, including a status code, response header, and response body.</p>
<p id="mrs_02_0010__en-us_topic_0170155703_p124381044137">A status code is a group of digits, ranging from 1<em id="mrs_02_0010__i017391614548">xx</em> to 5<em id="mrs_02_0010__i1017421617542">xx</em>. It indicates the status of a request. For more information, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
<p id="mrs_02_0010__en-us_topic_0170155703_p2861496519">For the API to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain request authentication</a>, if the status code <span class="parmvalue" id="mrs_02_0010__parmvalue173341316182710"><b>201</b></span> is returned after the API is called, the request is successful.</p>
</div>
<div class="section" id="mrs_02_0010__en-us_topic_0170155703_en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="mrs_02_0010__en-us_topic_0170155703_p384320471837">Similar to a request, a response also has a header, for example, <strong id="mrs_02_0010__b2731055155417">Content-Type</strong>.</p>
<p id="mrs_02_0010__en-us_topic_0170155703_p4430113619484"><a href="#mrs_02_0010__en-us_topic_0170155703_fig4865141011511">Figure 1</a> shows the response header fields for the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain request authentication</a>. The <span class="parmname" id="mrs_02_0010__parmname9859162513286"><b>x-subject-token</b></span> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
<div class="fignone" id="mrs_02_0010__en-us_topic_0170155703_fig4865141011511"><a name="mrs_02_0010__en-us_topic_0170155703_fig4865141011511"></a><a name="en-us_topic_0170155703_fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="mrs_02_0010__image1449194212713" src="en-us_image_0000001298246380.png"></span></div>
</div>
<div class="section" id="mrs_02_0010__en-us_topic_0170155703_en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="mrs_02_0010__en-us_topic_0170155703_en-us_topic_0113746487_p64711881416">This part is optional. The body of a response is often returned in structured format (for example, JSON or XML) as specified in the <strong id="mrs_02_0010__b759917109561">Content-Type</strong> header field. The response body transfers content except the response header.</p>
</div>
<p id="mrs_02_0010__en-us_topic_0170155703_p157041652367">The following shows the response body for the API to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain request authentication</a>. For the sake of space, only part of the content is displayed here.</p>
<pre class="screen" id="mrs_02_0010__en-us_topic_0170155703_screen65818201917">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "aaa"//The region ID "aaa" is used as an example.
...</pre>
<p id="mrs_02_0010__en-us_topic_0170155703_p127537375412">If an error occurs during API calling, an error code and a message will be displayed. The following shows an error response body.</p>
<pre class="screen" id="mrs_02_0010__en-us_topic_0170155703_screen102091730125513">{
"error_msg": "Invalid cluster name.",
"error_code": "12000002"
}</pre>
<p id="mrs_02_0010__en-us_topic_0170155703_p1589911464018">In the response body, <strong id="mrs_02_0010__b1998919475562">error_code</strong> is an error code, and <strong id="mrs_02_0010__b1299034775617">error_msg</strong> provides information about the error.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0002.html">Calling APIs</a></div>
</div>
</div>

View File

@ -0,0 +1,42 @@
<a name="mrs_02_0011"></a><a name="mrs_02_0011"></a>
<h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body1559185429881"><div class="section" id="mrs_02_0011__section964292414404"><h4 class="sectiontitle">Obtaining a Project ID from the Management Console</h4><p id="mrs_02_0011__p1472416044213">A project ID (<strong id="mrs_02_0011__b947619341604">project_id</strong>) is required for some URLs when an API is called. To obtain a project ID, perform the following operations:</p>
<ol id="mrs_02_0011__ol172412004213"><li id="mrs_02_0011__li1772412012422">Log in to the management console.</li><li id="mrs_02_0011__li3724190124219">Click the username and choose <strong id="mrs_02_0011__b1714318271634">My Credentials</strong> from the drop-down list.<p id="mrs_02_0011__p47241906429">On the <strong id="mrs_02_0011__b19239184819115">My Credentials</strong> page, view project IDs in the project list.</p>
</li></ol>
<p id="mrs_02_0011__p748044519418">If there are multiple projects in one region, expand <strong id="mrs_02_0011__b36307239217">Region</strong> and view subproject IDs in the <strong id="mrs_02_0011__b1463242319212">Project ID</strong> column.</p>
</div>
<div class="section" id="mrs_02_0011__section199243176407"><h4 class="sectiontitle">Obtaining a Project ID by Calling an API</h4><p id="mrs_02_0011__p188021379593">You can obtain the project ID by calling the IAM API used to query project information based on the specified criteria.</p>
<p id="mrs_02_0011__p5924317194011">The API used to obtain a project ID is <strong id="mrs_02_0011__b1628111114378">GET https://</strong><em id="mrs_02_0011__i1262911115377">{Endpoint}</em><strong id="mrs_02_0011__b10629161116372">/v3/projects</strong>. <em id="mrs_02_0011__i176294111370">{Endpoint}</em> is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. For details about API authentication, see <a href="mrs_02_0009.html">Authentication</a>.</p>
<p id="mrs_02_0011__p11925101711406">The following is an example response. The value of <strong id="mrs_02_0011__b1921338123016">id</strong> under <strong id="mrs_02_0011__b19933381303">projects</strong> is the project ID of the region specified by <strong id="mrs_02_0011__b329762511172">name</strong>.</p>
<pre class="screen" id="mrs_02_0011__screen199253174407">{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14e684b",
"name": "<em id="mrs_02_0011__i3261144419261">region_id</em>",
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
},
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_01_9002.html">Appendix</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,13 @@
<a name="mrs_02_0016"></a><a name="mrs_02_0016"></a>
<h1 class="topictitle1">Obtaining Account ID</h1>
<div id="body1559185429881"><p id="mrs_02_0016__p8112855194115">A domain ID (<strong id="mrs_02_0016__b948844116579">domain-id</strong>) is required for some URLs when an API is called. To obtain an account ID, perform the following operations:</p>
<ol id="mrs_02_0016__ol8715914194127"><li id="mrs_02_0016__li50056756194127">Log in to the management console.</li><li id="mrs_02_0016__li2804809915217">Click the username and choose <span class="uicontrol" id="mrs_02_0016__uicontrol37261314112815"><b>My Credentials</b></span> from the drop-down list.<p id="mrs_02_0016__p136772519449">View the account ID</p>
</li></ol>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_01_9002.html">Appendix</a></div>
</div>
</div>

View File

@ -0,0 +1,11 @@
<a name="mrs_02_0017"></a><a name="mrs_02_0017"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body1559185429880"><p id="mrs_02_0017__p610414951811">MRS support Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS. For details about API calling, see <a href="mrs_02_0008.html">Calling APIs</a>.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0037324628.html">Before You Start</a></div>
</div>
</div>

View File

@ -0,0 +1,27 @@
<a name="mrs_02_0020"></a><a name="mrs_02_0020"></a>
<h1 class="topictitle1">APIs</h1>
<div id="body1480125376815"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0021.html">Data Source APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0100.html">Cluster management APIs (V2)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0027.html">Cluster management APIs (V1)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0033.html">Job Binary Object APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0039.html">Job Object APIs (V1, Not Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0049.html">Job Execution Object APIs (V1, Not Recommended)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0084.html">Job Object APIs (V2)</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0054.html">Auto Scaling APIs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0070.html">Tag Management APIs</a></strong><br>
</li>
</ul>
</div>

View File

@ -0,0 +1,23 @@
<a name="mrs_02_0021"></a><a name="mrs_02_0021"></a>
<h1 class="topictitle1">Data Source APIs</h1>
<div id="body1484116919792"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0022.html">Creating a Data Source</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0023.html">Updating a Data Source</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0024.html">Querying the Data Source List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0025.html">Querying the Data Source Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0026.html">Deleting a Data Source</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0020.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,69 @@
<a name="mrs_02_0026"></a><a name="mrs_02_0026"></a>
<h1 class="topictitle1">Deleting a Data Source</h1>
<div id="body1484116919792"><div class="section" id="mrs_02_0026__section11410068144834"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0026__p30367694144836">This API is used to delete a data source. This API is compatible with Sahara.</p>
</div>
<div class="section" id="mrs_02_0026__section4721807314497"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0026__u749b0e1d16034ea99b9d31909ce7ee80"><li id="mrs_02_0026__li11455125218466">Format<p id="mrs_02_0026__p14839101194713"><a name="mrs_02_0026__li11455125218466"></a><a name="li11455125218466"></a>DELETE /v1.1/{project_id}/data-sources/{data_source_id}</p>
</li><li id="mrs_02_0026__li831194172516">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0026__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0026__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0026__p16571835194812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0026__p141410194812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0026__p11454278194812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0026__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0026__p3492262515356">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0026__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0026__p1768719515356">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="mrs_02_0026__row20659256153330"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0026__p62787041153330">data_source_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0026__p52585595153330">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0026__p31574830153330">Data source ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_0026__section31697334144924"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0026__p819416241014"><strong id="mrs_02_0026__b139822112354">Request parameters</strong></p>
<p id="mrs_02_0026__p27389112109">None.</p>
</div>
<div class="section" id="mrs_02_0026__section10069032144933"><h4 class="sectiontitle">Response</h4><p id="mrs_02_0026__p6891534181015"><strong id="mrs_02_0026__b4516182183510">Response parameters</strong></p>
<p id="mrs_02_0026__p1010619393102">None.</p>
</div>
<div class="section" id="mrs_02_0026__section19194135931014"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0026__ul172515914113"><li id="mrs_02_0026__li157251498118">Example request<pre class="screen" id="mrs_02_0026__screen209191433184714">DELETE /v1.1/{project_id}/data-sources/{data_source_id}</pre>
</li><li id="mrs_02_0026__li945517153115">Example response<p id="mrs_02_0026__p18680165281213"><a name="mrs_02_0026__li945517153115"></a><a name="li945517153115"></a>None.</p>
</li></ul>
</div>
<div class="section" id="mrs_02_0026__section13299747144948"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0026__p5547365016031"><a href="#mrs_02_0026__table1584477916050">Table 2</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="mrs_02_0026__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0026__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="mrs_02_0026__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0026__p3411176516050">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0026__p1158961516050">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0026__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0026__p6022194016050">204</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0026__p4613894216050">The data source is deleted successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="mrs_02_0026__p2536122255112">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0021.html">Data Source APIs</a></div>
</div>
</div>

View File

@ -0,0 +1,25 @@
<a name="mrs_02_0027"></a><a name="mrs_02_0027"></a>
<h1 class="topictitle1">Cluster management APIs (V1)</h1>
<div id="body1480125376815"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0028.html">Creating a Cluster and Running a Job</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0029.html">Resizing a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0030.html">Querying a Cluster List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0031.html">Querying Cluster Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0032.html">Deleting a Cluster</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0057.html">Querying a Host List</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0020.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,71 @@
<a name="mrs_02_0032"></a><a name="mrs_02_0032"></a>
<h1 class="topictitle1">Deleting a Cluster</h1>
<div id="body1480125376815"><div class="section" id="mrs_02_0032__section4408504619327"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0032__p5843728119329">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.</p>
<div class="p" id="mrs_02_0032__p50795329151554">Clusters in any of the following states cannot be terminated:<ul id="mrs_02_0032__ul59382559151612"><li id="mrs_02_0032__li64680991151612">scaling-out</li><li id="mrs_02_0032__li13114449151620">scaling-in</li><li id="mrs_02_0032__li53944748151635">starting</li><li id="mrs_02_0032__li44335036151627">terminating</li><li id="mrs_02_0032__li14109908151659">terminated</li><li id="mrs_02_0032__li1467883315172">failed</li></ul>
</div>
</div>
<div class="section" id="mrs_02_0032__section10186656193217"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0032__ul2809877319471"><li id="mrs_02_0032__li5177607319471">Format<p id="mrs_02_0032__p59483855194713"><a name="mrs_02_0032__li5177607319471"></a><a name="li5177607319471"></a>DELETE /v1.1/{project_id}/clusters/{cluster_id}</p>
</li><li id="mrs_02_0032__li2957566119471">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0032__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0032__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0032__p16571835194812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0032__p141410194812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0032__p11454278194812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0032__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0032__p3492262515356">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0032__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0032__p1768719515356">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="mrs_02_0032__row37407495194754"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0032__p56702435194812">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0032__p29494508194812">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0032__p40820562194812">Cluster ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_0032__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0032__p1842961591514"><strong id="mrs_02_0032__b139822112354">Request parameters</strong></p>
<p id="mrs_02_0032__p106160258151">None.</p>
</div>
<div class="section" id="mrs_02_0032__section38599577193858"><h4 class="sectiontitle">Response</h4><p id="mrs_02_0032__p137610236182"><strong id="mrs_02_0032__b4516182183510">Response parameters</strong></p>
<p id="mrs_02_0032__p785103420187">None.</p>
</div>
<div class="section" id="mrs_02_0032__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0032__ul1958913536182"><li id="mrs_02_0032__li1558945321814">Example request<p id="mrs_02_0032__p8671133419191"><a name="mrs_02_0032__li1558945321814"></a><a name="li1558945321814"></a>None.</p>
</li><li id="mrs_02_0032__li543710159193">Example response<p id="mrs_02_0032__p156441832121919"><a name="mrs_02_0032__li543710159193"></a><a name="li543710159193"></a>None.</p>
</li></ul>
</div>
<div class="section" id="mrs_02_0032__section4391766619434"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0032__p5547365016031"><a href="#mrs_02_0032__table1584477916050">Table 2</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="mrs_02_0032__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0032__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="mrs_02_0032__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0032__p3411176516050">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0032__p1158961516050">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0032__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0032__p6022194016050">204</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0032__p4613894216050">The cluster has been successfully terminated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="mrs_02_0032__p168245499518">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0027.html">Cluster management APIs (V1)</a></div>
</div>
</div>

View File

@ -0,0 +1,23 @@
<a name="mrs_02_0033"></a><a name="mrs_02_0033"></a>
<h1 class="topictitle1">Job Binary Object APIs</h1>
<div id="body1484186386751"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0034.html">Creating a Job Binary Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0035.html">Updating a Job Binary Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0036.html">Querying the Binary Object List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0037.html">Querying the Binary Object Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0038.html">Deleting a Job Binary Object</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0020.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,69 @@
<a name="mrs_02_0038"></a><a name="mrs_02_0038"></a>
<h1 class="topictitle1">Deleting a Job Binary Object</h1>
<div id="body1484186386751"><div class="section" id="mrs_02_0038__section13541137101416"><h4 class="sectiontitle">Function</h4><p id="mrs_02_0038__p63692365101419">This API is used to delete a binary object. This API is compatible with Sahara.</p>
</div>
<div class="section" id="mrs_02_0038__section49980811101439"><h4 class="sectiontitle">URI</h4><ul id="mrs_02_0038__ul162842111254"><li id="mrs_02_0038__li6641434211254">Format<p id="mrs_02_0038__p234070511325"><a name="mrs_02_0038__li6641434211254"></a><a name="li6641434211254"></a>DELETE /v1.1/{project_id}/job-binaries/{job_binary_id}</p>
</li><li id="mrs_02_0038__li386774251136">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0038__table49499141194754" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter description</caption><thead align="left"><tr id="mrs_02_0038__row33700024194754"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="mrs_02_0038__p16571835194812">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="mrs_02_0038__p141410194812">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="mrs_02_0038__p11454278194812">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0038__row6505449415356"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0038__p3492262515356">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0038__p1016041415356">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0038__p1768719515356">Project ID. For details on how to obtain the project ID, see <a href="mrs_02_0011.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
<tr id="mrs_02_0038__row61502886104852"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="mrs_02_0038__p15677856104852">job_binary_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="mrs_02_0038__p61946843104852">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="mrs_02_0038__p51638399104852">Job binary object ID</p>
</td>
</tr>
</tbody>
</table>
</div>
</li></ul>
</div>
<div class="section" id="mrs_02_0038__section7976792193238"><h4 class="sectiontitle">Request</h4><p id="mrs_02_0038__p1842961591514"><strong id="mrs_02_0038__b139822112354">Request parameters</strong></p>
<p id="mrs_02_0038__p106160258151">None</p>
</div>
<div class="section" id="mrs_02_0038__section38599577193858"><h4 class="sectiontitle">Response</h4><p id="mrs_02_0038__p137610236182"><strong id="mrs_02_0038__b4516182183510">Response parameters</strong></p>
<p id="mrs_02_0038__p785103420187">None</p>
</div>
<div class="section" id="mrs_02_0038__section1210015461189"><h4 class="sectiontitle">Example</h4><ul id="mrs_02_0038__ul1958913536182"><li id="mrs_02_0038__li1558945321814">Example request<p id="mrs_02_0038__p8671133419191"><a name="mrs_02_0038__li1558945321814"></a><a name="li1558945321814"></a>None</p>
</li><li id="mrs_02_0038__li543710159193">Example response<p id="mrs_02_0038__p156441832121919"><a name="mrs_02_0038__li543710159193"></a><a name="li543710159193"></a>None</p>
</li></ul>
</div>
<div class="section" id="mrs_02_0038__section19688788101519"><h4 class="sectiontitle">Status Code</h4><p id="mrs_02_0038__p5547365016031"><a href="#mrs_02_0038__table1584477916050">Table 2</a> describes the status code of this API.</p>
<div class="tablenoborder"><a name="mrs_02_0038__table1584477916050"></a><a name="table1584477916050"></a><table cellpadding="4" cellspacing="0" summary="" id="mrs_02_0038__table1584477916050" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Status code</caption><thead align="left"><tr id="mrs_02_0038__row1339492016050"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.6.3.2.3.1.1"><p id="mrs_02_0038__p3411176516050">Status code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.6.3.2.3.1.2"><p id="mrs_02_0038__p1158961516050">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="mrs_02_0038__row3719767816050"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.6.3.2.3.1.1 "><p id="mrs_02_0038__p6022194016050">204</p>
</td>
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.6.3.2.3.1.2 "><p id="mrs_02_0038__p4613894216050">The binary object is deleted successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="mrs_02_0038__p2340171524">For the description about error status codes, see <a href="mrs_02_0015.html">Status Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0033.html">Job Binary Object APIs</a></div>
</div>
</div>

View File

@ -0,0 +1,31 @@
<a name="mrs_02_0039"></a><a name="mrs_02_0039"></a>
<h1 class="topictitle1">Job Object APIs (V1, Not Recommended)</h1>
<div id="body1480125376815"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="mrs_02_0040.html">Adding a Job and Executing the Job</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0041.html">Creating a Job Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0042.html">Updating a Job Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0043.html">Executing a Job Object</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0044.html">Querying the Job Object List</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0045.html">Querying Job Object Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0046.html">Querying the exe Object List of Jobs</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0047.html">Querying exe Object Details</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="mrs_02_0048.html">Deleting a Job Object</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="mrs_02_0020.html">APIs</a></div>
</div>
</div>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

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