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

dds_api

Browse Source 
Reviewed-by: Gladkov, Maksim <mgladkov@noreply.gitea.eco.tsi-dev.otc-service.com>
Co-authored-by: wangdengke2 <wangdengke2@huawei.com>
Co-committed-by: wangdengke2 <wangdengke2@huawei.com>
This commit is contained in:
Wang , Deng Ke
2025-08-13 15:59:03 +00:00
committed by zuul
parent a0d8676db4
commit 87153b4b9b
20 changed files with 1037 additions and 861 deletions
Download Patch File Download Diff File Expand all files Collapse all files

139
docs/dds/api-ref/ALL_META.TXT.json
View File

File diff suppressed because it is too large Load Diff

207
docs/dds/api-ref/CLASS.TXT.json
View File

File diff suppressed because it is too large Load Diff

8
docs/dds/api-ref/dds_api_0020.html
View File

@ -228,7 +228,7 @@
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, and 3.4 are supported. The value can be <strong id="dds_api_0020__b07792501842">4.4, 4.2, 4.0 or </strong><strong id="dds_api_0020__b638841714576">3.4</strong>.</p>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p68674213317">Specifies the database version. Versions 5.0, 4.4, 4.2 and 4.0 are supported. The value can be <strong id="dds_api_0020__b07792501842">5.0, 4.4, 4.2 or 4.0</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.3.2.1.2.2.5.1.1 "><p id="dds_api_0020__p152141624175815">storage_engine</p>
@ -238,7 +238,7 @@
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.3.2.1.2.2.5.1.3 "><p id="dds_api_0020__p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.3.2.1.2.2.5.1.4 "><p id="dds_api_0020__p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0020__ul915212153019"><li id="dds_api_0020__li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__li1916224015329">If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__b175816920818">wiredTiger</strong>.</li></ul>
<ul id="dds_api_0020__ul915212153019"><li id="dds_api_0020__li4152029306">If the database version is 4.2 or later, the storage engine is <strong id="dds_api_0020__b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__li1916224015329">If the database version is 4.0, the storage engine is <strong id="dds_api_0020__b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>
@ -718,7 +718,7 @@ Create a cluster instance:
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0, and 3.4 are supported. The value can be <strong id="dds_api_0020__dds_api_0020_b07792501842">4.4, 4.2, 4.0 or </strong><strong id="dds_api_0020__dds_api_0020_b638841714576">3.4</strong>.</p>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p68674213317">Specifies the database version. Versions 5.0, 4.4, 4.2 and 4.0 are supported. The value can be <strong id="dds_api_0020__dds_api_0020_b07792501842">5.0, 4.4, 4.2 or 4.0</strong>.</p>
</td>
</tr>
<tr id="dds_api_0020__dds_api_0020_row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.4.2.1.2.2.5.1.1 "><p id="dds_api_0020__dds_api_0020_p152141624175815">storage_engine</p>
@ -728,7 +728,7 @@ Create a cluster instance:
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.4.2.1.2.2.5.1.3 "><p id="dds_api_0020__dds_api_0020_p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.4.2.1.2.2.5.1.4 "><p id="dds_api_0020__dds_api_0020_p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0020__dds_api_0020_ul915212153019"><li id="dds_api_0020__dds_api_0020_li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0020__dds_api_0020_b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__dds_api_0020_li1916224015329">If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is <strong id="dds_api_0020__dds_api_0020_b175816920818">wiredTiger</strong>.</li></ul>
<ul id="dds_api_0020__dds_api_0020_ul915212153019"><li id="dds_api_0020__dds_api_0020_li4152029306">If the database version is 4.2 or later, the storage engine is <strong id="dds_api_0020__dds_api_0020_b18610160885">rocksDB</strong>.</li><li id="dds_api_0020__dds_api_0020_li1916224015329">If the database version is 4.0, the storage engine is <strong id="dds_api_0020__dds_api_0020_b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>

2
docs/dds/api-ref/dds_api_0029.html
View File

@ -231,7 +231,7 @@
</td>
<td class="cellrowborder" valign="top" width="24%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_0029__p1656114951410">String</p>
</td>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0029__p125691591144">Indicates the database of version 3.4, 4.0, 4.2, or 4.4. The value is <strong id="dds_api_0029__b023384751015">3.4</strong>, <strong id="dds_api_0029__b4673163032710">4.0</strong>, <strong id="dds_api_0029__b996614223148">4.2</strong>, or <strong id="dds_api_0029__b12233124771012">4.4</strong>.</p>
<td class="cellrowborder" valign="top" width="52%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_0029__p125691591144">Indicates the database of version 4.0, 4.2, 4.4, or 5.0. The value is <strong id="dds_api_0029__b023384751015">4.0</strong>, <strong id="dds_api_0029__b4673163032710">4.2</strong>, <strong id="dds_api_0029__b996614223148">4.4</strong>, or <strong id="dds_api_0029__b12233124771012">5.0</strong>.</p>
</td>
</tr>
</tbody>

4
docs/dds/api-ref/dds_api_0038.html
View File

@ -584,7 +584,7 @@
</td>
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p172142024165814">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p68674213317">Specifies the database version. Versions 4.4, 4.2, 4.0 and 3.4 are supported. The value can be <strong id="dds_api_0038__b07792501842">4.4, 4.2, 4.0 or </strong><strong id="dds_api_0038__b638841714576">3.4</strong>.</p>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p68674213317">Specifies the database version. Versions 5.0, 4.4, 4.2 and 4.0 are supported. The value can be <strong id="dds_api_0038__b07792501842">5.0, 4.4, 4.2 or 4.0</strong>.</p>
</td>
</tr>
<tr id="dds_api_0038__row260045131753"><td class="cellrowborder" valign="top" width="21.21212121212121%" headers="mcps1.3.5.2.1.2.2.5.1.1 "><p id="dds_api_0038__p152141624175815">storage_engine</p>
@ -594,7 +594,7 @@
<td class="cellrowborder" valign="top" width="17.171717171717173%" headers="mcps1.3.5.2.1.2.2.5.1.3 "><p id="dds_api_0038__p1521452419586">String</p>
</td>
<td class="cellrowborder" valign="top" width="42.42424242424242%" headers="mcps1.3.5.2.1.2.2.5.1.4 "><p id="dds_api_0038__p1072024123815">Specifies the storage engine. DDS supports the WiredTiger and RocksDB storage engines.</p>
<ul id="dds_api_0038__ul915212153019"><li id="dds_api_0038__li4152029306">If the database version is 4.4 or 4.2 and the storage engine is RocksDB, the value is <strong id="dds_api_0038__b18610160885">rocksDB</strong>.</li><li id="dds_api_0038__li1916224015329">If the database version is 4.0 or 3.4 and the storage engine is WiredTiger, the value is <strong id="dds_api_0038__b175816920818">wiredTiger</strong>.</li></ul>
<ul id="dds_api_0038__ul915212153019"><li id="dds_api_0038__li4152029306">If the database version is 4.2 or later, the storage engine is <strong id="dds_api_0038__b18610160885">rocksDB</strong>.</li><li id="dds_api_0038__li1916224015329">If the database version is 4.0, the storage engine is <strong id="dds_api_0038__b175816920818">wiredTiger</strong>.</li></ul>
</td>
</tr>
</tbody>

2
docs/dds/api-ref/dds_api_0120.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Enabling Shard or Config IP Addresses</h1>
<div id="body0000001072787211"><div class="section" id="dds_api_0120__section4850156117316"><h4 class="sectiontitle">Function</h4><p id="dds_api_0120__p3631239417316">This API is used to enable the IP addresses of shard or config nodes.</p>
</div>
<div class="section" id="dds_api_0120__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0120__ul1349153115110"><li id="dds_api_0120__li15447401739">Frozen instances do not support this operation.</li><li id="dds_api_0120__li13778164334514">DB instances associated with the IPv6 subnet do not support this operation.</li><li id="dds_api_0120__li171681511134">If the IP address is enabled, restart the nodes for the setting to take effect.</li><li id="dds_api_0120__li14453318174110">Cluster instances of Community Edition 3.4, 4.0, 4.2 and 4.4 are supported.</li><li id="dds_api_0120__li103765812554">This function cannot be disabled after being enabled.</li></ul>
<div class="section" id="dds_api_0120__section1239972118494"><h4 class="sectiontitle">Constraints</h4><ul id="dds_api_0120__ul1349153115110"><li id="dds_api_0120__li15447401739">Frozen instances do not support this operation.</li><li id="dds_api_0120__li13778164334514">DB instances associated with the IPv6 subnet do not support this operation.</li><li id="dds_api_0120__li171681511134">If the IP address is enabled, restart the nodes for the setting to take effect.</li><li id="dds_api_0120__li14453318174110">Cluster instances of Community Edition 4.0, 4.2, 4.4 and 5.0 are supported.</li><li id="dds_api_0120__li103765812554">This function cannot be disabled after being enabled.</li></ul>
</div>
<div class="section" id="dds_api_0120__section28961517113719"><h4 class="sectiontitle">URI</h4><ul id="dds_api_0120__ul3084351717316"><li id="dds_api_0120__li915620217316">URI format<p id="dds_api_0120__p912862005412"><a name="dds_api_0120__li915620217316"></a><a name="li915620217316"></a>POST https://{Endpoint}/v3/{project_id}/instances/{instance_id}/create-ip</p>
</li><li id="dds_api_0120__li15430535">Parameter description

2
docs/dds/api-ref/dds_api_021.html
View File

@ -212,7 +212,7 @@
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.2 "><p id="dds_api_021__p163023597718">String</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_021__p193025591871">Database version. Versions 3.4, 4.0, 4.2, and 4.4 are supported. The value can be <strong id="dds_api_021__b1481611362015">3.4, 4.0,</strong> <strong id="dds_api_021__b292149172710">4.2,</strong> or <strong id="dds_api_021__b112241443819">4.4</strong>.</p>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.3.2.4.1.3 "><p id="dds_api_021__p193025591871">Database version. Versions 4.0, 4.2, 4.4, and 5.0 are supported. The value can be <strong id="dds_api_021__b1481611362015">4.0, 4.2,</strong> <strong id="dds_api_021__b292149172710">4.4,</strong> or <strong id="dds_api_021__b112241443819">5.0</strong>.</p>
</td>
</tr>
</tbody>

331
docs/dds/api-ref/dds_api_022.html Normal file
View File

File diff suppressed because it is too large Load Diff

127
docs/dds/api-ref/dds_api_023.html Normal file
View File

File diff suppressed because it is too large Load Diff

176
docs/dds/api-ref/dds_api_024.html Normal file
View File

File diff suppressed because it is too large Load Diff

155
docs/dds/api-ref/dds_api_025.html Normal file
View File

File diff suppressed because it is too large Load Diff

19
docs/dds/api-ref/dds_change_history.html
View File

@ -8,7 +8,24 @@
</th>
</tr>
</thead>
<tbody><tr id="dds_change_history__row91111923102319"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p4111152352314">2023-05-30</p>
<tbody><tr id="dds_change_history__row1356961321811"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p185704137189">2025-08-08</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p934462919188">Modified the following content:</p>
<ul id="dds_change_history__ul1499253618183"><li id="dds_change_history__li69931136141811"><a href="dds_api_0020.html">Creating a DB Instance</a></li><li id="dds_change_history__li1699316368188"><a href="dds_api_0038.html">Restoring Data to a New DB Instance</a></li><li id="dds_change_history__li12162164041810"><a href="dds_api_023.html">Configuring the Maintenance Window</a></li></ul>
</td>
</tr>
<tr id="dds_change_history__row851045014281"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p18511145012285">2025-08-06</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p144103012290">Modified the following content:</p>
<ul id="dds_change_history__ul1260682113306"><li id="dds_change_history__li760612215306"><a href="dds_api_0020.html">Creating a DB Instance</a></li><li id="dds_change_history__li1101327113012"><a href="dds_api_0038.html">Restoring Data to a New DB Instance</a></li></ul>
</td>
</tr>
<tr id="dds_change_history__row56191744155819"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p20619174475816">2025-07-08</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p3563786591">APIs added: <a href="dds_api_023.html">Configuring the Maintenance Window</a> and added support of DDS version 5.0</p>
</td>
</tr>
<tr id="dds_change_history__row91111923102319"><td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.1.1.3.1.1 "><p id="dds_change_history__p4111152352314">2023-05-30</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.1.1.3.1.2 "><p id="dds_change_history__p265064352413">Modified the following content:</p>
<p id="dds_change_history__p3581058152410">APIs added: <a href="dds_api_021.html">Querying DB Instances in the Recycle Bin</a>, <a href="dds_api_0215.html">Querying the Recycling Policy of a DB Instance</a>, <a href="dds_api_0138.html">Setting the Recycle Bin Policy</a>, <a href="dds_api_0104.html">Configuring Cross-CIDR Access for a Replica Set</a> and added support of DDS version 4.2</p>

2
docs/dds/api-ref/dds_connect_0002.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Querying Sessions of an Instance Node</h1>
<div id="body0000001127512309"><div class="section" id="dds_connect_0002__section19379596234"><h4 class="sectiontitle">Function</h4><p id="dds_connect_0002__p131541003243">This API is used to query sessions of instance nodes.</p>
</div>
<div class="section" id="dds_connect_0002__section193915915231"><h4 class="sectiontitle">Constraints</h4><p id="dds_connect_0002__p1349143112911">Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.</p>
<div class="section" id="dds_connect_0002__section193915915231"><h4 class="sectiontitle">Constraints</h4><p id="dds_connect_0002__p1349143112911">Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.</p>
</div>
<div class="section" id="dds_connect_0002__section1794313599231"><h4 class="sectiontitle">URI</h4><ul id="dds_connect_0002__ul554735718539"><li id="dds_connect_0002__li915620217316">URI format<p id="dds_connect_0002__p912862005412"><a name="dds_connect_0002__li915620217316"></a><a name="li915620217316"></a>GET https://{Endpoint}/v3/{project_id}/nodes/{node_id}/sessions?offset={offset}&amp;limit={limit}&amp;plan_summary={plan_summary}&amp;type={type}&amp;namespace={namespace}&amp;cost_time={cost_time}</p>
</li><li id="dds_connect_0002__li13262203310313">Parameter description

2
docs/dds/api-ref/dds_connect_0003.html
View File

@ -3,7 +3,7 @@
<h1 class="topictitle1">Killing Sessions of an Instance Node</h1>
<div id="body0000001080874504"><div class="section" id="dds_connect_0003__section276112532416"><h4 class="sectiontitle">Function</h4><p id="dds_connect_0003__p14126162512243">This API is used to kill sessions of an instance node.</p>
</div>
<div class="section" id="dds_connect_0003__section07615256244"><h4 class="sectiontitle">Constraints</h4><ul id="dds_connect_0003__ul812632512245"><li id="dds_connect_0003__li1126325122416">Community Edition 3.4, 4.0, 4.2, and 4.4 instances are supported.</li><li id="dds_connect_0003__li2012612518244">Inactive sessions cannot be terminated.</li></ul>
<div class="section" id="dds_connect_0003__section07615256244"><h4 class="sectiontitle">Constraints</h4><ul id="dds_connect_0003__ul812632512245"><li id="dds_connect_0003__li1126325122416">Community Edition 4.0, 4.2, 4.4, and 5.0 instances are supported.</li><li id="dds_connect_0003__li2012612518244">Inactive sessions cannot be terminated.</li></ul>
</div>
<div class="section" id="dds_connect_0003__section137742592419"><h4 class="sectiontitle">URI</h4><ul id="dds_connect_0003__ul53354139141429"><li id="dds_connect_0003__li1270098217262">URI format<p id="dds_connect_0003__p174818141875"><a name="dds_connect_0003__li1270098217262"></a><a name="li1270098217262"></a>POST https://{Endpoint}/v3/{project_id}/nodes/{node_id}/session</p>
</li></ul>

6
docs/dds/api-ref/dds_database_version.html
View File

@ -48,7 +48,7 @@
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.2 "><p id="dds_database_version__p1299616431919">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_database_version__p39568472259">Indicates the database version. Currently, versions 3.4, 4.0, 4.2, and 4.4 are supported.</p>
<td class="cellrowborder" valign="top" width="33.33333333333333%" headers="mcps1.3.4.2.1.1.2.4.1.3 "><p id="dds_database_version__p39568472259">Indicates the database version. Currently, versions 4.0, 4.2, 4.4 and 5.0 are supported.</p>
</td>
</tr>
</tbody>
@ -57,10 +57,10 @@
</li></ul>
<ul id="dds_database_version__ul26818564"><li id="dds_database_version__li40040492">Response example<pre class="codeblock" id="dds_database_version__codeblock66603612164321">{
"versions": [
"3.4",
"4.0",
"4.2",
"4.4"
"4.4",
"5.0"
]
}</pre>
</li></ul>

8
docs/dds/api-ref/dds_instance_mgmt.html
View File

@ -44,11 +44,13 @@
</li>
<li class="ulchildlink"><strong><a href="dds_api_021.html">Querying DB Instances in the Recycle Bin</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000002142831253.html">Querying LTS Log Configurations</a></strong><br>
<li class="ulchildlink"><strong><a href="dds_api_022.html">Querying LTS Log Configurations</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000002107112644.html">Associating an Instance with an LTS Log Stream</a></strong><br>
<li class="ulchildlink"><strong><a href="dds_api_023.html">Configuring the Maintenance Window</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="en-us_topic_0000002107272436.html">Disassociating an Instance from an LTS Log Stream</a></strong><br>
<li class="ulchildlink"><strong><a href="dds_api_024.html">Associating an Instance with an LTS Log Stream</a></strong><br>
</li>
<li class="ulchildlink"><strong><a href="dds_api_025.html">Disassociating an Instance from an LTS Log Stream</a></strong><br>
</li>
</ul>

46
docs/dds/api-ref/dds_instance_specification.html
View File

File diff suppressed because it is too large Load Diff

176
docs/dds/api-ref/en-us_topic_0000002107112644.html
View File

File diff suppressed because it is too large Load Diff

155
docs/dds/api-ref/en-us_topic_0000002107272436.html
View File

File diff suppressed because it is too large Load Diff

331
docs/dds/api-ref/en-us_topic_0000002142831253.html
View File

File diff suppressed because it is too large Load Diff