DDS API 20221101 version
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com> Co-authored-by: Wang , Deng Ke <wangdengke2@huawei.com> Co-committed-by: Wang , Deng Ke <wangdengke2@huawei.com>
1
doc-exports
Submodule
@ -0,0 +1 @@
|
|||||||
|
Subproject commit 118a109795f9193fc0bab68fb222736a4d17142f
|
242
docs/dds/api-ref/ALL_META.TXT.json
Normal file
218
docs/dds/api-ref/CLASS.TXT.json
Normal file
3
docs/dds/api-ref/PARAMETERS.txt
Normal file
@ -0,0 +1,3 @@
|
|||||||
|
version=""
|
||||||
|
language="en-us"
|
||||||
|
type=""
|
37
docs/dds/api-ref/dds_api_0006.html
Normal file
@ -0,0 +1,37 @@
|
|||||||
|
<a name="dds_api_0006"></a><a name="dds_api_0006"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">API Overview</h1>
|
||||||
|
<div id="body1526376998678"><p id="dds_api_0006__p8060118">DDS provides extension APIs, allowing you to perform specific operations using APIs.</p>
|
||||||
|
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0006__table1577981717153" frame="border" border="1" rules="all"><caption><b>Table 1 </b>API description</caption><thead align="left"><tr id="dds_api_0006__row16810121712155"><th align="left" class="cellrowborder" valign="top" width="27%" id="mcps1.3.2.2.3.1.1"><p id="dds_api_0006__p13834717131516"><strong id="dds_api_0006__b842352706201211">Type</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="73%" id="mcps1.3.2.2.3.1.2"><p id="dds_api_0006__p3883151714159"><strong id="dds_api_0006__b12191203712285">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_api_0006__row1949285720717"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p1349320571278">API Version Queries</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><ul id="dds_api_0006__ul920143612915"><li id="dds_api_0006__li220103612913">Query all API versions.</li><li id="dds_api_0006__li1220103642918">Query a specified API version.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_0006__row10180132720818"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p101802271083">Database Version Information Queries</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p4401153416307">Obtain database version information about a specified instance type.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_0006__row1193412428326"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p16935124219321">All DB Instance Specifications Queries</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p11850755183110">Query all DB instance specifications in a specified region.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_0006__row1980621151411"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p16894236114218">DB Instance Management</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p1037352711388">Manage DB instances, including creating, deleting, and querying DB instances.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div></div>
|
||||||
|
|
12
docs/dds/api-ref/dds_api_0007.html
Normal file
@ -0,0 +1,12 @@
|
|||||||
|
<a name="dds_api_0007"></a><a name="dds_api_0007"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Environment Preparations</h1>
|
||||||
|
<div id="body1526376873787"><p id="dds_api_0007__p8060118"></p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0010.html">Token Authentication</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
70
docs/dds/api-ref/dds_api_0010.html
Normal file
@ -0,0 +1,70 @@
|
|||||||
|
<a name="dds_api_0010"></a><a name="dds_api_0010"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Token Authentication</h1>
|
||||||
|
<div id="body1562038443100"><div class="section" id="dds_api_0010__en-us_topic_0110967262_section50237402"><h4 class="sectiontitle">Application Scenarios</h4><p class="MsoNormal" id="dds_api_0010__en-us_topic_0110967262_p27738717">If you use a token for authentication, you must obtain the user's token and add <strong id="dds_api_0010__b842352706134841">X-Auth-Token</strong> to the request message header of the service API when making an API call.</p>
|
||||||
|
<p class="MsoNormal" id="dds_api_0010__en-us_topic_0110967262_p48321862">This section describes how to make an API call for token authentication.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_api_0010__en-us_topic_0110967262_section49483440"><h4 class="sectiontitle">Invoking an API</h4><ol id="dds_api_0010__en-us_topic_0110967262_ol02801474297"><li id="dds_api_0010__en-us_topic_0110967262_li14280177102918"><a name="dds_api_0010__en-us_topic_0110967262_li14280177102918"></a><a name="en-us_topic_0110967262_li14280177102918"></a><span>Obtain the following information:</span><p><ol type="a" id="dds_api_0010__en-us_topic_0110967262_ol5389726173113"><li id="dds_api_0010__en-us_topic_0110967262_li93891526133111">To obtain the IAM endpoint and region name in the message body, see <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>.</li><li id="dds_api_0010__en-us_topic_0110967262_li16899152173219">To obtain the project ID, see <a href="dds_projectid.html">Obtaining a Project ID</a>.</li></ol>
|
||||||
|
</p></li><li id="dds_api_0010__en-us_topic_0110967262_li109381224173013"><a name="dds_api_0010__en-us_topic_0110967262_li109381224173013"></a><a name="en-us_topic_0110967262_li109381224173013"></a><span>Send a POST https://<em id="dds_api_0010__i79544341571">IAM</em><em id="dds_api_0010__i129551348570">_Endpoint</em>/v3/auth/tokens request to obtain the user token.</span><p>
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0010__en-us_topic_0110967262_table18389930" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Header description</caption><thead align="left"><tr id="dds_api_0010__en-us_topic_0110967262_row24749807"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.2.1.2.5.1.1"><p id="dds_api_0010__en-us_topic_0110967262_p58577354"><strong id="dds_api_0010__b842352706102328">Name</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="28.98%" id="mcps1.3.2.2.2.2.1.2.5.1.2"><p id="dds_api_0010__en-us_topic_0110967262_p47145209"><strong id="dds_api_0010__b84235270611143">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="21.02%" id="mcps1.3.2.2.2.2.1.2.5.1.3"><p id="dds_api_0010__en-us_topic_0110967262_p60665573"><strong id="dds_api_0010__b842352706102346">Mandatory</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.2.2.1.2.5.1.4"><p id="dds_api_0010__en-us_topic_0110967262_p14964341"><strong id="dds_api_0010__b842352706103845">Example</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_api_0010__en-us_topic_0110967262_row4152081"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.1.2.5.1.1 "><p id="dds_api_0010__en-us_topic_0110967262_p774306">Content-Type</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="28.98%" headers="mcps1.3.2.2.2.2.1.2.5.1.2 "><p id="dds_api_0010__en-us_topic_0110967262_p62718864">Specifies the MIME type of the request body.</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="21.02%" headers="mcps1.3.2.2.2.2.1.2.5.1.3 "><p id="dds_api_0010__en-us_topic_0110967262_p47063234">Yes</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.2.2.1.2.5.1.4 "><p id="dds_api_0010__en-us_topic_0110967262_p54025633">application/json</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
<div class="p" id="dds_api_0010__en-us_topic_0110967262_p5008546913818">An example request message is as follows:<pre class="codeblock" id="dds_api_0010__en-us_topic_0110967262_codeblock38470664113529">{
|
||||||
|
"auth": {
|
||||||
|
"identity": {
|
||||||
|
"methods": [
|
||||||
|
"password"
|
||||||
|
],
|
||||||
|
"password": {
|
||||||
|
"user": {
|
||||||
|
"name": "<em id="dds_api_0010__en-us_topic_0110967262_i1322869015296">username</em>",
|
||||||
|
"password": "<em id="dds_api_0010__en-us_topic_0110967262_i15294466152910">password</em>",
|
||||||
|
"domain": {
|
||||||
|
"name": "<em id="dds_api_0010__en-us_topic_0110967262_i65968558152916">domainname</em>"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"scope": {
|
||||||
|
"project": {
|
||||||
|
"id": "<em id="dds_api_0010__en-us_topic_0110967262_i1597017249262">project_id</em>"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}</pre>
|
||||||
|
</div>
|
||||||
|
<p id="dds_api_0010__en-us_topic_0110967262_p66017215522">In the preceding command, replace parameter in italic with the actual values. For details, see the "Obtaining a User Token" section in the <em id="dds_api_0010__i946718476572">Identity and Access Management API Reference</em>.</p>
|
||||||
|
<ol type="a" id="dds_api_0010__en-us_topic_0110967262_ol175844414443"><li id="dds_api_0010__en-us_topic_0110967262_li67598449449"><strong id="dds_api_0010__b1786123819588"><em id="dds_api_0010__i178573811588">IAM</em><em id="dds_api_0010__i185838205815">_Endpoint</em></strong>: Replace it with the IAM endpoint obtained in <a href="#dds_api_0010__en-us_topic_0110967262_li14280177102918">1</a>.</li><li id="dds_api_0010__en-us_topic_0110967262_li475915446448"><strong id="dds_api_0010__b135069585586"><em id="dds_api_0010__i8505758185811">username</em></strong> and <strong id="dds_api_0010__b135077584589"><em id="dds_api_0010__i15071586583">password</em></strong>: Replace them respectively with the username and password of the IAM server.</li><li id="dds_api_0010__en-us_topic_0110967262_li1975924414448"><strong id="dds_api_0010__b05190415590"><em id="dds_api_0010__i10517134175910">project_id</em></strong>: Replace it with the project ID obtained in <a href="#dds_api_0010__en-us_topic_0110967262_li14280177102918">1</a>.</li></ol>
|
||||||
|
<p id="dds_api_0010__en-us_topic_0110967262_p1495941365018">After the request is processed, the value of <strong id="dds_api_0010__b349720294597">X-Subject-Token</strong> in the header is the token value.</p>
|
||||||
|
<pre class="screen" id="dds_api_0010__en-us_topic_0110967262_screen1094517139545"><strong id="dds_api_0010__en-us_topic_0110967262_b694961335414">X-Subject-Token</strong>:MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...</pre>
|
||||||
|
</p></li><li id="dds_api_0010__en-us_topic_0110967262_li72803712916"><span>Run the following command to set the token as an environment variable for subsequent operations:</span><p><p id="dds_api_0010__en-us_topic_0110967262_p156940011577"><strong id="dds_api_0010__en-us_topic_0110967262_b138391246125815">export Token=<em id="dds_api_0010__en-us_topic_0110967262_i483954615817">{</em></strong><em id="dds_api_0010__en-us_topic_0110967262_i68411461584">X-Subject-Token</em><strong id="dds_api_0010__en-us_topic_0110967262_b583916465588"><em id="dds_api_0010__en-us_topic_0110967262_i38391446195813">}</em></strong></p>
|
||||||
|
<p id="dds_api_0010__en-us_topic_0110967262_p146941401579"><strong id="dds_api_0010__b12263124204"><em id="dds_api_0010__i126320241205">X-Subject-Token</em></strong>: Replace it with the token obtained in <a href="#dds_api_0010__en-us_topic_0110967262_li109381224173013">2</a>. An example command is as follows:</p>
|
||||||
|
<p id="dds_api_0010__en-us_topic_0110967262_p1269418014572"><strong id="dds_api_0010__en-us_topic_0110967262_b748349195912">export Token=MIIDkgYJKoZIhvcNAQcCoIIDgzCCA38CAQExDTALBglghkgBZQMEAgEwgXXXXX...</strong></p>
|
||||||
|
</p></li></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_0007.html">Environment Preparations</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
15
docs/dds/api-ref/dds_api_0014.html
Normal file
@ -0,0 +1,15 @@
|
|||||||
|
<a name="dds_api_0014"></a><a name="dds_api_0014"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">API Calling</h1>
|
||||||
|
<div id="body5253358"></div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0015.html">Scenarios</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0016.html">REST APIs</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0017.html">Example</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
22
docs/dds/api-ref/dds_api_0015.html
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
<a name="dds_api_0015"></a><a name="dds_api_0015"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Scenarios</h1>
|
||||||
|
<div id="body526619"><p id="dds_api_0015__p58493292">DDS open APIs allow users to create, view, or delete DB instances, query API versions, DB engines, DB engine versions, and DB instance class supported by the system. The application scenarios are shown as follows.</p>
|
||||||
|
<div class="fignone" id="dds_api_0015__fig16598276309"><span class="figcap"><b>Figure 1 </b>Scenarios</span><br><span><img id="dds_api_0015__image3660102714309" src="en-us_image_0208249507.png" title="Click to enlarge" class="imgResize"></span></div>
|
||||||
|
<p id="dds_api_0015__p27481582">Before creating a DB instance, you need to obtain the DB engines and versions, DB instance class, and AZs supported by the system.</p>
|
||||||
|
<p id="dds_api_0015__p46007650">After obtaining the information, you can use the returned results as invoked parameters to create a DB instance.</p>
|
||||||
|
<p id="dds_api_0015__p11415673">After a DB instance is created, you can query the instance list and delete the instance.</p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_0014.html">API Calling</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script language="JavaScript">
|
||||||
|
<!--
|
||||||
|
image_size('.imgResize');
|
||||||
|
var msg_imageMax = "view original image";
|
||||||
|
var msg_imageClose = "close";
|
||||||
|
//--></script>
|
171
docs/dds/api-ref/dds_api_0016.html
Normal file
108
docs/dds/api-ref/dds_api_0017.html
Normal file
142
docs/dds/api-ref/dds_api_0018.html
Normal file
139
docs/dds/api-ref/dds_api_0019.html
Normal file
614
docs/dds/api-ref/dds_api_0020.html
Normal file
74
docs/dds/api-ref/dds_api_0022.html
Normal file
@ -0,0 +1,74 @@
|
|||||||
|
<a name="dds_api_0022"></a><a name="dds_api_0022"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Deleting a DB Instance</h1>
|
||||||
|
<div id="body33650236"><div class="section" id="dds_api_0022__section29874939"><h4 class="sectiontitle">Function</h4><p id="dds_api_0022__p41314614">This API is used to delete a DB instance.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_api_0022__section439002"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0022__ul58149428"><li id="dds_api_0022__li53582808">URI format<p id="dds_api_0022__p5623154481817"><a name="dds_api_0022__li53582808"></a><a name="li53582808"></a>DELETE /v3/{project_id}/instances/{instance_id}</p>
|
||||||
|
</li><li id="dds_api_0022__li45240216">Parameter description
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0022__table4508766" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0022__row21306406"><th align="left" class="cellrowborder" valign="top" width="22.05%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0022__p48097351"><strong id="dds_api_0022__b842352706102328_1">Name</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="28.07%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0022__p3571397"><strong id="dds_api_0022__b842352706102346_1">Mandatory</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="49.88%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_api_0022__p2775334615440"><strong id="dds_api_0022__b1211711271793">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_api_0022__row10946294"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0022__p14234617">project_id</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0022__p12153337">Yes</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0022__p19338596163746">Specifies the project ID of a tenant in a region.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_0022__row1412808"><td class="cellrowborder" valign="top" width="22.05%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0022__p47328638">instance_id</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="28.07%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0022__p8414476">Yes</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="49.88%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_api_0022__p10483995">Specifies the DB instance ID.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_api_0022__section3951024"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0022__ul1945810274247"><li id="dds_api_0022__li7458152782410">Request header<pre class="codeblock" id="dds_api_0022__codeblock1497683019423"><strong id="dds_api_0022__b8340285321">DELETE </strong><strong id="dds_api_0022__b1034158193212"><em id="dds_api_0022__i173403813328">https://</em></strong><strong id="dds_api_0022__b834216818322"><em id="dds_api_0022__i13341682322">DDS endpoint</em></strong><strong id="dds_api_0022__b103421784328">/v3/{</strong><strong id="dds_api_0022__b334417893219"><em id="dds_api_0022__i1634217819328">project_id</em></strong><strong id="dds_api_0022__b1534417814323">}/instances/{</strong><strong id="dds_api_0022__b6345178173214"><em id="dds_api_0022__i434516812323">instance_id</em></strong><strong id="dds_api_0022__b634615810321">}</strong></pre>
|
||||||
|
</li><li id="dds_api_0022__li83029323246">Request body<p id="dds_api_0022__p615889515440"><a name="dds_api_0022__li83029323246"></a><a name="li83029323246"></a>N/A</p>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_api_0022__section35559222"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0022__ul12573920"><li id="dds_api_0022__li46056421">Parameter description
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0022__table29807226151454" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0022__row3223123151454"><th align="left" class="cellrowborder" valign="top" width="24.122412241224122%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0022__p59746450151454"><strong id="dds_api_0022__b842352706102328_5">Name</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="42.544254425442546%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0022__p7624314151454"><strong id="dds_api_0022__b842352706164541_1">Type</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0022__p125849352116"><strong id="dds_api_0022__b83503302093">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_api_0022__row19231203392012"><td class="cellrowborder" valign="top" width="24.122412241224122%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0022__p417012163212">job_id</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="42.544254425442546%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0022__p317018169216">String</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0022__p1017071652111">Indicates the workflow ID.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li></ul>
|
||||||
|
<ul id="dds_api_0022__ul16665627"><li id="dds_api_0022__li15772917">Response example<pre class="codeblock" id="dds_api_0022__codeblock5367796021390">{
|
||||||
|
"job_id": "252f11f1-2912-4c06-be55-1999bde659c5"
|
||||||
|
}</pre>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_api_0022__section5382712154838"><h4 class="sectiontitle"><strong id="dds_api_0022__dds_api_0018_b5215121503">Status Code</strong></h4><p id="dds_api_0022__dds_api_0018_p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_api_0022__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0022__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_instance_mgmt.html">DB Instance Management</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
774
docs/dds/api-ref/dds_api_0023.html
Normal file
18
docs/dds/api-ref/dds_api_description.html
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<a name="dds_api_description"></a><a name="dds_api_description"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">API Description</h1>
|
||||||
|
<div id="body1526376873788"><p id="dds_api_description__p8060118"></p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_version.html">Querying the API Version</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_database_version.html">Querying Database Version Information</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_instance_specification.html">Querying All DB Instance Specifications</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_instance_mgmt.html">DB Instance Management</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
41
docs/dds/api-ref/dds_api_reference.html
Normal file
@ -0,0 +1,41 @@
|
|||||||
|
<a name="dds_api_reference"></a><a name="dds_api_reference"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Before You Start</h1>
|
||||||
|
<div id="body1526376873787"><p id="dds_api_reference__p139661137153019">This document describes application programming interfaces (APIs), syntax, parameters, and examples of Document Database Service (DDS). You can search for information you need according to <a href="#dds_api_reference__table333417544226">Table 1</a>.</p>
|
||||||
|
|
||||||
|
<div class="tablenoborder"><a name="dds_api_reference__table333417544226"></a><a name="table333417544226"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_reference__table333417544226" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Documentation guide</caption><thead align="left"><tr id="dds_api_reference__row23340540222"><th align="left" class="cellrowborder" valign="top" width="46%" id="mcps1.3.2.2.3.1.1"><p id="dds_api_reference__p12334254192218">Section</p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="54%" id="mcps1.3.2.2.3.1.2"><p id="dds_api_reference__p933495422216">Description</p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_api_reference__row1269420575278"><td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_reference__p117835254219"><a href="dds_api_0006.html">API Overview</a></p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_reference__p1795965355714">DDS API components and API list</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_reference__row526714144284"><td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_reference__p050915474218"><a href="dds_api_0007.html">Environment Preparations</a></p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_reference__p996655414214">Preparations before using the APIs, including obtaining the request authentication and project ID</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_reference__row233411546227"><td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_reference__p0399556133"><a href="dds_api_0014.html">API Calling</a></p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_reference__p94513313418">Representational State Transfer (REST) message bodies, calling methods, and examples</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_reference__row233485492216"><td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_reference__p11458571840"><a href="dds_api_description.html">API Description</a></p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_reference__p82911310357">DDS APIs, including APIs used for querying information about API version, database version, and DB instance specifications, and managing DB instances.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_api_reference__row3753171113615"><td class="cellrowborder" valign="top" width="46%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_reference__p15755915368"><a href="dds_public_parameters.html">Appendix</a></p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="54%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_reference__p5198548975">Understand the status codes and error codes about DDS APIs.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
18
docs/dds/api-ref/dds_api_version.html
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<a name="dds_api_version"></a><a name="dds_api_version"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Querying the API Version</h1>
|
||||||
|
<div id="body1492599633511"><p id="dds_api_version__p8060118"></p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0018.html">Querying the API Version List</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0019.html">Querying API Version Information</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_description.html">API Description</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
38
docs/dds/api-ref/dds_change_history.html
Normal file
@ -0,0 +1,38 @@
|
|||||||
|
<a name="dds_change_history"></a><a name="dds_change_history"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Change History</h1>
|
||||||
|
<div id="body1547460102810">
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_change_history__table920164513614" frame="border" border="1" rules="all"><thead align="left"><tr id="dds_change_history__row020224513363"><th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.1.1.3.1.1"><p id="dds_change_history__p7202245133614">Date</p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.1.1.3.1.2"><p id="dds_change_history__p6202045183613"><strong id="dds_change_history__b338011315102">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_change_history__row8678044103911"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p206783442391">2020-10-15</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p367964453911">Modified the following content:</p>
|
||||||
|
<ul id="dds_change_history__ul135651018164013"><li id="dds_change_history__li16565151884019">Modified the description of the <strong id="dds_change_history__b14042715011">ram</strong> parameter in <a href="dds_instance_specification.html">Querying All DB Instance Specifications</a>.</li><li id="dds_change_history__li1626154716406">Modified the description of the <strong id="dds_change_history__b2016199899">disk_encryption_id</strong> parameter in <a href="dds_api_0023.html">Querying DB Instances</a>.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_change_history__row15463154910459"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p310095519452">2019-11-07</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p1546454912456">Modified the following content:</p>
|
||||||
|
<ul id="dds_change_history__ul1130631113376"><li id="dds_change_history__li183063116372">Modified the value of <strong id="dds_change_history__b18172177105913">versions</strong> in the response example in <a href="dds_database_version.html">Querying Database Version Information</a>.</li><li id="dds_change_history__li67031530123918">Modified the description of the <strong id="dds_change_history__b775375234">num</strong> parameter in <a href="dds_api_0020.html">Creating a DB Instance</a>.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_change_history__row14928143110263"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p13737193912261">2019-09-25</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p1247965216265">Modified the following content:</p>
|
||||||
|
<ul id="dds_change_history__ul1616124343311"><li id="dds_change_history__li1616194353319">Change the value of <strong id="dds_change_history__b67892014486">spec_code</strong> in the request and response examples in <a href="dds_api_0017.html">Example</a>, <a href="dds_instance_specification.html">Querying All DB Instance Specifications</a>, <a href="dds_api_0020.html">Creating a DB Instance</a>, and <a href="dds_api_0023.html">Querying DB Instances</a>.</li></ul>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_change_history__row122022045153611"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p9202174513617">2019-08-19</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p1320234518365">This issue is the first official release.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
77
docs/dds/api-ref/dds_database_version.html
Normal file
@ -0,0 +1,77 @@
|
|||||||
|
<a name="dds_database_version"></a><a name="dds_database_version"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Querying Database Version Information</h1>
|
||||||
|
<div id="body63384014"><div class="section" id="dds_database_version__section61759636"><h4 class="sectiontitle">Function</h4><p id="dds_database_version__p33831530">This API is used to obtain database version information about a specified type of a DB instance.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_database_version__section18965813"><h4 class="sectiontitle">URI</h4><ul id="dds_database_version__ul55999443"><li id="dds_database_version__li34232944">URI format<p id="dds_database_version__p48498610154457"><a name="dds_database_version__li34232944"></a><a name="li34232944"></a>GET /v3/{project_id}/datastores/{datastore_name}/versions</p>
|
||||||
|
</li><li id="dds_database_version__li21405046">Parameter description
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_database_version__table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_database_version__row1482002"><th align="left" class="cellrowborder" valign="top" width="21.87%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_database_version__p52933326"><strong id="dds_database_version__b842352706102328_1">Name</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="27.689999999999998%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_database_version__p59740974"><strong id="dds_database_version__b842352706102346_1">Mandatory</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="50.44%" id="mcps1.3.2.2.2.1.2.4.1.3"><p id="dds_database_version__p7180698"><strong id="dds_database_version__b18901131134212">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_database_version__row44765691"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_database_version__p2142393">project_id</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="27.689999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_database_version__p39316155">Yes</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_database_version__p1434580163733">Specifies the project ID of a tenant in a region.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
<tr id="dds_database_version__row5992637"><td class="cellrowborder" valign="top" width="21.87%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_database_version__p15641626">datastore_name</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="27.689999999999998%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_database_version__p59012183">Yes</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="50.44%" headers="mcps1.3.2.2.2.1.2.4.1.3 "><p id="dds_database_version__p5562520192718">Specifies the database type. DDS Community Edition is supported. The value is <strong id="dds_database_version__b42993511538">DDS-Community</strong>.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_database_version__section36474591"><h4 class="sectiontitle">Requests</h4><ul id="dds_database_version__ul1945810274247"><li id="dds_database_version__li7458152782410">Request header<pre class="codeblock" id="dds_database_version__codeblock1497683019423">GET <em id="dds_database_version__i61527451247">https://</em><em id="dds_database_version__i399814306423">DDS endpoint</em>/v3/{project_id}/datastores/{datastore_name}/versions</pre>
|
||||||
|
</li><li id="dds_database_version__li83029323246">Request body<p id="dds_database_version__p615889515440"><a name="dds_database_version__li83029323246"></a><a name="li83029323246"></a>N/A</p>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_database_version__section59835867"><h4 class="sectiontitle">Responses</h4><ul id="dds_database_version__ul66273227"><li id="dds_database_version__li59588135">Parameter description
|
||||||
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_database_version__table66531170" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_database_version__row12984378"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_database_version__p45101667"><strong id="dds_database_version__b842352706102328_5">Name</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_database_version__p29356372"><strong id="dds_database_version__b842352706164541_3">Type</strong></p>
|
||||||
|
</th>
|
||||||
|
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_database_version__p29055926"><strong id="dds_database_version__b37981314144218">Description</strong></p>
|
||||||
|
</th>
|
||||||
|
</tr>
|
||||||
|
</thead>
|
||||||
|
<tbody><tr id="dds_database_version__row5801050"><td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_database_version__p123050">versions</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_database_version__p1299616431919">Array of strings</p>
|
||||||
|
</td>
|
||||||
|
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_database_version__p13154152618495">Indicates the database version. Currently, versions 3.2 and 3.4 are supported.</p>
|
||||||
|
</td>
|
||||||
|
</tr>
|
||||||
|
</tbody>
|
||||||
|
</table>
|
||||||
|
</div>
|
||||||
|
</li></ul>
|
||||||
|
<ul id="dds_database_version__ul26818564"><li id="dds_database_version__li611614444319">Response example<pre class="codeblock" id="dds_database_version__codeblock121161444033">{
|
||||||
|
"versions": [
|
||||||
|
"3.2",
|
||||||
|
"3.4"
|
||||||
|
]
|
||||||
|
}</pre>
|
||||||
|
</li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_database_version__section5382712154838"><h4 class="sectiontitle"><strong id="dds_database_version__dds_api_0018_b5215121503">Status Code</strong></h4><p id="dds_database_version__dds_api_0018_p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_database_version__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_database_version__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_description.html">API Description</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
1086
docs/dds/api-ref/dds_error_code.html
Normal file
19
docs/dds/api-ref/dds_instance_mgmt.html
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
<a name="dds_instance_mgmt"></a><a name="dds_instance_mgmt"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">DB Instance Management</h1>
|
||||||
|
<div id="body1492599633511"></div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0020.html">Creating a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0022.html">Deleting a DB Instance</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_api_0023.html">Querying DB Instances</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_description.html">API Description</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
339
docs/dds/api-ref/dds_instance_specification.html
Normal file
798
docs/dds/api-ref/dds_metrics.html
Normal file
50
docs/dds/api-ref/dds_projectid.html
Normal file
@ -0,0 +1,50 @@
|
|||||||
|
<a name="dds_projectid"></a><a name="dds_projectid"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Obtaining a Project ID</h1>
|
||||||
|
<div id="body8662426"><div class="section" id="dds_projectid__section136545262478"><h4 class="sectiontitle">Scenarios</h4><p id="dds_projectid__p1556115614615">A project ID is required for some URLs when an API is called. Therefore, you need to obtain a project ID in advance. Two methods are available:</p>
|
||||||
|
<ul id="dds_projectid__ul7963113144712"><li id="dds_projectid__li3757103814464"><a href="#dds_projectid__section18520151052413">Obtaining the Project ID by Calling an API</a></li><li id="dds_projectid__li1296373184719"><a href="#dds_projectid__section127010198244">Obtain a Project ID from the Console</a></li></ul>
|
||||||
|
</div>
|
||||||
|
<div class="section" id="dds_projectid__section18520151052413"><a name="dds_projectid__section18520151052413"></a><a name="section18520151052413"></a><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="dds_projectid__en-us_topic_0111868863_p857314915139">The API used to obtain a project ID is <strong id="dds_projectid__b312654014207">GET https://{Endpoint}/v3/projects</strong>. <strong id="dds_projectid__b20126340182020">{Endpoint}</strong> 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="dds_api_0010.html">Token Authentication</a>.</p>
|
||||||
|
<p id="dds_projectid__en-us_topic_0111868863_p3770181514218">The following is an example response. The value of <strong id="dds_projectid__b126652044182110">id</strong> is the project ID.</p>
|
||||||
|
<pre class="screen" id="dds_projectid__en-us_topic_0111868863_screen676419149446">{
|
||||||
|
"projects": [
|
||||||
|
{
|
||||||
|
"domain_id": "65382450e8f64ac0870cd180d14e684b",
|
||||||
|
"is_domain": false,
|
||||||
|
"parent_id": "65382450e8f64ac0870cd180d14e684b",
|
||||||
|
"name": "project_name",
|
||||||
|
"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 class="section" id="dds_projectid__section127010198244"><a name="dds_projectid__section127010198244"></a><a name="section127010198244"></a><h4 class="sectiontitle">Obtain a Project ID from the Console</h4><ol id="dds_projectid__ol117026301421"><li id="dds_projectid__li147028301824">Register yourself on the management console and log in to it.</li><li id="dds_projectid__li3996134016711">Move your pointer over the username and select <strong id="dds_projectid__b1585528376">My Credential</strong> in the displayed drop-down list.<p id="dds_projectid__p168811428710">On the <strong id="dds_projectid__b1059816482039">My Credential</strong> page, view the project ID in the project list.</p>
|
||||||
|
<div class="fignone" id="dds_projectid__en-us_topic_0111868863_fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="dds_projectid__en-us_topic_0111868863_image538470016132" src="en-us_image_0208249570.jpg" title="Click to enlarge" class="imgResize"></span></div>
|
||||||
|
</li></ol>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<div class="familylinks">
|
||||||
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_public_parameters.html">Appendix</a></div>
|
||||||
|
</div>
|
||||||
|
</div>
|
||||||
|
|
||||||
|
|
||||||
|
<script language="JavaScript">
|
||||||
|
<!--
|
||||||
|
image_size('.imgResize');
|
||||||
|
var msg_imageMax = "view original image";
|
||||||
|
var msg_imageClose = "close";
|
||||||
|
//--></script>
|
18
docs/dds/api-ref/dds_public_parameters.html
Normal file
@ -0,0 +1,18 @@
|
|||||||
|
<a name="dds_public_parameters"></a><a name="dds_public_parameters"></a>
|
||||||
|
|
||||||
|
<h1 class="topictitle1">Appendix</h1>
|
||||||
|
<div id="body1526437910310"><p id="dds_public_parameters__p8060118"></p>
|
||||||
|
</div>
|
||||||
|
<div>
|
||||||
|
<ul class="ullinks">
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_status_code.html">Status Code</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_error_code.html">Error Code</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_projectid.html">Obtaining a Project ID</a></strong><br>
|
||||||
|
</li>
|
||||||
|
<li class="ulchildlink"><strong><a href="dds_metrics.html">DDS Metrics</a></strong><br>
|
||||||
|
</li>
|
||||||
|
</ul>
|
||||||
|
</div>
|
||||||
|
|
140
docs/dds/api-ref/dds_status_code.html
Normal file
BIN
docs/dds/api-ref/en-us_image_0208249507.png
Normal file
After Width: | Height: | Size: 11 KiB |
BIN
docs/dds/api-ref/en-us_image_0208249570.jpg
Normal file
After Width: | Height: | Size: 110 KiB |
1
docs/dds/api-ref/public_sys-resources/ExpandCollapse.js
Normal file
@ -0,0 +1 @@
|
|||||||
|
var expandClassName="dropdownexpand";var collapseClassName="dropdowncollapse";var collapseTableClassName="dropdowncollapsetable";var href="";function ExpandorCollapseNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseClassName}else{a.className=expandClassName}}function ExpandorCollapseTableNode(a){a=a.parentNode;if(a.className==expandClassName){a.className=collapseTableClassName}else{a.className=expandClassName}}function ExpandorCollapseAllNodes(g,h,c){var a=g.getAttribute("title");var b=g.parentNode;if(a=="collapse"){g.setAttribute("title","expand");g.className="dropdownAllButtonexpand";g.innerHTML=h}else{g.setAttribute("title","collapse");g.className="dropdownAllButtoncollapse";g.innerHTML=c}var f=b.getElementsByTagName("*");for(var d=0;d<f.length;d++){var e=f[d];if(e.className.indexOf(expandClassName)!=-1||e.className.indexOf(collapseClassName)!=-1||e.className.indexOf(collapseTableClassName)!=-1){if(a=="collapse"){if(e.tagName.toLowerCase()=="table"){e.className=collapseTableClassName}else{e.className=collapseClassName}}else{e.className=expandClassName}}}}function ExpandForHref(f){if(null==f||"#"==f||"###"==f){return}var a=null;try{a=document.getElementById(f)}catch(d){}if(null==a||a.length==0){return}try{var b=a.parentNode;while(b!=null&&b.tagName!="body"){if(b.className==collapseClassName){b.className=expandClassName}b=b.parentNode}}catch(c){}}window.onload=function(){var b=document.getElementsByTagName("div");for(var c=0;c<b.length;c++){var j=b[c];if(j.className.indexOf(expandClassName)!=-1){j.className=collapseClassName}}var d=document.getElementsByTagName("a");try{for(var c=0;c<d.length;c++){var f=d[c];var h=f.getAttribute("href");if(h!=""&&h!=null){href=h;f.onclick=show}}}catch(g){}};function show(){try{if(href!=null&&href!="#"&&href.lastIndexOf("#")>-1){ExpandForHref(href.substring(href.lastIndexOf("#")+1))}}catch(a){}};
|
BIN
docs/dds/api-ref/public_sys-resources/caution_3.0-en-us.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
1
docs/dds/api-ref/public_sys-resources/commonltr.css
Normal file
1
docs/dds/api-ref/public_sys-resources/commonrtl.css
Normal file
@ -0,0 +1 @@
|
|||||||
|
.msgph{font-family:Courier New;}.unresolved{background-color:skyblue;}.noTemplate{background-color:yellow;}.base{background-color:#ffffff;}.nested0{margin-top:1em;}.p{margin-top:1em;}.figcap{font-style:italic;}.figdesc{font-style:normal;}.figborder{border-style:solid;padding-left:3px;border-width:2px;padding-right:3px;margin-top:1em;border-color:Silver;}.figsides{border-left:2px solid;padding-left:3px;border-right:2px solid;padding-right:3px;margin-top:1em;border-color:Silver;}.figtop{border-top:2px solid;margin-top:1em;border-color:Silver;}.figbottom{border-bottom:2px solid;border-color:Silver;}.figtopbot{border-top:2px solid;border-bottom:2px solid;margin-top:1em;border-color:Silver;}.ullinks{list-style-type:none;}.ulchildlink{margin-top:1em;margin-bottom:1em;}.olchildlink{margin-top:1em;margin-bottom:1em;}.linklist{margin-top:1em;margin-bottom:1em;}.linklistwithchild{margin-top:1em;margin-right:1.5em;margin-bottom:1em;}.sublinklist{margin-top:1em;margin-right:1.5em;margin-bottom:1em;}.relconcepts{margin-top:1em;margin-bottom:1em;}.reltasks{margin-top:1em;margin-bottom:1em;}.relref{margin-top:1em;margin-bottom:1em;}.relinfo{margin-top:1em;margin-bottom:1em;}.breadcrumb{font-size:smaller;margin-bottom:1em;}.prereq{margin-right:20px;}.topictitle1{margin-top:0;margin-bottom:.1em;font-size:1.34em;}.topictitle2{margin-top:1pc;margin-bottom:.45em;font-size:1.17em;}.topictitle3{margin-top:1pc;margin-bottom:.17em;font-size:1.17em;font-weight:bold;}.topictitle4{margin-top:.83em;font-size:1.17em;font-weight:bold;}.topictitle5{font-size:1.17em;font-weight:bold;}.topictitle6{font-size:1.17em;font-style:italic;}.sectiontitle{margin-top:1em;margin-bottom:0;color:black;font-size:1.17em;font-weight:bold;}.section{margin-top:1em;margin-bottom:1em;}.example{margin-top:1em;margin-bottom:1em;}.note{margin-top:1em;margin-bottom:1em;}.notetitle{font-weight:bold;}.notelisttitle{font-weight:bold;}.tip{margin-top:1em;margin-bottom:1em;}.tiptitle{font-weight:bold;}.fastpath{margin-top:1em;margin-bottom:1em;}.fastpathtitle{font-weight:bold;}.important{margin-top:1em;margin-bottom:1em;}.importanttitle{font-weight:bold;}.remember{margin-top:1em;margin-bottom:1em;}.remembertitle{font-weight:bold;}.restriction{margin-top:1em;margin-bottom:1em;}.restrictiontitle{font-weight:bold;}.attention{margin-top:1em;margin-bottom:1em;}.attentiontitle{font-weight:bold;}.dangertitle{font-weight:bold;}.danger{margin-top:1em;margin-bottom:1em;}.warningtitle{font-weight:bold;}.warning{margin-top:1em;margin-bottom:1em;}.noticetitle{font-weight:bold;}.notice{margin-top:1em;margin-bottom:1em;}.cautiontitle{font-weight:bold;}.caution{font-weight:bold;margin-bottom:1em;}ul.simple{list-style-type:none;}.firstcol{font-weight:bold;}.bold{font-weight:bold;}.boldItalic{font-weight:bold;font-style:italic;}.italic{font-style:italic;}.underlined{text-decoration:underline;}.uicontrol{font-weight:bold;}.parmname{font-weight:bold;}.var{font-style:italic;}.shortcut{text-decoration:underline;}.dlterm{font-weight:bold;}.dltermexpand{font-weight:bold;margin-top:1em;}*[compact="yes"]>li{margin-top:0;}*[compact="no"]>li{margin-top:.53em;}.liexpand{margin-top:1em;margin-bottom:1em;}.sliexpand{margin-top:1em;margin-bottom:1em;}.dlexpand{margin-top:1em;margin-bottom:1em;}.ddexpand{margin-top:1em;margin-bottom:1em;}.stepexpand{margin-top:1em;margin-bottom:1em;}.substepexpand{margin-top:1em;margin-bottom:1em;}div.imageleft{text-align:left;}div.imagecenter{text-align:center;}div.imageright{text-align:right;}div.imagejustify{text-align:justify;}.cellrowborder{border-right:none;border-top:none;border-left:solid 1px;border-bottom:solid 1px;}.row-nocellborder{border-left:none;border-right:none;border-top:none;border-left:hidden;border-bottom:solid 1px;}.cell-norowborder{border-top:none;border-bottom:none;border-right:none;border-bottom:hidden;border-left:solid 1px;}.nocellnorowborder{border:none;border-left:hidden;border-bottom:hidden;}pre.screen{padding:5px 5px 5px 5px;border:outset;background-color:#CCCCCC;margin-top:2px;margin-bottom:2px;white-space:pre;}pre.codeblock{padding:5px 5px 5px 5px;border:outset;background-color:#CCCCCC;margin-top:2px;margin-bottom:2px;white-space:pre;}
|
BIN
docs/dds/api-ref/public_sys-resources/danger_3.0-en-us.png
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/dds/api-ref/public_sys-resources/delta.gif
Normal file
After Width: | Height: | Size: 58 B |
BIN
docs/dds/api-ref/public_sys-resources/deltaend.gif
Normal file
After Width: | Height: | Size: 56 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-arrowdn.gif
Normal file
After Width: | Height: | Size: 68 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-arrowrt.gif
Normal file
After Width: | Height: | Size: 70 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-caution.gif
Normal file
After Width: | Height: | Size: 580 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-danger.gif
Normal file
After Width: | Height: | Size: 580 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-huawei.gif
Normal file
After Width: | Height: | Size: 2.7 KiB |
BIN
docs/dds/api-ref/public_sys-resources/icon-note.gif
Normal file
After Width: | Height: | Size: 394 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-notice.gif
Normal file
After Width: | Height: | Size: 1.0 KiB |
BIN
docs/dds/api-ref/public_sys-resources/icon-tip.gif
Normal file
After Width: | Height: | Size: 253 B |
BIN
docs/dds/api-ref/public_sys-resources/icon-warning.gif
Normal file
After Width: | Height: | Size: 580 B |
1
docs/dds/api-ref/public_sys-resources/imageResize.js
Normal file
@ -0,0 +1 @@
|
|||||||
|
function image_size(a){$$$(window).load(function(){$$$(a).each(function(){var e=$$$(this);var f=e.width();var d=e.height();var b=f;var c=d;e.click(function(){tb_show("",this.src,false)})})})};
|