yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
6283700aec391405f5cee993a3b429d48560972a
doc-exports/docs/dws/api-ref/SaveClusterDescriptionInfo.html
luhuayi 007dffd756 DWS API 8.5.1_20260108 version 
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com>
Co-authored-by: luhuayi <luhuayi@huawei.com>
Co-committed-by: luhuayi <luhuayi@huawei.com>
2026-03-06 08:01:27 +00:00

214 lines
17 KiB
HTML
Raw Blame History

<a name="EN-US_TOPIC_0000002532014019"></a><a name="EN-US_TOPIC_0000002532014019"></a>
<h1 class="topictitle1">Modifying Cluster Description</h1>
<div id="body8662426"><div class="section" id="EN-US_TOPIC_0000002532014019__section149455634620"><h4 class="sectiontitle">Function</h4><p id="EN-US_TOPIC_0000002532014019__p2049517569464">This API is used to modify the cluster description.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section144951563460"><h4 class="sectiontitle">Calling Method</h4><p id="EN-US_TOPIC_0000002532014019__p18495145610468">For details, see <a href="dws_02_0062.html">Calling APIs</a>.</p>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section149595694618"><h4 class="sectiontitle">URI</h4><p id="EN-US_TOPIC_0000002532014019__p54952566462">POST /v1/{project_id}/clusters/{cluster_id}/description</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014019__table949514567469" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014019__row849517561469"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="EN-US_TOPIC_0000002532014019__p11495155604614">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="EN-US_TOPIC_0000002532014019__p5496185684616">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="EN-US_TOPIC_0000002532014019__p12496656184614">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="EN-US_TOPIC_0000002532014019__p64962563467">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014019__row164951256194616"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014019__p124961556184616">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014019__p849645613468">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014019__p949635654613">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014019__p549615664611"><strong id="EN-US_TOPIC_0000002532014019__b1549619565463">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p1849645624617">Project ID. To obtain the value, see <a href="dws_02_0011.html">Obtaining a Project ID</a>.</p>
<p id="EN-US_TOPIC_0000002532014019__p149655614464"><strong id="EN-US_TOPIC_0000002532014019__b249617564462">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p2496656134615">N/A</p>
<p id="EN-US_TOPIC_0000002532014019__p7496156104615"><strong id="EN-US_TOPIC_0000002532014019__b149665614460">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p94961856174611">N/A</p>
<p id="EN-US_TOPIC_0000002532014019__p5496105617460"><strong id="EN-US_TOPIC_0000002532014019__b1149695674610">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p16496155610466">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row144952056114614"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014019__p449665624620">cluster_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014019__p20496125613466">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014019__p174972056154616">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014019__p4497135684610"><strong id="EN-US_TOPIC_0000002532014019__b1497175616463">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p17497356174617">Cluster ID. For details about how to obtain the value, see <a href="dws_02_00068.html">Obtaining the Cluster ID</a>.</p>
<p id="EN-US_TOPIC_0000002532014019__p1249785674612"><strong id="EN-US_TOPIC_0000002532014019__b2497165615463">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p24971156184611">The value must be a valid DWS cluster ID.</p>
<p id="EN-US_TOPIC_0000002532014019__p2049715614619"><strong id="EN-US_TOPIC_0000002532014019__b20497155624611">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p6497145617469">It is a 36-digit UUID.</p>
<p id="EN-US_TOPIC_0000002532014019__p17497125616461"><strong id="EN-US_TOPIC_0000002532014019__b11497135611468">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p149785619469">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014019__table4497105634617" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query Parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014019__row4497185620464"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="EN-US_TOPIC_0000002532014019__p1149845614461">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="EN-US_TOPIC_0000002532014019__p4498155616462">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="EN-US_TOPIC_0000002532014019__p184983569466">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="EN-US_TOPIC_0000002532014019__p549818561463">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014019__row124974563461"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014019__p94985562463">namespace</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014019__p1349813568468">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014019__p104982563461">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014019__p17498125654619"><strong id="EN-US_TOPIC_0000002532014019__b12498185684616">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p14981056124614">Namespace.</p>
<p id="EN-US_TOPIC_0000002532014019__p849816561463"><strong id="EN-US_TOPIC_0000002532014019__b74981456174615">Constraints</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p3498155654610">The value is fixed at <strong id="EN-US_TOPIC_0000002532014019__b0498205664611">DWS</strong>. If this parameter is left blank, the value is <strong id="EN-US_TOPIC_0000002532014019__b049845610463">DWS</strong>.</p>
<p id="EN-US_TOPIC_0000002532014019__p19498185616468"><strong id="EN-US_TOPIC_0000002532014019__b54989566462">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p549855674611">DWS</p>
<p id="EN-US_TOPIC_0000002532014019__p184989564464"><strong id="EN-US_TOPIC_0000002532014019__b1649811563462">Default Value</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p1549819565461">DWS</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section114982565466"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014019__en-us_topic_0000002341096904_request_ClusterDescriptionInfo" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014019__row349914563462"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.1"><p id="EN-US_TOPIC_0000002532014019__p149925624610">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.2"><p id="EN-US_TOPIC_0000002532014019__p4499175612464">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.2.2.5.1.3"><p id="EN-US_TOPIC_0000002532014019__p5499656104611">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.4.2.2.5.1.4"><p id="EN-US_TOPIC_0000002532014019__p349935644612">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014019__row1349910565464"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.1 "><p id="EN-US_TOPIC_0000002532014019__p249945618466">description_info</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.2 "><p id="EN-US_TOPIC_0000002532014019__p64991556114617">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.2.2.5.1.3 "><p id="EN-US_TOPIC_0000002532014019__p14499356134610">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.4.2.2.5.1.4 "><p id="EN-US_TOPIC_0000002532014019__p0499115604619"><strong id="EN-US_TOPIC_0000002532014019__b10500165615468">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p850065620463">Cluster description.</p>
<p id="EN-US_TOPIC_0000002532014019__p195001956114614"><strong id="EN-US_TOPIC_0000002532014019__b15500145654613">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p35008566467">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section9500956114613"><h4 class="sectiontitle">Response Parameters</h4><p id="EN-US_TOPIC_0000002532014019__p19500175612461"><strong id="EN-US_TOPIC_0000002532014019__b1500125644615">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014019__en-us_topic_0000002341096904_response_RdsResponse" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="EN-US_TOPIC_0000002532014019__row2050045614620"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.1"><p id="EN-US_TOPIC_0000002532014019__p35008561465">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.5.3.2.4.1.2"><p id="EN-US_TOPIC_0000002532014019__p450055617469">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.5.3.2.4.1.3"><p id="EN-US_TOPIC_0000002532014019__p450013561464">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014019__row8500456114613"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014019__p1050085611466">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014019__p2050116561468">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014019__p125011656194615"><strong id="EN-US_TOPIC_0000002532014019__b18501256194611">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p2501185613462">Error code.</p>
<p id="EN-US_TOPIC_0000002532014019__p175012563468"><strong id="EN-US_TOPIC_0000002532014019__b95017564463">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p1350117561462">N/A</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row350011569463"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.1 "><p id="EN-US_TOPIC_0000002532014019__p1550135634617">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.5.3.2.4.1.2 "><p id="EN-US_TOPIC_0000002532014019__p1150110564462">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.5.3.2.4.1.3 "><p id="EN-US_TOPIC_0000002532014019__p195011156204612"><strong id="EN-US_TOPIC_0000002532014019__b13501856154618">Definition</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p1501856144618">Error message.</p>
<p id="EN-US_TOPIC_0000002532014019__p16501145624617"><strong id="EN-US_TOPIC_0000002532014019__b150165604612">Range</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p85011756104613">N/A</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section1150155684611"><h4 class="sectiontitle">Example Requests</h4><p id="EN-US_TOPIC_0000002532014019__p1501125615467">Modify the cluster description.</p>
<pre class="screen" id="EN-US_TOPIC_0000002532014019__screen1450119564465">POST https://{Endpoint}/v1/89cd04f168b84af6be287f71730fdb4b/clusters/4ca46bf1-5c61-48ff-b4f3-0ad4e5e3ba90/description
{
"description_info" : "desc info"
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section12502105684618"><h4 class="sectiontitle">Example Responses</h4><p id="EN-US_TOPIC_0000002532014019__p14502105618464"><strong id="EN-US_TOPIC_0000002532014019__b13502656134614">Status code: 200</strong></p>
<p id="EN-US_TOPIC_0000002532014019__p145022567462">Cluster description modified.</p>
<pre class="screen" id="EN-US_TOPIC_0000002532014019__screen165021056154616">{
"error_code" : "DWS.0000",
"error_msg" : null
}</pre>
</div>
<div class="section" id="EN-US_TOPIC_0000002532014019__section17616185619469"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="EN-US_TOPIC_0000002532014019__en-us_topic_0000002341096904_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="EN-US_TOPIC_0000002532014019__row14509205664616"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.8.2.1.3.1.1"><p id="EN-US_TOPIC_0000002532014019__p66168569461">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.8.2.1.3.1.2"><p id="EN-US_TOPIC_0000002532014019__p1761635694610">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="EN-US_TOPIC_0000002532014019__row115094563467"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p1461665614462">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p176161656104616">Cluster description modified.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row135091556134614"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p4616456204619">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p1361605610463">Request error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row2509856164619"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p5616656104613">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p12616656164611">Authentication failed.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row750912567466"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p261645610469">403</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p6616185617469">You do not have required permissions.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row7509105674613"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p36169568467">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p361645624619">No resources found.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row13509185615469"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p1361675684619">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p9616956134616">Internal server error.</p>
</td>
</tr>
<tr id="EN-US_TOPIC_0000002532014019__row650915563469"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.8.2.1.3.1.1 "><p id="EN-US_TOPIC_0000002532014019__p1661645614613">503</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.8.2.1.3.1.2 "><p id="EN-US_TOPIC_0000002532014019__p16616125617469">Service unavailable.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dws_02_0017.html">Cluster Management</a></div>
</div>
</div>
View Git Blame Copy Permalink