forked from docs/doc-exports
dds api 2.0.38sp24 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>
This commit is contained in:
parent
05f2df2618
commit
60010eb9d0
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -3,30 +3,60 @@
|
||||
<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>
|
||||
<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">Type</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 align="left" class="cellrowborder" valign="top" width="73%" id="mcps1.3.2.2.3.1.2"><p id="dds_api_0006__p3883151714159">Description</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>
|
||||
<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">Querying the API Version</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>
|
||||
<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">Querying Database Version Information</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>
|
||||
<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">Querying All DB Instance Specifications</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>
|
||||
<tr id="dds_api_0006__row1368131341512"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p1424503591310">Querying the Database Disk Type</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 class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p1624543521319">Query the database disk type in the current 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">Managing DB Instances</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p178077117141">Create, restart, delete, and query instances, scale up storage, add instance nodes, change instance specifications, switch over primary and standby nodes, enable or disable SSL, change instance names, change database ports, change security groups, and bind or unbind an EIP, change the private network address of an instance, enable the shard/config IP addresses, configure cross-CIDR access, query regions and AZs to which an instance can be migrated.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0006__row410885118281"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p910835118280">Managing Connections</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p310925119283">Query instance node sessions, terminate instance node sessions, and query the number of instance node connections.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0006__row8182410133414"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p171821310123420">Backing up and Restoring an Instance</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p4182131033413">Create manual backups, delete manual backups, query backups, query the automated backup policy, set the automated backup policy, restore to a new DB instance, obtain the backup download link, query the restoration time range, obtain the list of databases that can be restored, obtain the list of database collections that can be restored, obtain the current DB instance, and restore a database or table to a specified point in time.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0006__row12930850143020"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p29301950123012">Obtaining Log Information</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p3930350193013">Query database slow logs, obtain the download link of slow logs, query database error logs, obtain the download link of error logs, set audit log policies, query audit log policies, obtain the audit logs, and obtain the download link of audit logs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0006__row544775318142"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p3448175321416">Managing Tags</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p44481353111413">Manage tags, including querying resources by tag, adding and deleting a tag or tags, and querying resource tags and project tags.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0006__row1848624320"><td class="cellrowborder" valign="top" width="27%" headers="mcps1.3.2.2.3.1.1 "><p id="dds_api_0006__p9848228327">Managing Databases and Accounts</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="73%" headers="mcps1.3.2.2.3.1.2 "><p id="dds_api_0006__p118485212326">Create a database user, create a database role, query database users and roles, change the database user password, , query the cluster balancing settings, enable or disable cluster balancing, and set the activity time window of cluster balancing, delete database users, delete database roles, and check the database password.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
|
@ -1,11 +1,10 @@
|
||||
<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 id="body1526376873787"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0010.html">Token Authentication</a></strong><br>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0010.html">Authentication</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
@ -1,34 +1,14 @@
|
||||
<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>
|
||||
<h1 class="topictitle1">Authentication</h1>
|
||||
<div id="body1562038443100"><p id="dds_api_0010__p451113923113">DDS supports token authentication.</p>
|
||||
<div class="section" id="dds_api_0010__section4838419162616"><h4 class="sectiontitle">Token Authentication</h4><div class="note" id="dds_api_0010__note16278457204513"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0010__p1627913575453">The validity period of a token is 24 hours. If a token needs to be used, the system caches the token to avoid frequent calling.</p>
|
||||
</div></div>
|
||||
</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">{
|
||||
<p id="dds_api_0010__p135791862430">A token specifies temporary permissions in a computer system. During API authentication using a token, the token is added to requests to get permissions for calling the API.</p>
|
||||
<p id="dds_api_0010__p194994815456">If you use a token for authentication, you must obtain the user's token and add <strong id="dds_api_0010__b978812211018">X-Auth-Token</strong> to the request message header of the service API when making an API call.</p>
|
||||
<p id="dds_api_0010__p99321747541">When <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">calling an API to obtain a user token</a>, you must set <strong id="dds_api_0010__b1488222411119">auth.scope</strong> in the request body to <strong id="dds_api_0010__b198838241111">project</strong>.</p>
|
||||
<pre class="codeblock" id="dds_api_0010__codeblock188472032105011">{
|
||||
"auth": {
|
||||
"identity": {
|
||||
"methods": [
|
||||
@ -36,31 +16,25 @@
|
||||
],
|
||||
"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>",
|
||||
"name": "<em id="dds_api_0010__i2084773213504">username</em>",
|
||||
"password": "<em id="dds_api_0010__i1784813216505">password</em>",
|
||||
"domain": {
|
||||
"name": "<em id="dds_api_0010__en-us_topic_0110967262_i65968558152916">domainname</em>"
|
||||
"name": "<em id="dds_api_0010__i10848103214503">domainname</em>"
|
||||
}
|
||||
}
|
||||
}
|
||||
},
|
||||
"scope": {
|
||||
"project": {
|
||||
"id": "<em id="dds_api_0010__en-us_topic_0110967262_i1597017249262">project_id</em>"
|
||||
"name": "xxxxxxxx"
|
||||
}
|
||||
}
|
||||
}
|
||||
}</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>
|
||||
<p id="dds_api_0010__p14474111714512">After a token is obtained, add the <strong id="dds_api_0010__b1783819304914">X-Auth-Token</strong> header field must be added to requests to specify the token when calling other APIs. For example, if the token is <strong id="dds_api_0010__b75452331098">ABCDEFJ....</strong>, add <strong id="dds_api_0010__b105451331916">X-Auth-Token: ABCDEFJ....</strong> in a request as follows:</p>
|
||||
<pre class="screen" id="dds_api_0010__screen178605610011">POST https://dds.eu-de.otc.t-systems.com/v3/auth/projects
|
||||
Content-Type: application/json
|
||||
<strong id="dds_api_0010__b1887196203">X-Auth-Token: ABCDEFJ....</strong></pre>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
|
@ -2,7 +2,7 @@
|
||||
|
||||
<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>
|
||||
<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_0000001336985362.png"></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>
|
||||
@ -13,10 +13,3 @@
|
||||
</div>
|
||||
</div>
|
||||
|
||||
|
||||
<script language="JavaScript">
|
||||
<!--
|
||||
image_size('.imgResize');
|
||||
var msg_imageMax = "view original image";
|
||||
var msg_imageClose = "close";
|
||||
//--></script>
|
@ -121,7 +121,7 @@
|
||||
</div>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0016__en-us_topic_0113746487_section1437471411"><h4 class="sectiontitle">(Optional) Request Body</h4><p id="dds_api_0016__en-us_topic_0113746487_p76011911717">A request body is generally sent in a structured format (for example, JSON or XML), corresponding to <strong id="dds_api_0016__b589791263516">Content-Type</strong> in the request header, and is used to transfer content other than the request header.</p>
|
||||
<p id="dds_api_0016__en-us_topic_0113746487_p07341123474">If the request body contains Chinese characters, convert the Chinese characters into the UTF-8 encoding format.</p>
|
||||
<p id="dds_api_0016__en-us_topic_0113746487_p07341123474">If the request body contains full-width characters, convert the full-width characters into the UTF-8 encoding format.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0016__en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Headers</h4><p id="dds_api_0016__en-us_topic_0113746487_p1368914492710">A response header consists of the following two parts:</p>
|
||||
<ul id="dds_api_0016__en-us_topic_0113746487_ul7241441888"><li id="dds_api_0016__en-us_topic_0113746487_li72484989">An HTTP status code, which is a service-defined status code indicating a success or an error</li><li id="dds_api_0016__li12411149132412">Additional fields, for example <strong id="dds_api_0016__b842352706142714">Content-Type</strong><div class="p" id="dds_api_0016__p1747493716311"><a href="#dds_api_0016__en-us_topic_0113746487_en-us_topic_0020536997_table3877208613139">Table 4</a> lists common response header fields.
|
||||
|
@ -7,14 +7,14 @@
|
||||
<div class="section" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_section872994"><h4 class="sectiontitle">Involved APIs</h4><p class="litext" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_p23385131">If you use a token for authentication, you must obtain the user's token and add <strong id="dds_api_0017__dds_api_0013_b151471630441">X-Auth-Token</strong> to the request message header of the service API when making an API call.</p>
|
||||
<ul id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_ul15147458"><li id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li2109397">API for obtaining tokens from IAM</li><li id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li18984577">Creating a DDS DB instance using an open API</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_section7856948"><h4 class="sectiontitle">Procedure</h4><ol id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_ol61355793"><li id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li1837051910476">Obtain the token by following instructions in section <a href="dds_api_0010.html">Token Authentication</a>.</li><li class="msonormal" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li8863205171315">Send <strong id="dds_api_0017__dds_api_0013_b842352706111943">POST https://<em id="dds_api_0017__dds_api_0013_i757506785111944">DDS</em><em id="dds_api_0017__dds_api_0013_i1171559010111944"> endpoint</em>/v3/{<em id="dds_api_0017__dds_api_0013_i842352697111953">project_id</em>}/instances</strong>.</li><li class="msonormal" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li108635517130">Add <strong id="dds_api_0017__dds_api_0013_b380022418518">X-Auth-Token</strong> to the request header.</li><li class="msonormal" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li1586314581311">Specify the following parameters in the request body:<div class="note" id="dds_api_0017__dds_api_0013_note997910579171"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0017__dds_api_0013_p13980105715175">The values of <strong id="dds_api_0017__dds_api_0013_b1694932402910">region</strong> and <strong id="dds_api_0017__dds_api_0013_b4949152413299">availability_zone</strong> are used as examples.</p>
|
||||
<div class="section" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_section7856948"><h4 class="sectiontitle">Procedure</h4><ol id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_ol61355793"><li id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li1837051910476">Obtain the token by following instructions in section <a href="dds_api_0010.html">Authentication</a>.</li><li class="msonormal" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li8863205171315">Send <strong id="dds_api_0017__dds_api_0013_b842352706111943">POST https://<em id="dds_api_0017__dds_api_0013_i757506785111944">DDS</em><em id="dds_api_0017__dds_api_0013_i1171559010111944"> endpoint</em>/v3/{<em id="dds_api_0017__dds_api_0013_i842352697111953">project_id</em>}/instances</strong>.</li><li class="msonormal" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li108635517130">Add <strong id="dds_api_0017__dds_api_0013_b380022418518">X-Auth-Token</strong> to the request header.</li><li class="msonormal" id="dds_api_0017__dds_api_0013_en-us_topic_0121682346_li1586314581311">Specify the following parameters in the request body:<div class="note" id="dds_api_0017__dds_api_0013_note997910579171"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0017__dds_api_0013_p13980105715175">The values of <strong id="dds_api_0017__dds_api_0013_b1694932402910">region</strong> and <strong id="dds_api_0017__dds_api_0013_b4949152413299">availability_zone</strong> are used as examples.</p>
|
||||
<p id="dds_api_0017__dds_api_0013_p16641171680">For details about the API used for creating DB instances, see <a href="dds_api_0020.html">Creating a DB Instance</a>.</p>
|
||||
</div></div>
|
||||
<pre class="codeblock" id="dds_api_0017__dds_api_0013_codeblock1044891812017">{
|
||||
"name": "test-cluster", //DB instance name
|
||||
"datastore": {
|
||||
"type": "DDS-Community", // Database type and version
|
||||
"version": "3.4", //Database version
|
||||
"version": "4.0", //Database version
|
||||
"storage_engine": "wiredTiger" //Storage engine
|
||||
},
|
||||
"region": "aaa", //Region name
|
||||
@ -22,7 +22,7 @@
|
||||
"vpc_id": "674e9b42-cd8d-4d25-a2e6-5abcc565b961", //VPC ID
|
||||
"subnet_id": "f1df08c5-71d1-406a-aff0-de435a51007b", //Subnet ID
|
||||
"security_group_id": "7aa51dbf-5b63-40db-9724-dad3c4828b58", //Security group ID
|
||||
"password": "Test@123", //Administrator password
|
||||
"password": "******", //Administrator password
|
||||
"disk_encryption_id": "d4825f1b-5e47-4ff7-8ca9-0960da1770b1", //Key ID for encrypting disks
|
||||
"mode": "Sharding", //Sharded-cluster instance type
|
||||
"flavor": [
|
||||
@ -47,7 +47,7 @@
|
||||
}
|
||||
],
|
||||
"backup_strategy": {
|
||||
"start_time": "08:15-09:15", //Backup time window
|
||||
"start_time": "23:00-00:00", //Backup period
|
||||
"keep_days": "8" //Retention days of backup files
|
||||
},
|
||||
"ssl_option":"1"
|
||||
@ -58,7 +58,7 @@
|
||||
"name": "test-cluster",
|
||||
"datastore": {
|
||||
"type": "DDS-Community",
|
||||
"version": "3.4",
|
||||
"version": "4.0",
|
||||
"storage_engine": "wiredTiger"
|
||||
},
|
||||
"created": "2019-01-14 08:50:27",
|
||||
@ -90,9 +90,10 @@
|
||||
}
|
||||
],
|
||||
"backup_strategy": {
|
||||
"start_time": "08:15-09:15",
|
||||
"start_time": "23:00-00:00",
|
||||
"keep_days": "8"
|
||||
},
|
||||
"enterprise_project_id": "",
|
||||
"ssl_option":"1",
|
||||
"job_id": "c0c606b6-470a-48c7-97a2-6c7f146014d4"
|
||||
}</pre>
|
||||
|
@ -3,20 +3,18 @@
|
||||
<h1 class="topictitle1">Querying the API Version List</h1>
|
||||
<div id="body42915540"><div class="section" id="dds_api_0018__section9793815440"><h4 class="sectiontitle">Function</h4><p id="dds_api_0018__p793298915440">This API is used to query the currently supported API version list.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0018__section428804115440"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0018__ul1178707715440"><li id="dds_api_0018__li3897482915440">URI format<p id="dds_api_0018__p563217921019"><a name="dds_api_0018__li3897482915440"></a><a name="li3897482915440"></a>GET /</p>
|
||||
<div class="section" id="dds_api_0018__section428804115440"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0018__ul1178707715440"><li id="dds_api_0018__li3897482915440">URI format<p id="dds_api_0018__p1165414212274"><a name="dds_api_0018__li3897482915440"></a><a name="li3897482915440"></a>GET https://{Endpoint}/</p>
|
||||
</li><li id="dds_api_0018__li2560149615440">Parameter description<p id="dds_api_0018__p2908688015440"><a name="dds_api_0018__li2560149615440"></a><a name="li2560149615440"></a>N/A</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0018__section2907369315440"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0018__ul1945810274247"><li id="dds_api_0018__li7458152782410">Request header<pre class="codeblock" id="dds_api_0018__codeblock1497683019423">GET <em id="dds_api_0018__i78642362517">https://</em><em id="dds_api_0018__i399814306423">DDS endpoint</em>/</pre>
|
||||
</li><li id="dds_api_0018__li83029323246">Request body<p id="dds_api_0018__p615889515440"><a name="dds_api_0018__li83029323246"></a><a name="li83029323246"></a>N/A</p>
|
||||
</li></ul>
|
||||
<div class="section" id="dds_api_0018__section2907369315440"><h4 class="sectiontitle">Requests</h4><p id="dds_api_0018__p32410269289">None</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0018__section5543006115440"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0018__ul6064993315440"><li id="dds_api_0018__li897849015440">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table3575976715440" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0018__row5028223115440"><th align="left" class="cellrowborder" valign="top" width="26.26262626262626%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0018__p4632888215440"><strong id="dds_api_0018__b842352706102328_3">Name</strong></p>
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table3575976715440" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0018__row5028223115440"><th align="left" class="cellrowborder" valign="top" width="26.26262626262626%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0018__p4632888215440">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="40.40404040404041%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0018__p6165196615440"><strong id="dds_api_0018__b842352706164541_1">Type</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="40.40404040404041%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0018__p6165196615440">Type</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_0018__p2775334615440"><strong id="dds_api_0018__b12381182592918">Description</strong></p>
|
||||
<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_0018__p2775334615440">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@ -31,11 +29,11 @@
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><a name="dds_api_0018__table37479565104653"></a><a name="table37479565104653"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table37479565104653" frame="border" border="1" rules="all"><caption><b>Table 2 </b>versions field data structure description</caption><thead align="left"><tr id="dds_api_0018__row65790814104653"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0018__p27455703104653"><strong id="dds_api_0018__b842352706102328_5">Name</strong></p>
|
||||
<div class="tablenoborder"><a name="dds_api_0018__table37479565104653"></a><a name="table37479565104653"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table37479565104653" frame="border" border="1" rules="all"><caption><b>Table 2 </b>versions field data structure description</caption><thead align="left"><tr id="dds_api_0018__row65790814104653"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0018__p27455703104653">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="40.23%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0018__p9319469104653"><strong id="dds_api_0018__b842352706164541_3">Type</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="40.23%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0018__p9319469104653">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.239999999999995%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0018__p1143415283591"><strong id="dds_api_0018__b1453553216296">Description</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.239999999999995%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0018__p1143415283591">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@ -60,6 +58,7 @@
|
||||
<td class="cellrowborder" valign="top" width="40.23%" headers="mcps1.3.4.2.1.2.2.4.1.2 "><p id="dds_api_0018__p51773656104653">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="33.239999999999995%" headers="mcps1.3.4.2.1.2.2.4.1.3 "><p id="dds_api_0018__p32916607104653">Indicates the version status.</p>
|
||||
<p id="dds_api_0018__p15858184432115">The value CURRENT indicates that the version has been released.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0018__row1648012414408"><td class="cellrowborder" valign="top" width="26.529999999999998%" headers="mcps1.3.4.2.1.2.2.4.1.1 "><p id="dds_api_0018__p154811524144020">version</p>
|
||||
@ -89,11 +88,11 @@
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<div class="tablenoborder"><a name="dds_api_0018__table630875915440"></a><a name="table630875915440"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table630875915440" frame="border" border="1" rules="all"><caption><b>Table 3 </b>links field data structure description</caption><thead align="left"><tr id="dds_api_0018__row4191288815440"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0018__p3950073415440"><strong id="dds_api_0018__b842352706102328_7">Name</strong></p>
|
||||
<div class="tablenoborder"><a name="dds_api_0018__table630875915440"></a><a name="table630875915440"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0018__table630875915440" frame="border" border="1" rules="all"><caption><b>Table 3 </b>links field data structure description</caption><thead align="left"><tr id="dds_api_0018__row4191288815440"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0018__p3950073415440">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0018__p4544288515440"><strong id="dds_api_0018__b842352706164541_5">Type</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0018__p4544288515440">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0018__p2056123485910"><strong id="dds_api_0018__b7237133832914">Description</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0018__p2056123485910">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@ -129,7 +128,8 @@
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0018__section17992204432820"><h4 class="sectiontitle"><strong id="dds_api_0018__b5215121503">Status Code</strong></h4><p id="dds_api_0018__p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
<div class="section" id="dds_api_0018__section17992204432820"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0018__p16131712193312">Status Code:200.</p>
|
||||
<p id="dds_api_0018__p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0018__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0018__p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
||||
</div>
|
||||
|
@ -3,19 +3,19 @@
|
||||
<h1 class="topictitle1">Querying API Version Information</h1>
|
||||
<div id="body13251620"><div class="section" id="dds_api_0019__section50404481154838"><h4 class="sectiontitle">Function</h4><p id="dds_api_0019__p56231143154838">This API is used to query the specified API version.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0019__section36318247154838"><h4 class="sectiontitle">URI</h4><p id="dds_api_0019__p4260943171618">URI format</p>
|
||||
<p id="dds_api_0019__p137351645111410">GET /v3</p>
|
||||
<div class="section" id="dds_api_0019__section36318247154838"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0019__ul173666483286"><li id="dds_api_0019__li43668481287">URI format<p id="dds_api_0019__p10145134631815"><a name="dds_api_0019__li43668481287"></a><a name="li43668481287"></a>GET https://{Endpoint}/{version}</p>
|
||||
</li><li id="dds_api_0019__li771939193611">Parameter description<p id="dds_api_0019__p652175093617"><a name="dds_api_0019__li771939193611"></a><a name="li771939193611"></a>N/A</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0019__section47398739154838"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0019__ul1945810274247"><li id="dds_api_0019__li7458152782410">Request header<pre class="codeblock" id="dds_api_0019__codeblock1497683019423">GET <em id="dds_api_0019__i1746620112114">https://</em><em id="dds_api_0019__i20467611141115">DDS endpoint</em>/v3</pre>
|
||||
</li><li id="dds_api_0019__li83029323246">Request body<p id="dds_api_0019__p615889515440"><a name="dds_api_0019__li83029323246"></a><a name="li83029323246"></a>N/A</p>
|
||||
<div class="section" id="dds_api_0019__section47398739154838"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0019__ul6575065367"><li id="dds_api_0019__li15575186183612">Example request<p id="dds_api_0019__p98119923617"><a name="dds_api_0019__li15575186183612"></a><a name="li15575186183612"></a>GET https://dds.eu-de.otc.t-systems.com/v3</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0019__section59724852154838"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0019__ul18241230105616"><li id="dds_api_0019__li28551847105616">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0019__table62971306105515" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0019__row21185732105515"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0019__p19221610105536"><strong id="dds_api_0019__b842352706102328_3">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_api_0019__p13446610105536"><strong id="dds_api_0019__b842352706164541_1">Type</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0019__p13446610105536">Type</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_0019__p2775334615440"><strong id="dds_api_0019__b561212380301">Description</strong></p>
|
||||
<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_0019__p2775334615440">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@ -32,9 +32,9 @@
|
||||
|
||||
<div class="tablenoborder"><a name="dds_api_0019__table57914909154838"></a><a name="table57914909154838"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0019__table57914909154838" frame="border" border="1" rules="all"><caption><b>Table 2 </b><strong id="dds_api_0019__b835152931112">version</strong> field data structure description</caption><thead align="left"><tr id="dds_api_0019__row17905664154838"><th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.1"><p id="dds_api_0019__p41072674154838"><strong id="dds_api_0019__b842352706102328_5">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0019__p38552284154838"><strong id="dds_api_0019__b842352706164541_3">Type</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.2"><p id="dds_api_0019__p38552284154838">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0019__p35727319154838"><strong id="dds_api_0019__b190914406302">Description</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.33333333333333%" id="mcps1.3.4.2.1.2.2.4.1.3"><p id="dds_api_0019__p35727319154838">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@ -90,9 +90,9 @@
|
||||
|
||||
<div class="tablenoborder"><a name="dds_api_0019__table630875915440"></a><a name="table630875915440"></a><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0019__table630875915440" frame="border" border="1" rules="all"><caption><b>Table 3 </b>links field data structure description</caption><thead align="left"><tr id="dds_api_0019__row4191288815440"><th align="left" class="cellrowborder" valign="top" width="26.529999999999998%" id="mcps1.3.4.2.1.3.2.4.1.1"><p id="dds_api_0019__p3950073415440"><strong id="dds_api_0019__b842352706102328_7">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0019__p4544288515440"><strong id="dds_api_0019__b842352706164541_5">Type</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="39.800000000000004%" id="mcps1.3.4.2.1.3.2.4.1.2"><p id="dds_api_0019__p4544288515440">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0019__p5699506015440"><strong id="dds_api_0019__b1054218448304">Description</strong></p>
|
||||
<th align="left" class="cellrowborder" valign="top" width="33.67%" id="mcps1.3.4.2.1.3.2.4.1.3"><p id="dds_api_0019__p5699506015440">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
@ -126,7 +126,8 @@
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0019__section5382712154838"><h4 class="sectiontitle"><strong id="dds_api_0019__dds_api_0018_b5215121503">Status Code</strong></h4><p id="dds_api_0019__dds_api_0018_p1351064932715">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
<div class="section" id="dds_api_0019__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0019__dds_api_0018_p16131712193312">Status Code:200.</p>
|
||||
<p id="dds_api_0019__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0019__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0019__dds_api_0018_p20466124120334">For more information, see <a href="dds_error_code.html">Error Code</a>.</p>
|
||||
</div>
|
||||
|
File diff suppressed because it is too large
Load Diff
132
docs/dds/api-ref/dds_api_0021.html
Normal file
132
docs/dds/api-ref/dds_api_0021.html
Normal file
File diff suppressed because it is too large
Load Diff
@ -3,7 +3,7 @@
|
||||
<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>
|
||||
<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 https://{Endpoint}/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>
|
||||
@ -24,7 +24,7 @@
|
||||
</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 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 instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
@ -32,24 +32,23 @@
|
||||
</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>
|
||||
<div class="section" id="dds_api_0022__section3951024"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0022__ul5554183045516"><li id="dds_api_0022__li9555630105515">Example request<p id="dds_api_0022__p1894193595515"><a name="dds_api_0022__li9555630105515"></a><a name="li9555630105515"></a>DELETE https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02</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>
|
||||
<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%" 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 align="left" class="cellrowborder" valign="top" width="28.000000000000004%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0022__p7624314151454">Type</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 align="left" class="cellrowborder" valign="top" width="48%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0022__p125849352116">Description</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>
|
||||
<tbody><tr id="dds_api_0022__row19231203392012"><td class="cellrowborder" valign="top" width="24%" 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 class="cellrowborder" valign="top" width="28.000000000000004%" 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 class="cellrowborder" valign="top" width="48%" 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>
|
||||
@ -61,7 +60,8 @@
|
||||
}</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 class="section" id="dds_api_0022__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0022__dds_api_0018_p16131712193312">Status Code:202.</p>
|
||||
<p id="dds_api_0022__dds_api_0018_p480617135329">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>
|
||||
|
File diff suppressed because one or more lines are too long
153
docs/dds/api-ref/dds_api_0024.html
Normal file
153
docs/dds/api-ref/dds_api_0024.html
Normal file
File diff suppressed because it is too large
Load Diff
168
docs/dds/api-ref/dds_api_0025.html
Normal file
168
docs/dds/api-ref/dds_api_0025.html
Normal file
File diff suppressed because it is too large
Load Diff
176
docs/dds/api-ref/dds_api_0026.html
Normal file
176
docs/dds/api-ref/dds_api_0026.html
Normal file
File diff suppressed because it is too large
Load Diff
151
docs/dds/api-ref/dds_api_0027.html
Normal file
151
docs/dds/api-ref/dds_api_0027.html
Normal file
File diff suppressed because it is too large
Load Diff
73
docs/dds/api-ref/dds_api_0028.html
Normal file
73
docs/dds/api-ref/dds_api_0028.html
Normal file
@ -0,0 +1,73 @@
|
||||
<a name="dds_api_0028"></a><a name="dds_api_0028"></a>
|
||||
|
||||
<h1 class="topictitle1">Deleting a Manual Backup</h1>
|
||||
<div id="body1473065857659"><div class="section" id="dds_api_0028__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0028__p3631239417316">This API is used to delete a manual backup for a DB instance.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0028__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0028__ul3084351717316"><li id="dds_api_0028__li915620217316">URI format<p id="dds_api_0028__p18851726122217"><a name="dds_api_0028__li915620217316"></a><a name="li915620217316"></a>DELETE https://{Endpoint}/v3/{project_id}/backups/{backup_id}</p>
|
||||
</li><li id="dds_api_0028__li21405046">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0028__table58427690" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0028__row1482002"><th align="left" class="cellrowborder" valign="top" width="21.11%" id="mcps1.3.2.2.2.1.2.4.1.1"><p id="dds_api_0028__p52933326"><strong id="dds_api_0028__b842352706102328">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="29.01%" id="mcps1.3.2.2.2.1.2.4.1.2"><p id="dds_api_0028__p59740974"><strong id="dds_api_0028__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_0028__p2775334615440"><strong id="dds_api_0028__b11640143336">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0028__row44765691"><td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0028__p16936114315232">project_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="29.01%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0028__p39316155">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_0028__p6304653416317">Specifies the project ID of a tenant in a region.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0028__row17239382154651"><td class="cellrowborder" valign="top" width="21.11%" headers="mcps1.3.2.2.2.1.2.4.1.1 "><p id="dds_api_0028__p79360430235">backup_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="29.01%" headers="mcps1.3.2.2.2.1.2.4.1.2 "><p id="dds_api_0028__p18151956154651">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_0028__p61022371154651">Specifies the backup file ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0028__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0028__ul10449192285220"><li id="dds_api_0028__li124491224522">Example request<p id="dds_api_0028__p16253923123317"><a name="dds_api_0028__li124491224522"></a><a name="li124491224522"></a>DELETE https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/backups/8d9586c40b33449a815518d4635a2cd9br02</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0028__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0028__ul2426746268"><li id="dds_api_0028__li742515418268">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0028__table10726201414263" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0028__row872761492615"><th align="left" class="cellrowborder" valign="top" width="27.82278227822782%" id="mcps1.3.4.2.1.1.2.4.1.1"><p id="dds_api_0028__p169441823112614"><strong id="dds_api_0028__b93511294914">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="30.453045304530452%" id="mcps1.3.4.2.1.1.2.4.1.2"><p id="dds_api_0028__p1194402322616"><strong id="dds_api_0028__b17331410990">Type</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="41.724172417241725%" id="mcps1.3.4.2.1.1.2.4.1.3"><p id="dds_api_0028__p428712619410"><strong id="dds_api_0028__b1994011610334">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0028__row15727191417260"><td class="cellrowborder" valign="top" width="27.82278227822782%" headers="mcps1.3.4.2.1.1.2.4.1.1 "><p id="dds_api_0028__p17944123132610">job_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="30.453045304530452%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_api_0028__p19444230265">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="41.724172417241725%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_api_0028__p1694422322610">Indicates the task ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li><li id="dds_api_0028__li174261248264">Response example<pre class="codeblock" id="dds_api_0028__codeblock9361104902612">{
|
||||
"job_id": "fcaab90b-960d-4441-b73d-a5b2532c5ec5"
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0028__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0028__dds_api_0018_p16131712193312">Status Code:200.</p>
|
||||
<p id="dds_api_0028__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0028__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0028__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_backup_restore.html">Backup and Restoration</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
275
docs/dds/api-ref/dds_api_0029.html
Normal file
275
docs/dds/api-ref/dds_api_0029.html
Normal file
File diff suppressed because it is too large
Load Diff
117
docs/dds/api-ref/dds_api_0030.html
Normal file
117
docs/dds/api-ref/dds_api_0030.html
Normal file
File diff suppressed because it is too large
Load Diff
135
docs/dds/api-ref/dds_api_0031.html
Normal file
135
docs/dds/api-ref/dds_api_0031.html
Normal file
File diff suppressed because it is too large
Load Diff
339
docs/dds/api-ref/dds_api_0032.html
Normal file
339
docs/dds/api-ref/dds_api_0032.html
Normal file
File diff suppressed because it is too large
Load Diff
155
docs/dds/api-ref/dds_api_0033.html
Normal file
155
docs/dds/api-ref/dds_api_0033.html
Normal file
File diff suppressed because it is too large
Load Diff
123
docs/dds/api-ref/dds_api_0034.html
Normal file
123
docs/dds/api-ref/dds_api_0034.html
Normal file
File diff suppressed because it is too large
Load Diff
120
docs/dds/api-ref/dds_api_0035.html
Normal file
120
docs/dds/api-ref/dds_api_0035.html
Normal file
File diff suppressed because it is too large
Load Diff
20
docs/dds/api-ref/dds_api_0036.html
Normal file
20
docs/dds/api-ref/dds_api_0036.html
Normal file
@ -0,0 +1,20 @@
|
||||
<a name="dds_api_0036"></a><a name="dds_api_0036"></a>
|
||||
|
||||
<h1 class="topictitle1">Introduction</h1>
|
||||
<div id="body1558080355123"><p id="dds_api_0036__p181391527116">This chapter describes fine-grained permissions management for your DDS. If your account does not need individual IAM users, then you may skip over this chapter.</p>
|
||||
<p id="dds_api_0036__p18888114825410">By default, new IAM users do not have permissions assigned. You need to add a user to one or more groups, and attach permissions policies or roles to these groups. Users inherit permissions from the groups to which they are added and can perform specified operations on cloud services based on the permissions.</p>
|
||||
<p id="dds_api_0036__p15783137165511">You can grant users permissions by using roles and policies. Roles are a type of coarse-grained authorization mechanism that defines permissions related to user responsibilities. Policies define API-based permissions for operations on specific resources under certain conditions, allowing for more fine-grained, secure access control of cloud resources.</p>
|
||||
<div class="note" id="dds_api_0036__note201832201114"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dds_api_0036__p49962523718">Policy-based authorization is useful if you want to allow or deny the access to an API.</p>
|
||||
</div></div>
|
||||
<p id="dds_api_0036__p814114217110">An account has all of the permissions required to call all APIs, but IAM users must have the required permissions specifically assigned. The permissions required for calling an API are determined by the actions supported by the API. Only users that have been granted permissions allowing the actions can call the API successfully. For example, if an IAM user queries DDS DB instances using an API, the user must have been granted permissions that allow the <strong id="dds_api_0036__b198947229386">dds:instance:list</strong> action.</p>
|
||||
<div class="section" id="dds_api_0036__section8976121171117"><h4 class="sectiontitle">Supported Actions</h4><p id="dds_api_0036__p1968220235719">DDS provides system-defined policies that can be directly used in IAM. You can also create custom policies and use them to supplement system-defined policies, implementing more refined access control. Operations supported by policies are specific to APIs. The following are common concepts related to policies:</p>
|
||||
<ul id="dds_api_0036__ul714117211113"><li id="dds_api_0036__li714116251114">Permission: A statement in a policy that allows or denies certain operations.</li><li id="dds_api_0036__li914112216115">APIs: REST APIs that can be called in a custom policy.</li><li id="dds_api_0036__li5141112131120">Actions: Added to a custom policy to control permissions for specific operations.</li><li id="dds_api_0036__li314118251115">IAM projects or enterprise projects: Type of projects in which policies can be used to grant permissions. A policy can be applied to IAM projects, enterprise projects, or both. Policies that contain actions supporting both IAM and enterprise projects can be assigned to user groups and take effect in both IAM and Enterprise Management. Policies that only contain actions supporting IAM projects can be assigned to user groups and only take effect for IAM. Such policies will not take effect if they are assigned to user groups in Enterprise Management. </li></ul>
|
||||
<p id="dds_api_0036__p10141224112">For details about the custom actions supported by DDS, see <a href="dds_api_0037.html">DDS Actions</a>.</p>
|
||||
</div>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_permission.html">Permissions Policies and Supported Actions</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
668
docs/dds/api-ref/dds_api_0037.html
Normal file
668
docs/dds/api-ref/dds_api_0037.html
Normal file
File diff suppressed because it is too large
Load Diff
839
docs/dds/api-ref/dds_api_0038.html
Normal file
839
docs/dds/api-ref/dds_api_0038.html
Normal file
File diff suppressed because it is too large
Load Diff
174
docs/dds/api-ref/dds_api_0039.html
Normal file
174
docs/dds/api-ref/dds_api_0039.html
Normal file
File diff suppressed because it is too large
Load Diff
76
docs/dds/api-ref/dds_api_0050.html
Normal file
76
docs/dds/api-ref/dds_api_0050.html
Normal file
@ -0,0 +1,76 @@
|
||||
<a name="dds_api_0050"></a><a name="dds_api_0050"></a>
|
||||
|
||||
<h1 class="topictitle1">Performing a Primary/Secondary Switchover in a Replica Set Instance</h1>
|
||||
<div id="body1508227694255"><div class="section" id="dds_api_0050__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0050__p12728183093920">This API is used to perform a primary/secondary switchover in a replica set instance.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0050__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0050__ul082311820560"><li id="dds_api_0050__li1982521814564">This API supports only DDS replica sets.</li><li id="dds_api_0050__li1594964614393">This operation cannot be performed on frozen or abnormal instances.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0050__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0050__ul3084351717316"><li id="dds_api_0050__li915620217316">URI format<p id="dds_api_0050__p912862005412"><a name="dds_api_0050__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/switchover</p>
|
||||
</li><li id="dds_api_0050__li15430535">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0050__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0050__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0050__p34889605"><strong id="dds_api_0050__b84235270691445_1">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0050__p7485743"><strong id="dds_api_0050__b4562168172511">Mandatory</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0050__p2775334615440"><strong id="dds_api_0050__b1193810973518">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0050__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0050__p13784132454018">project_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0050__p22717550">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0050__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0050__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0050__p157845249405">instance_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0050__p10737742155220">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0050__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0050__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0050__ul39241291555"><li id="dds_api_0050__li2092418295517">Example request<p id="dds_api_0050__p13726732356"><a name="dds_api_0050__li2092418295517"></a><a name="li2092418295517"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/switchover</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0050__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0050__ul12573920"><li id="dds_api_0050__li46056421">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0050__table32267243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0050__row9230088"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0050__p9439626"><strong id="dds_api_0050__b986813198327">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0050__p26412257"><strong id="dds_api_0050__b11336122111322">Type</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0050__p327014214317"><strong id="dds_api_0050__b67140469511">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0050__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0050__p6751103117513">job_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0050__p157511931653">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0050__p48259009">Indicates the task ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
<ul id="dds_api_0050__ul16665627"><li id="dds_api_0050__li15772917">Response example<pre class="codeblock" id="dds_api_0050__codeblock660937479172">{
|
||||
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5"
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0050__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0050__dds_api_0018_p16131712193312">Status Code:202.</p>
|
||||
<p id="dds_api_0050__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0050__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0050__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>
|
||||
|
115
docs/dds/api-ref/dds_api_0051.html
Normal file
115
docs/dds/api-ref/dds_api_0051.html
Normal file
File diff suppressed because it is too large
Load Diff
82
docs/dds/api-ref/dds_api_0053.html
Normal file
82
docs/dds/api-ref/dds_api_0053.html
Normal file
@ -0,0 +1,82 @@
|
||||
<a name="dds_api_0053"></a><a name="dds_api_0053"></a>
|
||||
|
||||
<h1 class="topictitle1">Modifying a DB Instance Name</h1>
|
||||
<div id="body1540173589336"><div class="section" id="dds_api_0053__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0053__p3631239417316">This API is used to modify a DB instance name.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0053__section1239972118494"><h4 class="sectiontitle">Constraints</h4><p id="dds_api_0053__p1064515261517">The name of the DB instance that is being created or fails to be created cannot be modified.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0053__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0053__ul3084351717316"><li id="dds_api_0053__li915620217316">URI format<p id="dds_api_0053__p912862005412"><a name="dds_api_0053__li915620217316"></a><a name="li915620217316"></a>PUT https://{Endpoint}/v3/{project_id}/instances/{instance_id}/modify-name</p>
|
||||
</li><li id="dds_api_0053__li15430535">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0053__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0053__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0053__p34889605">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0053__p7485743">Mandatory</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0053__p2775334615440">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0053__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0053__p17679057">project_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0053__p22717550">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0053__p57877484163525">Specifies the project ID of a tenant in a region.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0053__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0053__p41557789155220">instance_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0053__p10737742155220">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0053__p64450739155220">Specifies the instance ID, which can be obtained by calling the API for querying instances. If you do not have an instance, you can call the API used for creating an instance.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0053__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0053__ul5099287616954"><li id="dds_api_0053__li5628270116954">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0053__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0053__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0053__p1204887716954">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="22.222222222222225%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0053__p15184124818564">Mandatory</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="17.171717171717173%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0053__p3643495116954">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="43.43434343434344%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0053__p222501215320">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0053__row794180116954"><td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0053__p1893915195211">new_instance_name</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="22.222222222222225%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0053__p10939185185210">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0053__p189393585216">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="43.43434343434344%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0053__p993995165218">Specifies the DB instance name. The instance name can be the same as an existing instance name.</p>
|
||||
<ul id="dds_api_0053__ul1444173811511"><li id="dds_api_0053__li9441138195114">The instance name must contain 4 to 64 characters and must start with a letter. It is case sensitive and can contain letters, digits, hyphens (-), and underscores (_). It cannot contain other special characters.</li></ul>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
<ul id="dds_api_0053__ul1041877316954"><li id="dds_api_0053__li2666010016954">Example request<div class="p" id="dds_api_0053__p15333141451019"><a name="dds_api_0053__li2666010016954"></a><a name="li2666010016954"></a>PUT https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/instances/9136fd2a9fcd405ea4674276ce36dae8in02/modify-name<pre class="codeblock" id="dds_api_0053__codeblock1053211321015">{
|
||||
"new_instance_name": "myNewName"
|
||||
}</pre>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0053__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0053__ul16665627"><li id="dds_api_0053__li15772917">Response example<pre class="codeblock" id="dds_api_0053__codeblock660937479172">{}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0053__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0053__dds_api_0018_p16131712193312">Status Code:200.</p>
|
||||
<p id="dds_api_0053__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0053__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0053__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>
|
||||
|
111
docs/dds/api-ref/dds_api_0054.html
Normal file
111
docs/dds/api-ref/dds_api_0054.html
Normal file
File diff suppressed because it is too large
Load Diff
111
docs/dds/api-ref/dds_api_0055.html
Normal file
111
docs/dds/api-ref/dds_api_0055.html
Normal file
File diff suppressed because it is too large
Load Diff
146
docs/dds/api-ref/dds_api_0056.html
Normal file
146
docs/dds/api-ref/dds_api_0056.html
Normal file
File diff suppressed because it is too large
Load Diff
92
docs/dds/api-ref/dds_api_0057.html
Normal file
92
docs/dds/api-ref/dds_api_0057.html
Normal file
@ -0,0 +1,92 @@
|
||||
<a name="dds_api_0057"></a><a name="dds_api_0057"></a>
|
||||
|
||||
<h1 class="topictitle1">Unbinding an <span id="text10721134011913">EIP</span><span id="text81445441593"></span></h1>
|
||||
<div id="body1579243011633"><div class="section" id="dds_api_0057__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0057__p3631239417316">This API is used to unbind an EIP from a node in a DB instance.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0057__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0057__ul1349153115110"><li id="dds_api_0057__li19998934112">Frozen instances do not support this operation.</li><li id="dds_api_0057__li18491531419">This operation can be performed only on a node with an EIP assigned.</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0057__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0057__ul3084351717316"><li id="dds_api_0057__li915620217316">URI format<p id="dds_api_0057__p912862005412"><a name="dds_api_0057__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/unbind-eip</p>
|
||||
</li><li id="dds_api_0057__li15430535">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0057__table4657088" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0057__row60083059"><th align="left" class="cellrowborder" valign="top" width="24%" id="mcps1.3.3.2.2.1.2.4.1.1"><p id="dds_api_0057__p34889605"><strong id="dds_api_0057__b177504341376">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="24.9%" id="mcps1.3.3.2.2.1.2.4.1.2"><p id="dds_api_0057__p7485743"><strong id="dds_api_0057__b137981351179">Mandatory</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="51.1%" id="mcps1.3.3.2.2.1.2.4.1.3"><p id="dds_api_0057__p2775334615440"><strong id="dds_api_0057__b76323361871">Description</strong></p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0057__row57385070"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0057__p732920567115">project_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0057__p532935613116">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0057__p4329756415">Specifies the project ID of a tenant in a region.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0057__row2864326155157"><td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.3.2.2.1.2.4.1.1 "><p id="dds_api_0057__p23291156016">node_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.9%" headers="mcps1.3.3.2.2.1.2.4.1.2 "><p id="dds_api_0057__p1032910565114">Yes</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="51.1%" headers="mcps1.3.3.2.2.1.2.4.1.3 "><p id="dds_api_0057__p15330656516">Specifies the ID of the node from which the EIP is to be unbound.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0057__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0057__ul1125811571575"><li id="dds_api_0057__li1125865715712">Example request<p id="dds_api_0057__p209255591679"><a name="dds_api_0057__li1125865715712"></a><a name="li1125865715712"></a>POST https://dds.eu-de.otc.t-systems.com/v3/0549b4a43100d4f32f51c01c2fe4acdb/nodes/4709a6332ce348718b5675aadb5e2bccno02/unbind-eip</p>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0057__section28521534113742"><h4 class="sectiontitle">Responses</h4><ul id="dds_api_0057__ul12573920"><li id="dds_api_0057__li46056421">Parameter description
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0057__table32267243" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0057__row9230088"><th align="left" class="cellrowborder" valign="top" width="28.442844284428443%" id="mcps1.3.5.2.1.1.2.4.1.1"><p id="dds_api_0057__p9439626"><strong id="dds_api_0057__b1685615413225">Name</strong></p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="24.412441244124413%" id="mcps1.3.5.2.1.1.2.4.1.2"><p id="dds_api_0057__p26412257">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="47.14471447144714%" id="mcps1.3.5.2.1.1.2.4.1.3"><p id="dds_api_0057__p327014214317">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0057__row15736877"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0057__p390753815217">job_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0057__p1490753814213">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0057__p390733820216">Indicates the workflow ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0057__row263544116490"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0057__p89076381921">node_name</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0057__p189075381829">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0057__p209071538128">Indicates the node name.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0057__row10449661708"><td class="cellrowborder" valign="top" width="28.442844284428443%" headers="mcps1.3.5.2.1.1.2.4.1.1 "><p id="dds_api_0057__p89071138924">node_id</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="24.412441244124413%" headers="mcps1.3.5.2.1.1.2.4.1.2 "><p id="dds_api_0057__p49071383216">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="47.14471447144714%" headers="mcps1.3.5.2.1.1.2.4.1.3 "><p id="dds_api_0057__p17907193817213">Indicates the node ID.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li></ul>
|
||||
<ul id="dds_api_0057__ul16665627"><li id="dds_api_0057__li15772917">Response example<pre class="codeblock" id="dds_api_0057__codeblock660937479172">{
|
||||
"job_id": "3711e2ad-5787-49bc-a47f-3f0b066af9f5",
|
||||
"node_id": "52a4c096bb1f455d8d866956a959519eno02",
|
||||
"node_name": "mongodb-8977_mongos_node_1"
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0057__section5382712154838"><h4 class="sectiontitle">Status Code</h4><p id="dds_api_0057__dds_api_0018_p16131712193312">Status Code:200.</p>
|
||||
<p id="dds_api_0057__dds_api_0018_p480617135329">For more information, see <a href="dds_status_code.html">Status Code</a>.</p>
|
||||
</div>
|
||||
<div class="section" id="dds_api_0057__section6522193710339"><h4 class="sectiontitle">Error Code</h4><p id="dds_api_0057__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>
|
||||
|
129
docs/dds/api-ref/dds_api_0058.html
Normal file
129
docs/dds/api-ref/dds_api_0058.html
Normal file
File diff suppressed because it is too large
Load Diff
140
docs/dds/api-ref/dds_api_0059.html
Normal file
140
docs/dds/api-ref/dds_api_0059.html
Normal file
File diff suppressed because it is too large
Load Diff
41
docs/dds/api-ref/dds_api_0060.html
Normal file
41
docs/dds/api-ref/dds_api_0060.html
Normal file
@ -0,0 +1,41 @@
|
||||
<a name="dds_api_0060"></a><a name="dds_api_0060"></a>
|
||||
|
||||
<h1 class="topictitle1">Abnormal Request Results</h1>
|
||||
<div id="body1598235747952"><ul id="dds_api_0060__u4f311cc3d4d6454f95f1461d067af3e2"><li id="dds_api_0060__l5ca24795c72b4566bc19d49477c0f38b">Abnormal responses
|
||||
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0060__t1600a24cde73446fadb04fa4fd4176c9" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0060__rd8bc4cbf15874672964a2f6155ff619b"><th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.1.1.1.2.4.1.1"><p id="dds_api_0060__ae933c42bba744097bb871e1e47a3d811">Name</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.1.1.1.2.4.1.2"><p id="dds_api_0060__a70dcf20d1f394d3886396b45ae4ed9e9">Type</p>
|
||||
</th>
|
||||
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.1.1.1.2.4.1.3"><p id="dds_api_0060__aab87d22c016b458fbf47a74f2c84238b">Description</p>
|
||||
</th>
|
||||
</tr>
|
||||
</thead>
|
||||
<tbody><tr id="dds_api_0060__r3a83848174a44b2499a0b79476a18366"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.1.1.2.4.1.1 "><p id="dds_api_0060__p6826111184918">error_code</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.1.1.2.4.1.2 "><p id="dds_api_0060__a70943c58d7524abcb12b87181c64e2a5">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.1.1.2.4.1.3 "><p id="dds_api_0060__ac399032b44cd41cd82fc0a0c3e083886">Specifies the error returned when a task submission exception occurs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr id="dds_api_0060__r406296b9b2bf4aafb5e79cf9da8fb201"><td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.1.1.1.2.4.1.1 "><p id="dds_api_0060__aa97ccde9ddfc4aa0823d82c4a22f6962">error_msg</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.1.1.1.2.4.1.2 "><p id="dds_api_0060__a1ef067712a0141029c3dd10e0df28ab9">String</p>
|
||||
</td>
|
||||
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.1.1.1.2.4.1.3 "><p id="dds_api_0060__a0994d9a70c8241ba8a2b1fc9b0757e6e">Specifies the description of the error returned when a task submission exception occurs.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</li><li id="dds_api_0060__li1789672611102">Example abnormal response<pre class="codeblock" id="dds_api_0060__codeblock974934318538">{
|
||||
"error_code": "DBS.200001",
|
||||
"error_msg": "Parameter error"
|
||||
}</pre>
|
||||
</li></ul>
|
||||
</div>
|
||||
<div>
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_public_parameters.html">Appendix</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
122
docs/dds/api-ref/dds_api_0080.html
Normal file
122
docs/dds/api-ref/dds_api_0080.html
Normal file
File diff suppressed because it is too large
Load Diff
110
docs/dds/api-ref/dds_api_0081.html
Normal file
110
docs/dds/api-ref/dds_api_0081.html
Normal file
File diff suppressed because it is too large
Load Diff
136
docs/dds/api-ref/dds_api_0082.html
Normal file
136
docs/dds/api-ref/dds_api_0082.html
Normal file
File diff suppressed because it is too large
Load Diff
198
docs/dds/api-ref/dds_api_0083.html
Normal file
198
docs/dds/api-ref/dds_api_0083.html
Normal file
File diff suppressed because it is too large
Load Diff
210
docs/dds/api-ref/dds_api_0084.html
Normal file
210
docs/dds/api-ref/dds_api_0084.html
Normal file
File diff suppressed because it is too large
Load Diff
29
docs/dds/api-ref/dds_api_0092.html
Normal file
29
docs/dds/api-ref/dds_api_0092.html
Normal file
@ -0,0 +1,29 @@
|
||||
<a name="dds_api_0092"></a><a name="dds_api_0092"></a>
|
||||
|
||||
<h1 class="topictitle1">Log Information Queries</h1>
|
||||
<div id="body1492599633511"></div>
|
||||
<div>
|
||||
<ul class="ullinks">
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0093.html">Querying Database Slow Logs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0094.html">Obtaining Links for Downloading Slow Query Logs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0095.html">Querying Database Error Logs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0096.html">Obtaining Links for Downloading Error Logs</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0097.html">Setting SQL Audit</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0098.html">Querying SQL Audit Policy</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0099.html">Obtaining the Audit Log List</a></strong><br>
|
||||
</li>
|
||||
<li class="ulchildlink"><strong><a href="dds_api_0100.html">Obtaining Links for Downloading Audit Logs</a></strong><br>
|
||||
</li>
|
||||
</ul>
|
||||
|
||||
<div class="familylinks">
|
||||
<div class="parentlink"><strong>Parent topic:</strong> <a href="dds_api_description.html">APIs V3.0 (Recommended)</a></div>
|
||||
</div>
|
||||
</div>
|
||||
|
229
docs/dds/api-ref/dds_api_0093.html
Normal file
229
docs/dds/api-ref/dds_api_0093.html
Normal file
File diff suppressed because it is too large
Load Diff
271
docs/dds/api-ref/dds_api_0094.html
Normal file
271
docs/dds/api-ref/dds_api_0094.html
Normal file
File diff suppressed because it is too large
Load Diff
189
docs/dds/api-ref/dds_api_0095.html
Normal file
189
docs/dds/api-ref/dds_api_0095.html
Normal file
File diff suppressed because it is too large
Load Diff
274
docs/dds/api-ref/dds_api_0096.html
Normal file
274
docs/dds/api-ref/dds_api_0096.html
Normal file
File diff suppressed because it is too large
Load Diff
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user