PLAS API version1

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>
This commit is contained in:
Mei, Sai 2022-11-29 13:00:08 +00:00 committed by zuul
parent bbf8757cdf
commit 46435e6aee
31 changed files with 2247 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=""

View File

@ -0,0 +1,14 @@
<a name="en-us_topic_0218811261"></a><a name="en-us_topic_0218811261"></a>
<h1 class="topictitle1">Common Message Headers</h1>
<div id="body52706911"><p class="msonormal" id="en-us_topic_0218811261__p4490990">This chapter describes common request and response REST message headers.</p>
</div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0218811262.html">Common Request Headers</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0218811263.html">Common Response Headers</a></strong><br>
</li>
</ul>
</div>

View File

@ -0,0 +1,98 @@
<a name="en-us_topic_0218811262"></a><a name="en-us_topic_0218811262"></a>
<h1 class="topictitle1">Common Request Headers</h1>
<div id="body4883512">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811262__table8544631" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common request headers</caption><thead align="left"><tr id="en-us_topic_0218811262__row48651131"><th align="left" class="cellrowborder" valign="top" width="20.62%" id="mcps1.3.1.2.5.1.1"><p id="en-us_topic_0218811262__p48427543">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25.77%" id="mcps1.3.1.2.5.1.2"><p id="en-us_topic_0218811262__p30316907">Description</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="19.59%" id="mcps1.3.1.2.5.1.3"><p id="en-us_topic_0218811262__p39750432">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="34.02%" id="mcps1.3.1.2.5.1.4"><p id="en-us_topic_0218811262__p65668446">Example Value</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811262__row17543884"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p11768466">x-sdk-date</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p13721689">Time when the request is sent. The time is in <strong id="en-us_topic_0218811262__b56386340">YYYYMMDD'T'HHMMSS'Z'</strong> format.</p>
<p id="en-us_topic_0218811262__p37715016">The value is the current GMT time of the system.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p35017480">No</p>
<p id="en-us_topic_0218811262__p46721870">This parameter is mandatory for AK/SK authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p26375114">20150907T101459Z</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row36049434"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p34323003">Authorization</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p28699853">Authentication information.</p>
<p id="en-us_topic_0218811262__p56972087">The value can be obtained from the request signing result.</p>
<p id="en-us_topic_0218811262__p16953871446">For details, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328006.html" target="_blank" rel="noopener noreferrer">Signing a Request</a>.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p64605559">No</p>
<p id="en-us_topic_0218811262__p44579126">This parameter is mandatory for AK/SK authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p54139417">SDK-HMAC-SHA256 Credential=ZIRRKMTWPTQFQI1WKNKB/20150907//ec2/sdk_request, SignedHeaders=content-type;host;x-sdk-date, Signature=55741b610f3c9fa3ae40b5a8021ebf7ebc2a28a603fc62d25cb3bfe6608e1994</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row17492713"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p7623657">Host</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p13536461">Server domain name and port number of the resources being requested. The value can be obtained from the URL of the service API. The value is <em id="en-us_topic_0218811262__i54719288">hostname[:port]</em>. If the port number is not specified, the default port is used. The default port number for <strong id="en-us_topic_0218811262__b22711550">https</strong> is <strong id="en-us_topic_0218811262__b3077358">443</strong>.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p47939452">No</p>
<p id="en-us_topic_0218811262__p28801892">This parameter is mandatory for AK/SK authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p51251947">code.test.com</p>
<p id="en-us_topic_0218811262__p58614339">or</p>
<p id="en-us_topic_0218811262__p57767005">code.test.com:443</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row50141003"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p34889419">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p7470700">Request body MIME type.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p1146965">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p25795375">application/json</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row30831790"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p14347060">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p21261182">Length of the request body, expressed in bytes.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p44434164">This parameter is mandatory for POST and PUT requests but must be left blank for GET requests.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p42397568">3495</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row46033792"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p37749701">X-Project-Id</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p37826963">Project ID. This parameter is used to obtain the token for the project.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p44085137">No</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p14126311">e9993fc787d94b6c886cbaa340f9c0f4</p>
</td>
</tr>
<tr id="en-us_topic_0218811262__row60027939"><td class="cellrowborder" valign="top" width="20.62%" headers="mcps1.3.1.2.5.1.1 "><p id="en-us_topic_0218811262__p30424881">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="25.77%" headers="mcps1.3.1.2.5.1.2 "><p id="en-us_topic_0218811262__p48496300">User token.</p>
</td>
<td class="cellrowborder" valign="top" width="19.59%" headers="mcps1.3.1.2.5.1.3 "><p id="en-us_topic_0218811262__p35886203">Yes</p>
<p id="en-us_topic_0218811262__p54540374">This parameter is mandatory for token authentication.</p>
</td>
<td class="cellrowborder" valign="top" width="34.02%" headers="mcps1.3.1.2.5.1.4 "><p id="en-us_topic_0218811262__p55694143">None</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="note" id="en-us_topic_0218811262__note41431923"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p class="text" id="en-us_topic_0218811262__p30218124">For details about other parameters in the message header, see the HTTP protocol documentation.</p>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0218811261.html">Common Message Headers</a></div>
</div>
</div>

View File

@ -0,0 +1,35 @@
<a name="en-us_topic_0218811263"></a><a name="en-us_topic_0218811263"></a>
<h1 class="topictitle1">Common Response Headers</h1>
<div id="body21016952">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811263__table7669482" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Common response headers</caption><thead align="left"><tr id="en-us_topic_0218811263__row6308675"><th align="left" class="cellrowborder" valign="top" width="22.22222222222222%" id="mcps1.3.1.2.3.1.1"><p id="en-us_topic_0218811263__p41240639">Name</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="77.77777777777779%" id="mcps1.3.1.2.3.1.2"><p id="en-us_topic_0218811263__p52157488">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811263__row64007038"><td class="cellrowborder" valign="top" width="22.22222222222222%" headers="mcps1.3.1.2.3.1.1 "><p id="en-us_topic_0218811263__p17187600">Content-Length</p>
</td>
<td class="cellrowborder" valign="top" width="77.77777777777779%" headers="mcps1.3.1.2.3.1.2 "><p id="en-us_topic_0218811263__p50018383">Specifies the length of the response body. The unit is byte.</p>
</td>
</tr>
<tr id="en-us_topic_0218811263__row47512266"><td class="cellrowborder" valign="top" width="22.22222222222222%" headers="mcps1.3.1.2.3.1.1 "><p id="en-us_topic_0218811263__p23288375">Date</p>
</td>
<td class="cellrowborder" valign="top" width="77.77777777777779%" headers="mcps1.3.1.2.3.1.2 "><p id="en-us_topic_0218811263__p7310212">Specifies the time when a request response is returned.</p>
</td>
</tr>
<tr id="en-us_topic_0218811263__row65791910"><td class="cellrowborder" valign="top" width="22.22222222222222%" headers="mcps1.3.1.2.3.1.1 "><p id="en-us_topic_0218811263__p27544487">Content-type</p>
</td>
<td class="cellrowborder" valign="top" width="77.77777777777779%" headers="mcps1.3.1.2.3.1.2 "><p id="en-us_topic_0218811263__p16510940">Specifies the response body MIME type.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="en-us_topic_0218811261.html">Common Message Headers</a></div>
</div>
</div>

View File

@ -0,0 +1,21 @@
<a name="en-us_topic_0218811264"></a><a name="en-us_topic_0218811264"></a>
<h1 class="topictitle1">PLAS APIs</h1>
<div id="body57706137"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="en-us_topic_0218811265.html">Creating a PLAS Connector</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0218811266.html">Querying PLAS Connectors</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0218811268.html">Querying Details About a PLAS Connector</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0218811269.html">Modifying a PLAS Connector</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0218811270.html">Deleting a PLAS Connector</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0218811271.html">Querying Asynchronous Operation Results</a></strong><br>
</li>
</ul>
</div>

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,8 @@
<a name="en-us_topic_0218811267"></a><a name="en-us_topic_0218811267"></a>
<h1 class="topictitle1">API Usage Guidelines</h1>
<div id="body1591087780150"><p id="en-us_topic_0218811267__p142221912201015">Public cloud APIs comply with the RESTful API design principles. REST-based web services are organized into resources. Each resource is identified by one or more Uniform Resource Identifiers (URIs). An application accesses a resource based on the resource's Unified Resource Locator (URL). A URL is usually in the following format: https://<em id="en-us_topic_0218811267__i15222191215108">Endpoint/uri</em>. In the URL, <em id="en-us_topic_0218811267__i522211124108">uri</em> indicates the resource path, that is, the API access path.</p>
<p id="en-us_topic_0218811267__p12221212101020">Public cloud APIs use HTTPS as the transmission protocol. Requests/Responses are transmitted using JSON messages, with the media type represented by <strong id="en-us_topic_0218811267__b1322221219106">Application/json</strong>.</p>
<p id="en-us_topic_0218811267__p8222121221019">For details about how to use APIs, see <a href="https://docs.otc.t-systems.com/en-us/api/apiug/apig-en-api-180328001.html?tag=API Documents " target="_blank" rel="noopener noreferrer">API Usage Guidelines</a>.</p>
</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,55 @@
<a name="en-us_topic_0218811272"></a><a name="en-us_topic_0218811272"></a>
<h1 class="topictitle1">Change History</h1>
<div id="body66771667">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="en-us_topic_0218811272__table28628970" frame="border" border="1" rules="all"><thead align="left"><tr id="en-us_topic_0218811272__row20205523"><th align="left" class="cellrowborder" valign="top" width="25.25%" id="mcps1.3.1.1.3.1.1"><p id="en-us_topic_0218811272__p67023809">Released On</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="74.75%" id="mcps1.3.1.1.3.1.2"><p id="en-us_topic_0218811272__p60219412">What's New</p>
</th>
</tr>
</thead>
<tbody><tr id="en-us_topic_0218811272__row189913915916"><td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0218811272__p169911892915">2020-07-01</p>
</td>
<td class="cellrowborder" valign="top" width="74.75%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0218811272__p54443733612">This release incorporates the following changes:</p>
<ul id="en-us_topic_0218811272__ul26601713174011"><li id="en-us_topic_0218811272__li18113415104020">Modified the descriptions of <a href="en-us_topic_0218811267.html">API Usage Guidelines</a>.</li><li id="en-us_topic_0218811272__li1857125014471">Modified the hyperlinks of <a href="en-us_topic_0218811262.html">Common Request Headers</a>.</li><li id="en-us_topic_0218811272__li066051334020">Deleted the following topics:</li></ul>
<p id="en-us_topic_0218811272__p35161341153810">1.1 Service Usage</p>
<p id="en-us_topic_0218811272__p5516144115382">1.2 Request Methods</p>
<p id="en-us_topic_0218811272__p2051634163812">1.3 Request Authentication Methods</p>
<p id="en-us_topic_0218811272__p151634116384">1.4 Token Authentication</p>
<p id="en-us_topic_0218811272__p8516144117383">1.5 AK/SK Authentication</p>
<p id="en-us_topic_0218811272__p95161641153818">1.5.1 AK and SK Generation</p>
<p id="en-us_topic_0218811272__p1251684133812">1.5.2 Request Signing Procedure</p>
<p id="en-us_topic_0218811272__p135161641113812">1.5.3 Sample Codes</p>
<p id="en-us_topic_0218811272__p851613419386">1.6 Obtaining a Project ID</p>
</td>
</tr>
<tr id="en-us_topic_0218811272__row1489114415507"><td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0218811272__p16892184485017">2020-05-28</p>
</td>
<td class="cellrowborder" valign="top" width="74.75%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0218811272__p11150110175112">This release incorporates the following changes:</p>
<p id="en-us_topic_0218811272__p3480513115111">Modified the section name from Make an API Call to Calling an API in Token Authentication.</p>
<p id="en-us_topic_0218811272__p18575135012520">Modified the section name from Sign a Request to Signing a Request in Request Signing Procedure.</p>
<p id="en-us_topic_0218811272__p6633105985310">Modified the title from PLAS to PLAS APIs in <a href="en-us_topic_0218811264.html">PLAS APIs</a>.</p>
</td>
</tr>
<tr id="en-us_topic_0218811272__row21204638"><td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0218811272__p39854147">2019-01-04</p>
</td>
<td class="cellrowborder" valign="top" width="74.75%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0218811272__p6960497">This release incorporates the following changes:</p>
<p id="en-us_topic_0218811272__p62644474">Modified the range of name in <a href="en-us_topic_0218811265.html">Creating a PLAS Connector</a>.</p>
</td>
</tr>
<tr id="en-us_topic_0218811272__row41037639"><td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0218811272__p35714481">2018-09-06</p>
</td>
<td class="cellrowborder" valign="top" width="74.75%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0218811272__p7191839">This release incorporates the following changes:</p>
<p id="en-us_topic_0218811272__p64726555">Modified the range of name in <a href="en-us_topic_0218811265.html">Creating a PLAS Connector</a>.</p>
</td>
</tr>
<tr id="en-us_topic_0218811272__row8359627"><td class="cellrowborder" valign="top" width="25.25%" headers="mcps1.3.1.1.3.1.1 "><p id="en-us_topic_0218811272__p6041204">2018-03-29</p>
</td>
<td class="cellrowborder" valign="top" width="74.75%" headers="mcps1.3.1.1.3.1.2 "><p id="en-us_topic_0218811272__p19575485">This issue is the first official release.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 836 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 834 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 68 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 983 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 962 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 879 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 3.1 KiB