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

dds_api_20241115

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-12-06 09:06:15 +00:00 committed by zuul
parent e0c340133f
commit c456031560
1 changed files with 21 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -35,47 +35,47 @@
</li></ul> </li></ul>
</div> </div>
<div class="section" id="dds_api_0120__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0120__ul5099287616954"><li id="dds_api_0120__li5628270116954">Parameter description <div class="section" id="dds_api_0120__section3074340117316"><h4 class="sectiontitle">Requests</h4><ul id="dds_api_0120__ul5099287616954"><li id="dds_api_0120__li5628270116954">Parameter description
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0120__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0120__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="17.169999999999998%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0120__p1204887716954">Name</p> <div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dds_api_0120__table3678226816954" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dds_api_0120__row1340482316954"><th align="left" class="cellrowborder" valign="top" width="19%" id="mcps1.3.4.2.1.1.2.5.1.1"><p id="dds_api_0120__p1204887716954">Name</p>
</th> </th>
<th align="left" class="cellrowborder" valign="top" width="17.75%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0120__p15184124818564">Mandatory</p> <th align="left" class="cellrowborder" valign="top" width="17.73%" id="mcps1.3.4.2.1.1.2.5.1.2"><p id="dds_api_0120__p3643495116954">Type</p>
</th> </th>
<th align="left" class="cellrowborder" valign="top" width="21.6%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0120__p3643495116954">Type</p> <th align="left" class="cellrowborder" valign="top" width="15.17%" id="mcps1.3.4.2.1.1.2.5.1.3"><p id="dds_api_0120__p1680261613614">Mandatory</p>
</th> </th>
<th align="left" class="cellrowborder" valign="top" width="43.480000000000004%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0120__p222501215320">Description</p> <th align="left" class="cellrowborder" valign="top" width="48.1%" id="mcps1.3.4.2.1.1.2.5.1.4"><p id="dds_api_0120__p222501215320">Description</p>
</th> </th>
</tr> </tr>
</thead> </thead>
<tbody><tr id="dds_api_0120__row794180116954"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0120__p37323919416">type</p> <tbody><tr id="dds_api_0120__row794180116954"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0120__p37323919416">type</p>
</td> </td>
<td class="cellrowborder" valign="top" width="17.75%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0120__p107333911419">Yes</p> <td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0120__p18748396418">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0120__p18748396418">String</p> <td class="cellrowborder" valign="top" width="15.17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0120__p88026168367">Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="43.480000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0120__p395118110297">Specifies the type of the object for which the IP address is to be enabled.</p> <td class="cellrowborder" valign="top" width="48.1%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0120__p9144133716104">Cluster instance type.</p>
<ul id="dds_api_0120__ul1749444819162"><li id="dds_api_0120__li194954486165">To enable IP addresses for shard nodes, set the value to <strong id="dds_api_0120__b106141522192816">shard</strong>.</li><li id="dds_api_0120__li12495154821611">To enable IP addresses for config nodes, set the value to <strong id="dds_api_0120__b16777125364620">config</strong>.</li></ul> <ul id="dds_api_0120__ul11484131082718"><li id="dds_api_0120__li1748481016275">When applying for a shard IP address, set the value to <strong id="dds_api_0120__b193189494159">shard</strong>. A read-only user <strong id="dds_api_0120__b169138815165">sharduser</strong> is automatically created for the shard group. (Each shard group has a read-only user with the same name.)</li></ul>
<ul id="dds_api_0120__ul1749444819162"><li id="dds_api_0120__li1068112552717">When applying for a config IP address, set the value to <strong id="dds_api_0120__b498716146205">config</strong>. A read-only user <strong id="dds_api_0120__b1918732292014">csuser</strong> is automatically created for the config group.</li></ul>
</td> </td>
</tr> </tr>
<tr id="dds_api_0120__row375935052813"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0120__p276045013289">target_id</p> <tr id="dds_api_0120__row375935052813"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0120__p276045013289">target_id</p>
</td> </td>
<td class="cellrowborder" valign="top" width="17.75%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0120__p876005042813">No</p> <td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0120__p157607501285">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0120__p157607501285">String</p> <td class="cellrowborder" valign="top" width="15.17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0120__p6802516113612">No</p>
</td> </td>
<td class="cellrowborder" valign="top" width="43.480000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0120__p464310229295">Specifies the ID of the group whose IP addresses are to be enabled.</p> <td class="cellrowborder" valign="top" width="48.1%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0120__p3322344192017">Shard group ID.</p>
<ul id="dds_api_0120__ul1331113227171"><li id="dds_api_0120__li1631152281720">For shard nodes, the value is the shard ID.</li><li id="dds_api_0120__li93111224174">For config nodes, the value is the config ID.</li><li id="dds_api_0120__li1731102231715">If this parameter is left blank, enable all IP addresses of the same node type in the instance.</li></ul> <div class="caution" id="dds_api_0120__note8782147101710"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><ul id="dds_api_0120__ul8279154252715"><li id="dds_api_0120__li7279144217274">If you apply for a shard or config IP address for the first time, this parameter is not specified. You can apply for an IP address for all shard groups using the same password and create a read-only user <strong id="dds_api_0120__b94851016182219">sharduser</strong>.</li><li id="dds_api_0120__li72792042142716">In node scale-out scenarios, the system does not automatically apply for an IP address and read-only user <strong id="dds_api_0120__b1712805422313">sharduser</strong> for the new shard group because there is no <strong id="dds_api_0120__b10833165192417">sharduser</strong> user and password of other shard groups. If you need to apply for an IP address for the new shard group, call this API and specify <strong id="dds_api_0120__b032019832518">target_id</strong> (group ID).</li><li id="dds_api_0120__li1279104292716">If this API is called for multiple times for the same DB instance, the values for the <strong id="dds_api_0120__b4977173742615">password</strong> field can be different. (Each shard group has a read-only user with the same name.)</li></ul>
<div class="caution" id="dds_api_0120__note8782147101710"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><ul id="dds_api_0120__ul59769186189"><li id="dds_api_0120__li997651821820">If the IP address is enabled for the first time, leave this parameter empty.</li><li id="dds_api_0120__li119768188186">If the IP address is enabled, this parameter cannot be delivered repeatedly.</li></ul>
</div></div> </div></div>
</td> </td>
</tr> </tr>
<tr id="dds_api_0120__row8551715205814"><td class="cellrowborder" valign="top" width="17.169999999999998%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0120__p18744391445">password</p> <tr id="dds_api_0120__row8551715205814"><td class="cellrowborder" valign="top" width="19%" headers="mcps1.3.4.2.1.1.2.5.1.1 "><p id="dds_api_0120__p18744391445">password</p>
</td> </td>
<td class="cellrowborder" valign="top" width="17.75%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0120__p18743391446">Yes</p> <td class="cellrowborder" valign="top" width="17.73%" headers="mcps1.3.4.2.1.1.2.5.1.2 "><p id="dds_api_0120__p374439545">String</p>
</td> </td>
<td class="cellrowborder" valign="top" width="21.6%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0120__p374439545">String</p> <td class="cellrowborder" valign="top" width="15.17%" headers="mcps1.3.4.2.1.1.2.5.1.3 "><p id="dds_api_0120__p148021216143620">Yes</p>
</td> </td>
<td class="cellrowborder" valign="top" width="43.480000000000004%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0120__p17749394417">Specifies the password for enabling this function for a cluster.</p> <td class="cellrowborder" valign="top" width="48.1%" headers="mcps1.3.4.2.1.1.2.5.1.4 "><p id="dds_api_0120__p17749394417">The password for enabling this function for a cluster.</p>
<ul id="dds_api_0120__ul51929218214"><li id="dds_api_0120__li1119282192113">The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?</li><li id="dds_api_0120__li685612512115">Enter a strong password to improve security, preventing security risks such as brute force cracking.</li></ul> <ul id="dds_api_0120__ul51929218214"><li id="dds_api_0120__li1119282192113">The value must be 8 to 32 characters in length and contain uppercase letters (A to Z), lowercase letters (a to z), digits (0 to 9), and special characters, such as ~!@#%^*-_=+?()$</li><li id="dds_api_0120__li685612512115">Enter a strong password to improve security, preventing security risks such as brute force cracking.</li></ul>
<div class="caution" id="dds_api_0120__note442401812195"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="dds_api_0120__p11936627141911">This password cannot be changed. Exercise caution when performing this operation.</p> <div class="caution" id="dds_api_0120__note442401812195"><span class="cautiontitle"> CAUTION: </span><div class="cautionbody"><p id="dds_api_0120__p11936627141911">The password can be changed by calling the API for changing a database user password. After the API for changing a database user password is called, the passwords of the read-only user <strong id="dds_api_0120__b43861578283">sharduser</strong> of all shard groups are the same when <strong id="dds_api_0120__b15647191711293">target_id</strong> is specified.</p>
</div></div> </div></div>
</td> </td>
</tr> </tr>