forked from docs/doc-exports
Mei, Sai
46435e6aee
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Mei, Sai <meisai@huawei.com> Co-committed-by: Mei, Sai <meisai@huawei.com>
223 lines
17 KiB
HTML
223 lines
17 KiB
HTML
<a name="en-us_topic_0218811271"></a><a name="en-us_topic_0218811271"></a>
|
|
|
|
<h1 class="topictitle1">Querying Asynchronous Operation Results</h1>
|
|
<div id="body22602070"><div class="section" id="en-us_topic_0218811271__section30169808"><h4 class="sectiontitle">Function</h4><p id="en-us_topic_0218811271__p10472105184713">This API is used to query asynchronous operation results.</p>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0218811271__section3092822"><h4 class="sectiontitle">URI</h4><ul id="en-us_topic_0218811271__ul48703167"><li id="en-us_topic_0218811271__li35675320">URI format<p id="en-us_topic_0218811271__p52642430"><a name="en-us_topic_0218811271__li35675320"></a><a name="li35675320"></a>GET /v1.0/plasconnector/connectors/{connector_id}/operations/{operation_id}</p>
|
|
</li><li id="en-us_topic_0218811271__li4019825">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811271__table36178426" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811271__row17103271"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.2.2.2.1.1.5.1.1"><p id="en-us_topic_0218811271__p43187730">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.2.2.2.1.1.5.1.2"><p id="en-us_topic_0218811271__p8545254">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.2.2.2.1.1.5.1.3"><p id="en-us_topic_0218811271__p21076937">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.2.2.2.1.1.5.1.4"><p id="en-us_topic_0218811271__p29510374">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0218811271__row41530083"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0218811271__p8493544">connector_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0218811271__p16888478">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0218811271__p25789484">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0218811271__p8573499">Indicates the PLAS connector ID.</p>
|
|
<p id="en-us_topic_0218811271__p10052635">The value is a string of 1 to 36 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row23364851"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.2.2.2.1.1.5.1.1 "><p id="en-us_topic_0218811271__p13504763">operation_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.2.2.2.1.1.5.1.2 "><p id="en-us_topic_0218811271__p20143995">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.2.2.2.1.1.5.1.3 "><p id="en-us_topic_0218811271__p21050908">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.2.2.2.1.1.5.1.4 "><p id="en-us_topic_0218811271__p27401989">Indicates the operation ID.</p>
|
|
<p id="en-us_topic_0218811271__p45291317">The value is a string of 1 to 36 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0218811271__section27835406"><h4 class="sectiontitle">Request</h4><ul id="en-us_topic_0218811271__ul44718046"><li id="en-us_topic_0218811271__li66918098">Parameter description<p id="en-us_topic_0218811271__p65391972"><a name="en-us_topic_0218811271__li66918098"></a><a name="li66918098"></a>None</p>
|
|
</li><li id="en-us_topic_0218811271__li51656837">Sample request<pre class="codeblock" id="en-us_topic_0218811271__codeblock62258350">GET /v1.0/plasconnector/connectors/e7b778a7-5d94-4263-813f-4aec18473a5a/operations/95a44e38-5d61-44ca-a5c4-f241812fbd51 HTTP/1.1 </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock23454240">Content-Type:application/json </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock9761572">Accept:application/json; </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock20745292">X-Auth-Token:MIIDwAYJKoZIhvcNAQcCoIIDsTCCA60CAQExDTALBglghkgB</pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0218811271__section49192063"><h4 class="sectiontitle">Response</h4><ul id="en-us_topic_0218811271__ul2647088"><li id="en-us_topic_0218811271__li23823799">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811271__table13087605" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811271__row7835219"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.2.1.1.1.5.1.1"><p id="en-us_topic_0218811271__p30672993">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.4.2.1.1.1.5.1.2"><p id="en-us_topic_0218811271__p1484508">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.2.1.1.1.5.1.3"><p id="en-us_topic_0218811271__p53136299">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.4.2.1.1.1.5.1.4"><p id="en-us_topic_0218811271__p9072951">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0218811271__row63820391"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811271__p2069155">operationId</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811271__p33383892">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811271__p19740770">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811271__p55498548">Indicates the operation ID.</p>
|
|
<p id="en-us_topic_0218811271__p29724891">The value is a string of 1 to 36 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row66197427"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811271__p60391366">operationType</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811271__p59862486">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811271__p17023178">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811271__p36700171">Indicates the operation type.</p>
|
|
<p id="en-us_topic_0218811271__p61866083">Value range:</p>
|
|
<ul id="en-us_topic_0218811271__ul19923840"><li id="en-us_topic_0218811271__li45096833">Create</li><li id="en-us_topic_0218811271__li3218321">Delete</li><li id="en-us_topic_0218811271__li28964896">Update</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row59357480"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811271__p43226538">finished</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811271__p11688705">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811271__p7261077">boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811271__p51276365">Specifies whether the operation is successful.</p>
|
|
<p id="en-us_topic_0218811271__p58834106">Value range:</p>
|
|
<ul id="en-us_topic_0218811271__ul59744914"><li id="en-us_topic_0218811271__li833316">true</li><li id="en-us_topic_0218811271__li7499851">false</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row389799"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811271__p31573738">operateAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811271__p7335957">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811271__p57341649">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811271__p14161989">Indicates the operation time in UNIX time format.</p>
|
|
<p id="en-us_topic_0218811271__p60349044">The value is a string of 1 to 36 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row6270490"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811271__p38147704">finishedAt</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811271__p2956294">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811271__p38133228">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811271__p1783763">Indicates the completion time in UNIX time format.</p>
|
|
<p id="en-us_topic_0218811271__p16053870">The value is a string of 1 to 36 characters.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row10267106"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.2.1.1.1.5.1.1 "><p id="en-us_topic_0218811271__p26329282">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.2.1.1.1.5.1.2 "><p id="en-us_topic_0218811271__p52297115">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.2.1.1.1.5.1.3 "><p id="en-us_topic_0218811271__p8207892">Result object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.2.1.1.1.5.1.4 "><p id="en-us_topic_0218811271__p60859477">Indicates the operation result.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
<p class="msonormal" id="en-us_topic_0218811271__p10864384">The Result object has the following attributes.</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811271__table30670599" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811271__row38764112"><th align="left" class="cellrowborder" valign="top" width="19.388061193880613%" id="mcps1.3.4.4.1.5.1.1"><p id="en-us_topic_0218811271__p52885363">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="17.348265173482652%" id="mcps1.3.4.4.1.5.1.2"><p id="en-us_topic_0218811271__p55856019">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="14.288571142885711%" id="mcps1.3.4.4.1.5.1.3"><p id="en-us_topic_0218811271__p28043671">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="48.97510248975102%" id="mcps1.3.4.4.1.5.1.4"><p id="en-us_topic_0218811271__p56944872">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0218811271__row49131885"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811271__p20259726">result</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811271__p30425141">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811271__p48517319">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811271__p37588782">Indicates the operation result.</p>
|
|
<p id="en-us_topic_0218811271__p2754725">Value range:</p>
|
|
<ul id="en-us_topic_0218811271__ul24792530"><li id="en-us_topic_0218811271__li21806182">success</li><li id="en-us_topic_0218811271__li62037914">failed</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row21470319"><td class="cellrowborder" valign="top" width="19.388061193880613%" headers="mcps1.3.4.4.1.5.1.1 "><p id="en-us_topic_0218811271__p61374313">reason</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="17.348265173482652%" headers="mcps1.3.4.4.1.5.1.2 "><p id="en-us_topic_0218811271__p5263484">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="14.288571142885711%" headers="mcps1.3.4.4.1.5.1.3 "><p id="en-us_topic_0218811271__p23689039">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="48.97510248975102%" headers="mcps1.3.4.4.1.5.1.4 "><p id="en-us_topic_0218811271__p39763978">Indicates the reason.</p>
|
|
<p id="en-us_topic_0218811271__p22331486">The value is a string of 0 to 255 characters.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<ul id="en-us_topic_0218811271__ul66765654"><li id="en-us_topic_0218811271__li64019978">Sample response<pre class="codeblock" id="en-us_topic_0218811271__codeblock39308890">HTTP/1.1 200 OK </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock18235697">Content-Type:application/json </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock29903551">Cache-Control:no-cache </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock696509"></pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock6268589">{ </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock56417302"> "operationId": "95a44e38-5d61-44ca-a5c4-f241812fbd51", </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock37993675"> "operationType": "create", </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock6398755"> "operateAt": "1517274000", </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock57588801"> "finishedAt": "1517274020" </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock48537165"> "finished": true, </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock34181304"> "result": { </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock39196283"> "result": "success", </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock17222231"> "reason": "" </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock20782358"> } </pre>
|
|
<pre class="codeblock" id="en-us_topic_0218811271__codeblock52823495">} </pre>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="en-us_topic_0218811271__section40075388"><h4 class="sectiontitle">Returned Value</h4><ul id="en-us_topic_0218811271__ul50844720"><li id="en-us_topic_0218811271__li54949297">Normal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811271__table24781625" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811271__row21396142"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.1.1.3.1.1"><p id="en-us_topic_0218811271__p55365980">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.1.1.1.3.1.2"><p id="en-us_topic_0218811271__p55459406">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0218811271__row63026925"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.1 "><p id="en-us_topic_0218811271__p4907296">200 OK</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.1.1.1.3.1.2 "><p id="en-us_topic_0218811271__p61946704">The operation is successfully returned.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li><li id="en-us_topic_0218811271__li20649426">Abnormal
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811271__table51627108" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811271__row41868331"><th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.2.1.1.3.1.1"><p id="en-us_topic_0218811271__p35891690">Returned Value</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.2.2.1.1.3.1.2"><p id="en-us_topic_0218811271__p21545810">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="en-us_topic_0218811271__row380170"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0218811271__p30793786">400 Bad Request</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0218811271__p11268747">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="en-us_topic_0218811271__row34309863"><td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.1 "><p id="en-us_topic_0218811271__p27635532">500 Internal Server Error</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.2.2.1.1.3.1.2 "><p id="en-us_topic_0218811271__p23885605">The server encountered an unexpected condition which prevented it from fulfilling the request.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0218811264.html">PLAS APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|