vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity

ddm_api

Browse Source 
Reviewed-by: Boka, Ladislav <ladislav.boka@t-systems.com>
Co-authored-by: Ru, Li Yi <liyiru7@huawei.com>
Co-committed-by: Ru, Li Yi <liyiru7@huawei.com>
This commit is contained in:
Ru, Li Yi 2024-04-09 12:27:54 +00:00 committed by zuul
parent 7914103af1
commit d804d7d1be
73 changed files with 11852 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

923
docs/ddm/api-ref/ALL_META.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

461
docs/ddm/api-ref/CLASS.TXT.json Normal file
View File

File diff suppressed because it is too large Load Diff

3
docs/ddm/api-ref/PARAMETERS.txt Normal file
View File

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

191
docs/ddm/api-ref/ddm_03_0002.html Normal file
View File

File diff suppressed because it is too large Load Diff

378
docs/ddm/api-ref/ddm_04_0001.html Normal file
View File

File diff suppressed because it is too large Load Diff

373
docs/ddm/api-ref/ddm_16_0001.html Normal file
View File

File diff suppressed because it is too large Load Diff

19
docs/ddm/api-ref/ddm_api_01_0001.html Normal file
View File

@ -0,0 +1,19 @@
<a name="ddm_api_01_0001"></a><a name="ddm_api_01_0001"></a>
<h1 class="topictitle1">Before You Start</h1>
<div id="body1524900714294"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_api_01_0002.html">Overview</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0003.html">API Calling</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0004.html">Endpoints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0005.html">Constraints</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0006.html">Concepts</a></strong><br>
</li>
</ul>
</div>

15
docs/ddm/api-ref/ddm_api_01_0002.html Normal file
View File

@ -0,0 +1,15 @@
<a name="ddm_api_01_0002"></a><a name="ddm_api_01_0002"></a>
<h1 class="topictitle1">Overview</h1>
<div id="body1559813202615"><p id="ddm_api_01_0002__p494718568310">Welcome to Distributed Database Middleware (DDM). This document describes functions, syntax, parameters, and examples of DDM.</p>
<p id="ddm_api_01_0002__p122548251992">If you plan to access DDM through an API, ensure that you are familiar with DDM concepts.</p>
<p id="ddm_api_01_0002__p1187516428492">This document describes how to use application programming interfaces (APIs) to perform creating, querying, deleting, and updating operations.</p>
<div class="note" id="ddm_api_01_0002__note1227721211129"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><ul id="ddm_api_01_0002__ul196161728144417"><li id="ddm_api_01_0002__li156166284445">This document will be updated when APIs of new functions are added, for example, adding response parameters.</li><li id="ddm_api_01_0002__li166220302441">To reduce impacts caused by API changes, DDM is backward compatible with existing APIs. When using DDM, you should accept and ignore unused parameters and parameter values in JSON responses.</li></ul>
</div></div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/ddm/api-ref/ddm_api_01_0003.html Normal file
View File

@ -0,0 +1,11 @@
<a name="ddm_api_01_0003"></a><a name="ddm_api_01_0003"></a>
<h1 class="topictitle1">API Calling</h1>
<div id="body1559813202615"><p id="ddm_api_01_0003__p8060118">DDM supports Representational State Transfer (REST) APIs, allowing you to call APIs using HTTPS.</p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0001.html">Before You Start</a></div>
</div>
</div>

11
docs/ddm/api-ref/ddm_api_01_0004.html Normal file
View File

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

11
docs/ddm/api-ref/ddm_api_01_0005.html Normal file
View File

@ -0,0 +1,11 @@
<a name="ddm_api_01_0005"></a><a name="ddm_api_01_0005"></a>
<h1 class="topictitle1">Constraints</h1>
<div id="body1559813202615"><ul id="ddm_api_01_0005__ul153761126236"><li id="ddm_api_01_0005__li637615215239">The number of DDM instances that you can create is determined by your quota.</li><li id="ddm_api_01_0005__li1237616219233">For more constraints, see API description.</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0001.html">Before You Start</a></div>
</div>
</div>

19
docs/ddm/api-ref/ddm_api_01_0006.html Normal file
View File

@ -0,0 +1,19 @@
<a name="ddm_api_01_0006"></a><a name="ddm_api_01_0006"></a>
<h1 class="topictitle1">Concepts</h1>
<div id="body1559813202615"><ul id="ddm_api_01_0006__en-us_topic_0170093947_ul128965163312"><li id="ddm_api_01_0006__en-us_topic_0169294976_li489681620316">Account<p id="ddm_api_01_0006__en-us_topic_0169294976_p1089611169316"><a name="ddm_api_01_0006__en-us_topic_0169294976_li489681620316"></a><a name="en-us_topic_0169294976_li489681620316"></a>An account is created upon successful registration. The account has full access permissions for all of its cloud services and resources. It can be used to reset user passwords and grant user permissions. The account is a payment entity and should not be used directly to perform routine management. For security purposes, create users and grant them permissions for routine management.</p>
</li><li id="ddm_api_01_0006__en-us_topic_0169294976_li15896816113116">IAM user<p id="ddm_api_01_0006__en-us_topic_0169294976_p589691603117"><a name="ddm_api_01_0006__en-us_topic_0169294976_li15896816113116"></a><a name="en-us_topic_0169294976_li15896816113116"></a>An IAM user is created using an account to use cloud services. Each IAM user has its own identity credentials (password and access keys).</p>
</li><li id="ddm_api_01_0006__en-us_topic_0169294976_li1564913617106">Region<p id="ddm_api_01_0006__en-us_topic_0169294976_p10588103711107"><a name="ddm_api_01_0006__en-us_topic_0169294976_li1564913617106"></a><a name="en-us_topic_0169294976_li1564913617106"></a>A region is a geographic area in which cloud resources are deployed. Availability zones (AZs) in the same region can communicate with each other over an intranet, while AZs in different regions are isolated from each other. Deploying cloud resources in different regions can better suit certain user requirements or comply with local laws or regulations.</p>
</li><li id="ddm_api_01_0006__en-us_topic_0169294976_li1183783919109">AZ<p id="ddm_api_01_0006__en-us_topic_0169294976_p061084051014"><a name="ddm_api_01_0006__en-us_topic_0169294976_li1183783919109"></a><a name="en-us_topic_0169294976_li1183783919109"></a>An AZ comprises one or more physical data centers equipped with independent cooling, fire extinguishing, moisture-proof, and electricity facilities. Computing, network, storage, and other resources in an AZ are logically divided into multiple clusters. AZs within a region are interconnected using high-speed optical fibers to allow users to build cross-AZ high-availability systems.</p>
</li><li id="ddm_api_01_0006__en-us_topic_0169294976_li3896216123113">Project<p id="ddm_api_01_0006__en-us_topic_0169294976_p10896181643118"><a name="ddm_api_01_0006__en-us_topic_0169294976_li3896216123113"></a><a name="en-us_topic_0169294976_li3896216123113"></a>A project corresponds to a region. Projects group and isolate resources (including compute, storage, and network resources) across physical regions. Users can be granted permissions in a default project to access all resources in the region associated with the project. For more refined access control, create subprojects under a project and purchase resources in the subprojects. Users can then be assigned permissions to access only specific resources in the subprojects.</p>
<div class="fignone" id="ddm_api_01_0006__fig624534017105"><span class="figcap"><b>Figure 1 </b>Project isolating model</span><br><span><img id="ddm_api_01_0006__image72455409107" src="en-us_image_0000001733265073.png"></span></div>
<ul id="ddm_api_01_0006__ul184881910181112"><li id="ddm_api_01_0006__li19489131071116">Enterprise project<p id="ddm_api_01_0006__p1624415510515"><a name="ddm_api_01_0006__li19489131071116"></a><a name="li19489131071116"></a>Enterprise projects group and manage resources across regions. Resources in enterprise projects are logically isolated from each other. An enterprise project can contain resources of multiple regions, and resources can be added to or removed from the enterprise project.</p>
</li></ul>
</li></ul>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0001.html">Before You Start</a></div>
</div>
</div>

163
docs/ddm/api-ref/ddm_api_01_0007.html Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/ddm/api-ref/ddm_api_01_0008.html Normal file
View File

@ -0,0 +1,15 @@
<a name="ddm_api_01_0008"></a><a name="ddm_api_01_0008"></a>
<h1 class="topictitle1">Calling APIs</h1>
<div id="body1559813202616"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_03_0002.html">Making an API Request</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0011.html">Authentication</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0012.html">Returned Values</a></strong><br>
</li>
</ul>
</div>

50
docs/ddm/api-ref/ddm_api_01_0011.html Normal file
View File

@ -0,0 +1,50 @@
<a name="ddm_api_01_0011"></a><a name="ddm_api_01_0011"></a>
<h1 class="topictitle1">Authentication</h1>
<div id="body1559813202616"><p id="ddm_api_01_0011__p27556670">Token authentication is required to call APIs.</p>
<p id="ddm_api_01_0011__p4531593915538">Authentication using tokens: General requests are authenticated using tokens.</p>
<div class="section" id="ddm_api_01_0011__section2417768214391"><h4 class="sectiontitle">Token-based Authentication</h4><div class="note" id="ddm_api_01_0011__note133321911123"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="ddm_api_01_0011__p1254514271026">The validity period of a token is 24 hours. If a token is required, the system caches the token to avoid frequent calling.</p>
</div></div>
<p id="ddm_api_01_0011__p18703477214">A token specifies temporary permissions in a computer system. Token-based authentication adds a token in a request as its header during API calling to obtain the permissions for operating APIs on IAM.</p>
<pre class="screen" id="ddm_api_01_0011__screen1523316215617">{
"auth": {
"identity": {
"methods": [
"password"
],
"password": {
"user": {
"name": "<strong id="ddm_api_01_0011__b523211213611"><em id="ddm_api_01_0011__i152321121768">username</em></strong>",
"password": "<strong id="ddm_api_01_0011__b1423242864"><em id="ddm_api_01_0011__i102321723618">********</em></strong>",
"domain": {
"name": "<strong id="ddm_api_01_0011__b1232182160"><em id="ddm_api_01_0011__i142321521463">domainname</em></strong>"
}
}
}
},
<strong id="ddm_api_01_0011__b172326214617"> "scope": {</strong><strong id="ddm_api_01_0011__b122324215616"> </strong>
<strong id="ddm_api_01_0011__b32321024619"> </strong><strong id="ddm_api_01_0011__b62336216618"> "project": {</strong><strong id="ddm_api_01_0011__b1623362867"> </strong>
<strong id="ddm_api_01_0011__b1423332562"> </strong><strong id="ddm_api_01_0011__b8233162061"> "name": "<em id="ddm_api_01_0011__i6233321063">xxxxxxxx</em>"</strong><strong id="ddm_api_01_0011__b123313217620"> </strong>
<strong id="ddm_api_01_0011__b1423332869"> </strong><strong id="ddm_api_01_0011__b52331822611"> }</strong><strong id="ddm_api_01_0011__b1223313212617"> </strong>
<strong id="ddm_api_01_0011__b182333215616"> </strong><strong id="ddm_api_01_0011__b17233172167"> }</strong><strong id="ddm_api_01_0011__b122332212612"> </strong>
}
}
</pre>
<p id="ddm_api_01_0011__p116169153412">In <a href="ddm_03_0002.html">Making an API Request</a>, the process of calling the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a> is described.</p>
<p id="ddm_api_01_0011__p9691122114266">After obtaining the token, add the <strong id="ddm_api_01_0011__b42721512191713">X-Auth-Token</strong> header in a request to specify the token when calling other APIs. For example, if the token is <span class="parmvalue" id="ddm_api_01_0011__parmvalue28901578820"><b>ABCDEFJ....</b></span>, <span class="parmvalue" id="ddm_api_01_0011__parmvalue389112571389"><b>X-Auth-Token: ABCDEFJ....</b></span> can be added to a request as follows:</p>
<div class="codecoloring" codetype="Java" id="ddm_api_01_0011__screen11189101154015"><div class="highlight"><table class="highlighttable"><tr><td class="linenos"><div class="linenodiv"><pre><span class="normal">1</span>
<span class="normal">2</span>
<span class="normal">3</span></pre></div></td><td class="code"><div><pre><span></span><span class="n">POST</span><span class="w"> </span><span class="n">https</span><span class="p">:</span><span class="c1">//{{Endpoint}}/v3/auth/projects</span>
<span class="n">Content</span><span class="o">-</span><span class="n">Type</span><span class="p">:</span><span class="w"> </span><span class="n">application</span><span class="o">/</span><span class="n">json</span>
<span class="n">X</span><span class="o">-</span><span class="n">Auth</span><span class="o">-</span><span class="n">Token</span><span class="p">:</span><span class="w"> </span><span class="n">ABCDEFJ</span><span class="p">....</span>
</pre></div></td></tr></table></div>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0008.html">Calling APIs</a></div>
</div>
</div>

39
docs/ddm/api-ref/ddm_api_01_0012.html Normal file
View File

@ -0,0 +1,39 @@
<a name="ddm_api_01_0012"></a><a name="ddm_api_01_0012"></a>
<h1 class="topictitle1">Returned Values</h1>
<div id="body1559813202616"><div class="section" id="ddm_api_01_0012__section968114282311"><h4 class="sectiontitle">Status Code</h4><p id="ddm_api_01_0012__p4624111624411">After sending a request, you will receive a response, including the status code, response header, and response body.</p>
<p id="ddm_api_01_0012__p124381044137">A status code is a group of digits ranging from 1xx to 5xx. It indicates the status of a response. For more information, see <a href="ddm_api_01_0060.html">Status Codes</a>.</p>
<p id="ddm_api_01_0012__p16241926101414">For example, if status code <strong id="ddm_api_01_0012__b68539271897">201</strong> is returned for calling the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the request is successful.</p>
</div>
<div class="section" id="ddm_api_01_0012__en-us_topic_0113746487_section61333484715"><h4 class="sectiontitle">Response Header</h4><p id="ddm_api_01_0012__p384320471837">Similar to a request, a response also has a header, for example, <span class="parmvalue" id="ddm_api_01_0012__parmvalue387035713814"><b>Content-Type</b></span>.</p>
<p id="ddm_api_01_0012__p4430113619484"><a href="#ddm_api_01_0012__fig4865141011511">Figure 1</a> shows the response header for the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>. The <span class="parmname" id="ddm_api_01_0012__parmname12394351916"><b>x-subject-token</b></span> header field is the desired user token. This token can then be used to authenticate the calling of other APIs.</p>
<div class="fignone" id="ddm_api_01_0012__fig4865141011511"><a name="ddm_api_01_0012__fig4865141011511"></a><a name="fig4865141011511"></a><span class="figcap"><b>Figure 1 </b>Header fields of the response to the request for obtaining a user token</span><br><span><img id="ddm_api_01_0012__image48651610135113" src="en-us_image_0000001685146158.png"></span></div>
</div>
<div class="section" id="ddm_api_01_0012__en-us_topic_0113746487_section2045571671419"><h4 class="sectiontitle">(Optional) Response Body</h4><p id="ddm_api_01_0012__en-us_topic_0113746487_p64711881416">This part is optional. The body of a response is often returned in structured format (for example, JSON or XML) as specified in the <strong id="ddm_api_01_0012__b143714163912">Content-Type</strong> header field. The response body transfers content except the response header.</p>
<div class="p" id="ddm_api_01_0012__p157041652367">For the API used to <a href="https://docs.otc.t-systems.com/en-us/api/iam/en-us_topic_0057845583.html" target="_blank" rel="noopener noreferrer">obtain a user token</a>, the following information is returned. The following describes part of the request body.<pre class="screen" id="ddm_api_01_0012__screen01152675713">{
"token": {
"expires_at": "2019-02-13T06:52:13.855000Z",
"methods": [
"password"
],
"catalog": [
{
"endpoints": [
{
"region_id": "az-01",
......</pre>
</div>
<div class="p" id="ddm_api_01_0012__p127537375412">If an error occurs during API calling, the system returns an error code and message to you. The following shows the format of an error response body:<pre class="screen" id="ddm_api_01_0012__screen198081822715">{
"error_code": "AS.0001",
"error_msg": "The format of message is error"
}</pre>
</div>
<p id="ddm_api_01_0012__p1589911464018">In the response body, <strong id="ddm_api_01_0012__b969272411910">error_code</strong> is an error code, and <strong id="ddm_api_01_0012__b20693162410915">error_msg</strong> provides information about the error.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0008.html">Calling APIs</a></div>
</div>
</div>

51
docs/ddm/api-ref/ddm_api_01_0014.html Normal file
View File

@ -0,0 +1,51 @@
<a name="ddm_api_01_0014"></a><a name="ddm_api_01_0014"></a>
<h1 class="topictitle1">DDM Instances</h1>
<div id="body0000001259189668"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_04_0001.html">Creating a DDM instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0018.html">Querying DDM Instances</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0019.html">Querying Details of a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0020.html">Modifying the Name of a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0021.html">Modifying the Security Group of a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0022.html">Deleting a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0023.html">Restarting a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0024.html">Reloading Table Data</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0025.html">Scaling Out a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0026.html">Scaling In a DDM instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0080.html">Modifying the Read Policy of the Associated DB Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0081.html">Synchronizing Data Node Information</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0082.html">Querying Nodes of a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0083.html">Querying Details of a DDM Instance Node</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0084.html">Querying Parameters of a Specified DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0085.html">Modifying Parameters of a DDM Instance</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0015.html">Querying DDM Engine Information</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0016.html">Querying DDM Node Classes Available in an AZ</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0017.html">Changing the Node Class of a DDM Instance</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_02_0000.html">APIs (Recommended)</a></div>
</div>
</div>

333
docs/ddm/api-ref/ddm_api_01_0015.html Normal file
View File

File diff suppressed because it is too large Load Diff

465
docs/ddm/api-ref/ddm_api_01_0016.html Normal file
View File

File diff suppressed because it is too large Load Diff

242
docs/ddm/api-ref/ddm_api_01_0017.html Normal file
View File

File diff suppressed because it is too large Load Diff

421
docs/ddm/api-ref/ddm_api_01_0018.html Normal file
View File

File diff suppressed because it is too large Load Diff

393
docs/ddm/api-ref/ddm_api_01_0019.html Normal file
View File

File diff suppressed because it is too large Load Diff

226
docs/ddm/api-ref/ddm_api_01_0020.html Normal file
View File

File diff suppressed because it is too large Load Diff

223
docs/ddm/api-ref/ddm_api_01_0021.html Normal file
View File

File diff suppressed because it is too large Load Diff

232
docs/ddm/api-ref/ddm_api_01_0022.html Normal file
View File

File diff suppressed because it is too large Load Diff

267
docs/ddm/api-ref/ddm_api_01_0023.html Normal file
View File

File diff suppressed because it is too large Load Diff

178
docs/ddm/api-ref/ddm_api_01_0024.html Normal file
View File

File diff suppressed because it is too large Load Diff

275
docs/ddm/api-ref/ddm_api_01_0025.html Normal file
View File

File diff suppressed because it is too large Load Diff

255
docs/ddm/api-ref/ddm_api_01_0026.html Normal file
View File

File diff suppressed because it is too large Load Diff

23
docs/ddm/api-ref/ddm_api_01_0027.html Normal file
View File

@ -0,0 +1,23 @@
<a name="ddm_api_01_0027"></a><a name="ddm_api_01_0027"></a>
<h1 class="topictitle1">Schemas</h1>
<div id="body0000001306709649"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_16_0001.html">Creating a Schema</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0029.html">Querying Schemas</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0030.html">Querying Details of a Schema</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0031.html">Deleting a Schema</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0100.html">Querying DB Instances Available for Creating a Schema</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_02_0000.html">APIs (Recommended)</a></div>
</div>
</div>

354
docs/ddm/api-ref/ddm_api_01_0029.html Normal file
View File

File diff suppressed because it is too large Load Diff

470
docs/ddm/api-ref/ddm_api_01_0030.html Normal file
View File

File diff suppressed because it is too large Load Diff

233
docs/ddm/api-ref/ddm_api_01_0031.html Normal file
View File

File diff suppressed because it is too large Load Diff

17
docs/ddm/api-ref/ddm_api_01_0041.html Normal file
View File

@ -0,0 +1,17 @@
<a name="ddm_api_01_0041"></a><a name="ddm_api_01_0041"></a>
<h1 class="topictitle1">DDM Accounts</h1>
<div id="body0000001259349568"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_api_01_0101.html">Managing the Administrator Password</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0102.html">Validating Password Strength</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_02_0000.html">APIs (Recommended)</a></div>
</div>
</div>

21
docs/ddm/api-ref/ddm_api_01_0058.html Normal file
View File

@ -0,0 +1,21 @@
<a name="ddm_api_01_0058"></a><a name="ddm_api_01_0058"></a>
<h1 class="topictitle1">Appendix</h1>
<div id="body1571880174370"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_api_01_0059.html">Abnormal Request Results</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0060.html">Status Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0061.html">Error Codes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0062.html">Node Classes</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0063.html">Obtaining a Project ID</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="ddm_api_01_0064.html">Status Description</a></strong><br>
</li>
</ul>
</div>

42
docs/ddm/api-ref/ddm_api_01_0059.html Normal file
View File

@ -0,0 +1,42 @@
<a name="ddm_api_01_0059"></a><a name="ddm_api_01_0059"></a>
<h1 class="topictitle1">Abnormal Request Results</h1>
<div id="body1571880174372"><div class="section" id="ddm_api_01_0059__section6599358194713"><h4 class="sectiontitle">Abnormal Response</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ddm_api_01_0059__table19606185874712" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="ddm_api_01_0059__row972585864711"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.1.2.2.4.1.1"><p id="ddm_api_01_0059__p272545864718"><strong id="ddm_api_01_0059__b146381249195714">Parameter</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.1.2.2.4.1.2"><p id="ddm_api_01_0059__p17251658114719"><strong id="ddm_api_01_0059__b154601451145717">Type</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="65%" id="mcps1.3.1.2.2.4.1.3"><p id="ddm_api_01_0059__p1772565810471"><strong id="ddm_api_01_0059__b1655465295712">Description</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ddm_api_01_0059__row27264583471"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.2.4.1.1 "><p id="ddm_api_01_0059__p1995513454530">errCode</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.2.2.4.1.2 "><p id="ddm_api_01_0059__p1072685813471">String</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.1.2.2.4.1.3 "><p id="ddm_api_01_0059__p872615819477">Returned error code when a task submission exception occurs. For details, see <a href="ddm_api_01_0061.html">Error Codes</a>.</p>
</td>
</tr>
<tr id="ddm_api_01_0059__row6726125884718"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.1.2.2.4.1.1 "><p id="ddm_api_01_0059__p2569123717539">externalMessage</p>
</td>
<td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.1.2.2.4.1.2 "><p id="ddm_api_01_0059__p1726558144712">String</p>
</td>
<td class="cellrowborder" valign="top" width="65%" headers="mcps1.3.1.2.2.4.1.3 "><p id="ddm_api_01_0059__a0994d9a70c8241ba8a2b1fc9b0757e6e">Description of the error returned when a task submission exception occurs.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ddm_api_01_0059__section17611195884712"><h4 class="sectiontitle">Example Response</h4><pre class="codeblock" id="ddm_api_01_0059__codeblock1649912044715">{
"errCode": "DBS.300101",
"externalMessage": "Failed to delete the schema"
}</pre>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0058.html">Appendix</a></div>
</div>
</div>

130
docs/ddm/api-ref/ddm_api_01_0060.html Normal file
View File

File diff suppressed because it is too large Load Diff

974
docs/ddm/api-ref/ddm_api_01_0061.html Normal file
View File

File diff suppressed because it is too large Load Diff

52
docs/ddm/api-ref/ddm_api_01_0062.html Normal file
View File

@ -0,0 +1,52 @@
<a name="ddm_api_01_0062"></a><a name="ddm_api_01_0062"></a>
<h1 class="topictitle1">Node Classes</h1>
<div id="body1604650803126"><p id="ddm_api_01_0062__p134261131171410">DDM node classes are listed in the following table and vary according to actual situations.</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ddm_api_01_0062__table18594185010409" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Supported DDM node classes</caption><thead align="left"><tr id="ddm_api_01_0062__row175951350164019"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.1"><p id="ddm_api_01_0062__p0595155084015"><strong id="ddm_api_01_0062__b175016718521">Specification Code</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.2"><p id="ddm_api_01_0062__p175951550154014"><strong id="ddm_api_01_0062__b339213916528">vCPUs</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.3"><p id="ddm_api_01_0062__p1559535084011"><strong id="ddm_api_01_0062__b185420025317">Memory (GB)</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.2.2.5.1.4"><p id="ddm_api_01_0062__p16595155014019"><strong id="ddm_api_01_0062__b146662181315">Architecture</strong></p>
</th>
</tr>
</thead>
<tbody><tr id="ddm_api_01_0062__row259515014017"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="ddm_api_01_0062__p125951250204011">ddm.2xlarge.2</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="ddm_api_01_0062__p195954507401">8</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="ddm_api_01_0062__p12595135017401">16</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="ddm_api_01_0062__p15595165074012">x86</p>
</td>
</tr>
<tr id="ddm_api_01_0062__row1659595084016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="ddm_api_01_0062__p19128442413">ddm.4xlarge.2</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="ddm_api_01_0062__p13595850114015">16</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="ddm_api_01_0062__p1359565084013">32</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="ddm_api_01_0062__p1959520500408">x86</p>
</td>
</tr>
<tr id="ddm_api_01_0062__row16595125014019"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.1 "><p id="ddm_api_01_0062__p15934617424">ddm.8xlarge.2</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.2 "><p id="ddm_api_01_0062__p115951450124013">32</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.3 "><p id="ddm_api_01_0062__p759520505405">64</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.2.2.5.1.4 "><p id="ddm_api_01_0062__p259515044019">x86</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0058.html">Appendix</a></div>
</div>
</div>

44
docs/ddm/api-ref/ddm_api_01_0063.html Normal file
View File

@ -0,0 +1,44 @@
<a name="ddm_api_01_0063"></a><a name="ddm_api_01_0063"></a>
<h1 class="topictitle1">Obtaining a Project ID</h1>
<div id="body1568281472159"><div class="section" id="ddm_api_01_0063__section236911484369"><h4 class="sectiontitle">Scenarios</h4><p id="ddm_api_01_0063__p8112855194115">When calling APIs, you need to specify the project ID in some URLs. To do so, you need to obtain the project ID first Two methods are available:</p>
<ul id="ddm_api_01_0063__ul1938973714396"><li id="ddm_api_01_0063__li183897377391"><a href="#ddm_api_01_0063__section85791974381">Obtaining the Project ID by Calling an API</a></li><li id="ddm_api_01_0063__li11307945123915"><a href="#ddm_api_01_0063__section153711445316">Obtaining a Project ID from the Console</a></li></ul>
</div>
<div class="section" id="ddm_api_01_0063__section85791974381"><a name="ddm_api_01_0063__section85791974381"></a><a name="section85791974381"></a><h4 class="sectiontitle">Obtaining the Project ID by Calling an API</h4><p id="ddm_api_01_0063__p857314915139">The API used to obtain a project ID is <strong id="ddm_api_01_0063__b92931071451">GET https://{Endpoint}/v3/projects</strong>. <strong id="ddm_api_01_0063__b172941073518">{Endpoint}</strong> is the IAM endpoint and can be obtained from <a href="https://docs.otc.t-systems.com/en-us/endpoint/index.html" target="_blank" rel="noopener noreferrer">Regions and Endpoints</a>. For details about API authentication, see <a href="ddm_api_01_0011.html">Authentication</a>.</p>
<p id="ddm_api_01_0063__p3770181514218">The following is an example response. <strong id="ddm_api_01_0063__b1667072218516">id</strong> indicates the project ID.</p>
<pre class="screen" id="ddm_api_01_0063__screen676419149446">{
"projects": [
{
"domain_id": "65382450e8f64ac0870cd180d14e684b",
"is_domain": false,
"parent_id": "65382450e8f64ac0870cd180d14e684b",
"name": "project_name",
"description": "",
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects/a4a5d4098fb4474fa22cd05f897d6b99"
},
"id": "a4a5d4098fb4474fa22cd05f897d6b99",
"enabled": true
}
],
"links": {
"next": null,
"previous": null,
"self": "https://www.example.com/v3/projects"
}
}</pre>
</div>
<div class="section" id="ddm_api_01_0063__section153711445316"><a name="ddm_api_01_0063__section153711445316"></a><a name="section153711445316"></a><h4 class="sectiontitle">Obtaining a Project ID from the Console</h4><ol id="ddm_api_01_0063__ol3196144819145"><li id="ddm_api_01_0063__li1019624861412"><span>Sign up and log in to the management console.</span></li><li id="ddm_api_01_0063__li119612486145"><span>Move your pointer over the username and select <strong id="ddm_api_01_0063__b1737012175316">My Credentials</strong> in the displayed drop-down list.</span><p><p id="ddm_api_01_0063__p136772519449">On the displayed page, view project IDs in the project list.</p>
<div class="fignone" id="ddm_api_01_0063__fig39324824103512"><span class="figcap"><b>Figure 1 </b>Viewing project IDs</span><br><span><img id="ddm_api_01_0063__image538470016132" src="en-us_image_0000001733265081.jpg"></span></div>
</p></li></ol>
</div>
<p id="ddm_api_01_0063__p97564375307"></p>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_01_0058.html">Appendix</a></div>
</div>
</div>

168
docs/ddm/api-ref/ddm_api_01_0064.html Normal file
View File

File diff suppressed because it is too large Load Diff

43
docs/ddm/api-ref/ddm_api_01_0069.html Normal file
View File

@ -0,0 +1,43 @@
<a name="ddm_api_01_0069"></a><a name="ddm_api_01_0069"></a>
<h1 class="topictitle1">Change History</h1>
<div id="body1571880174377">
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ddm_api_01_0069__table19302135817504" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Document change history</caption><thead align="left"><tr id="ddm_api_01_0069__row15303135816504"><th align="left" class="cellrowborder" valign="top" width="36%" id="mcps1.3.1.2.3.1.1"><p id="ddm_api_01_0069__p1303105835016"><strong id="ddm_api_01_0069__b155201037191810">Released On</strong></p>
</th>
<th align="left" class="cellrowborder" valign="top" width="64%" id="mcps1.3.1.2.3.1.2"><p id="ddm_api_01_0069__p1730395820502">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ddm_api_01_0069__row1833832615461"><td class="cellrowborder" valign="top" width="36%" headers="mcps1.3.1.2.3.1.1 "><p id="ddm_api_01_0069__p173381226104611">2024-02-22</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.1.2.3.1.2 "><p id="ddm_api_01_0069__p375595574619">This issue is the fourth official release, which incorporates the following changes:</p>
<p id="ddm_api_01_0069__p07551855154618">Added <strong id="ddm_api_01_0069__b371424033914">instance_id</strong> to the response parameters in section <a href="ddm_api_01_0101.html">Managing the Administrator Password</a>.</p>
<p id="ddm_api_01_0069__p2126183113531">Deleted <strong id="ddm_api_01_0069__b1716134923911">order_id</strong> from the response parameters in section <a href="ddm_api_01_0017.html">Changing the Node Class of a DDM Instance</a>.</p>
<p id="ddm_api_01_0069__p327310322587">Added <strong id="ddm_api_01_0069__b261719181404">subnet_name</strong> to the response parameters in section <a href="ddm_api_01_0083.html">Querying Details of a DDM Instance Node</a>.</p>
<p id="ddm_api_01_0069__p61491610143813">Added <strong id="ddm_api_01_0069__b16505937134016">ddmNodeId</strong> to the response parameters in section <a href="ddm_api_01_0090.html">Monitoring Slow Query Logs</a>.</p>
</td>
</tr>
<tr id="ddm_api_01_0069__row15343154131610"><td class="cellrowborder" valign="top" width="36%" headers="mcps1.3.1.2.3.1.1 "><p id="ddm_api_01_0069__p1934495411619">2024-01-26</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.1.2.3.1.2 "><p id="ddm_api_01_0069__p73445549164">This issue is the third official release.</p>
<p id="ddm_api_01_0069__p18168175161716">Added <strong id="ddm_api_01_0069__b198977474356">job_id</strong> to response parameters in the following sections.</p>
<ul id="ddm_api_01_0069__ul163671484202"><li id="ddm_api_01_0069__li1836711819206"><a href="ddm_04_0001.html">Creating a DDM instance</a></li><li id="ddm_api_01_0069__li193673816202"><a href="ddm_api_01_0022.html">Deleting a DDM Instance</a></li><li id="ddm_api_01_0069__li1436738152018"><a href="ddm_16_0001.html">Creating a Schema</a></li><li id="ddm_api_01_0069__li83676814202"><a href="ddm_api_01_0031.html">Deleting a Schema</a></li><li id="ddm_api_01_0069__li1836738182018"><a href="ddm_api_01_0101.html">Managing the Administrator Password</a></li></ul>
</td>
</tr>
<tr id="ddm_api_01_0069__row739862781416"><td class="cellrowborder" valign="top" width="36%" headers="mcps1.3.1.2.3.1.1 "><p id="ddm_api_01_0069__p16399132711141">2023-10-20</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.1.2.3.1.2 "><p id="ddm_api_01_0069__p9399927191412">This issue is the second official release.</p>
<p id="ddm_api_01_0069__p897601961515">Added the <strong id="ddm_api_01_0069__b10481858338">SET_CONFIGURATION</strong> status in <a href="ddm_api_01_0064.html">Status Description</a>.</p>
<p id="ddm_api_01_0069__p1734145312414">Changed the <strong id="ddm_api_01_0069__b3338184713209">CREATING</strong> status to <strong id="ddm_api_01_0069__b7137145082017">CREATE</strong> in <a href="ddm_api_01_0064.html">Status Description</a>.</p>
</td>
</tr>
<tr id="ddm_api_01_0069__row173031958125014"><td class="cellrowborder" valign="top" width="36%" headers="mcps1.3.1.2.3.1.1 "><p id="ddm_api_01_0069__p2030311581509">2023-01-30</p>
</td>
<td class="cellrowborder" valign="top" width="64%" headers="mcps1.3.1.2.3.1.2 "><p id="ddm_api_01_0069__p1230318585509">This issue is the first official release.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>

236
docs/ddm/api-ref/ddm_api_01_0080.html Normal file
View File

File diff suppressed because it is too large Load Diff

204
docs/ddm/api-ref/ddm_api_01_0081.html Normal file
View File

File diff suppressed because it is too large Load Diff

301
docs/ddm/api-ref/ddm_api_01_0082.html Normal file
View File

File diff suppressed because it is too large Load Diff

277
docs/ddm/api-ref/ddm_api_01_0083.html Normal file
View File

File diff suppressed because it is too large Load Diff

342
docs/ddm/api-ref/ddm_api_01_0084.html Normal file
View File

File diff suppressed because it is too large Load Diff

480
docs/ddm/api-ref/ddm_api_01_0085.html Normal file
View File

File diff suppressed because it is too large Load Diff

15
docs/ddm/api-ref/ddm_api_01_0089.html Normal file
View File

@ -0,0 +1,15 @@
<a name="ddm_api_01_0089"></a><a name="ddm_api_01_0089"></a>
<h1 class="topictitle1">Monitoring</h1>
<div id="body0000001307029569"></div>
<div>
<ul class="ullinks">
<li class="ulchildlink"><strong><a href="ddm_api_01_0090.html">Monitoring Slow Query Logs</a></strong><br>
</li>
</ul>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="ddm_api_02_0000.html">APIs (Recommended)</a></div>
</div>
</div>

340
docs/ddm/api-ref/ddm_api_01_0090.html Normal file
View 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