vpruthi/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
doc-exports/docs/dcs/api-ref/dcs-api-0312004.html
Chen, Junjie 5e34f6ce26 DCS API-REF Initial Version 
Reviewed-by: Hasko, Vladimir <vladimir.hasko@t-systems.com>
Co-authored-by: Chen, Junjie <chenjunjie@huawei.com>
Co-committed-by: Chen, Junjie <chenjunjie@huawei.com>
2022-12-09 16:44:56 +00:00

535 lines
50 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<a name="dcs-api-0312004"></a><a name="dcs-api-0312004"></a>
<h1 class="topictitle1">Creating a DCS Instance</h1>
<div id="body18958859"><div class="section" id="dcs-api-0312004__section682614592540"><h4 class="sectiontitle">Function</h4><p id="dcs-api-0312004__p526731264513">This API is used to create a DCS instance.</p>
<div class="note" id="dcs-api-0312004__note1133581915500"><img src="public_sys-resources/note_3.0-en-us.png"><span class="notetitle"> </span><div class="notebody"><p id="dcs-api-0312004__p1333612193509">The system automatically schedules the task every 3 minutes for checking whether resources are available or sold out.</p>
</div></div>
</div>
<div class="section" id="dcs-api-0312004__section9829541131515"><h4 class="sectiontitle">URI</h4><p id="dcs-api-0312004__p18585173614112">POST /v1.0/{project_id}/instances</p>
<div class="p" id="dcs-api-0312004__p1151114893212"><a href="#dcs-api-0312004__table9695164612327">Table 1</a> describes the parameter.
<div class="tablenoborder"><a name="dcs-api-0312004__table9695164612327"></a><a name="table9695164612327"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table9695164612327" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312004__row176956462329"><th align="left" class="cellrowborder" valign="top" width="16%" id="mcps1.3.2.3.2.2.5.1.1"><p id="dcs-api-0312004__p46951546183217">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="13%" id="mcps1.3.2.3.2.2.5.1.2"><p id="dcs-api-0312004__p8695446203210">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="12%" id="mcps1.3.2.3.2.2.5.1.3"><p id="dcs-api-0312004__p146952046193210">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="59%" id="mcps1.3.2.3.2.2.5.1.4"><p id="dcs-api-0312004__p36951046133215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row869515462329"><td class="cellrowborder" valign="top" width="16%" headers="mcps1.3.2.3.2.2.5.1.1 "><p id="dcs-api-0312004__p106951046173211">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="13%" headers="mcps1.3.2.3.2.2.5.1.2 "><p id="dcs-api-0312004__p15695154673220">String</p>
</td>
<td class="cellrowborder" valign="top" width="12%" headers="mcps1.3.2.3.2.2.5.1.3 "><p id="dcs-api-0312004__p969584618324">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="59%" headers="mcps1.3.2.3.2.2.5.1.4 "><p id="dcs-api-0312004__p1069534620323">Project ID. For details on how to obtain the value of this parameter, see <a href="dcs-api-0312045.html">Obtaining a Project ID</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="section" id="dcs-api-0312004__section4413221154412"><h4 class="sectiontitle">Request</h4><p id="dcs-api-0312004__p4276193614478"><strong id="dcs-api-0312004__b1478312171918">Request parameters</strong></p>
<p id="dcs-api-0312004__p1469192913338"><a href="#dcs-api-0312004__table56761820495">Table 2</a> describes the request parameters.</p>
<div class="tablenoborder"><a name="dcs-api-0312004__table56761820495"></a><a name="table56761820495"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table56761820495" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312004__row767692019916"><th align="left" class="cellrowborder" valign="top" width="16.03%" id="mcps1.3.3.4.2.5.1.1"><p id="dcs-api-0312004__p136764201394">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11.97%" id="mcps1.3.3.4.2.5.1.2"><p id="dcs-api-0312004__p146767206920">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="11%" id="mcps1.3.3.4.2.5.1.3"><p id="dcs-api-0312004__p5676102012919">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="61%" id="mcps1.3.3.4.2.5.1.4"><p id="dcs-api-0312004__p167618205920">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row967613201092"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p1867602012910">name</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p56761920897">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p156764208911">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p3676820399">DCS instance name.</p>
<p id="dcs-api-0312004__p5676152019920">An instance name can contain 4 to 64 characters and must start with a letter. Only letters, digits, underscores (_), and hyphens (-) are allowed.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row1067662016917"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p176763204917">description</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p16676020895">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p106763201696">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p56765201093">Brief description of the DCS instance.</p>
<p id="dcs-api-0312004__p1967617201791">The description supports up to 1024 characters.</p>
<div class="note" id="dcs-api-0312004__note1596631183315"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dcs-api-0312004__p396621183310">The backslash (\) and quotation mark (") are special characters for JSON messages. When using these characters in a parameter value, add the escape character (\) before the characters, for example, <strong id="dcs-api-0312004__b65561430311">\\</strong> and <strong id="dcs-api-0312004__b35575315313">\"</strong>.</p>
</div></div>
</td>
</tr>
<tr id="dcs-api-0312004__row2676112013913"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p96778207918">engine</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p12677320092">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p1567715205914">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p118507184116">Cache engine. Value: <strong id="dcs-api-0312004__b19983261307">Redis</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row196776201292"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p667710200919">engine_version</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1167714202919">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p4173155412212">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p1677120998">Cache engine version. If the cache engine is Redis, the value can be <strong id="dcs-api-0312004__b347112615112">3.0</strong>, <strong id="dcs-api-0312004__b14171311113">4.0</strong>, or <strong id="dcs-api-0312004__b12338220184">5.0</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row381412493219"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p12631132714611">spec_code</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p132391951151516">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p14352135434710">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p1587133575719">DCS instance specification code.</p>
<p id="dcs-api-0312004__p134613408221">To obtain the value, go to the instance creation page on the DCS console, and view <strong id="dcs-api-0312004__b1396733201211">Flavor Name</strong> in the <strong id="dcs-api-0312004__b16536174112129">Instance Specification</strong> table.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row567713208916"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p18677112016917">capacity</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1767718205917">Float</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p867782020912">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p673914475498">Cache capacity. Unit: GB.</p>
<ul id="dcs-api-0312004__ul2084493514411"><li id="dcs-api-0312004__li484411353414">For a single-node or master/standby DCS Redis 3.0 instance, the value can be <strong id="dcs-api-0312004__b296014612489">2</strong>, <strong id="dcs-api-0312004__b1964714487487">4</strong>, <strong id="dcs-api-0312004__b11271135113486">8</strong>, <strong id="dcs-api-0312004__b1355315536483">16</strong>, <strong id="dcs-api-0312004__b960015614480">32</strong>, or <strong id="dcs-api-0312004__b1241316018490">64</strong>. For a Proxy Cluster DCS Redis 3.0 instance, the value can be <strong id="dcs-api-0312004__b6490655125215">64</strong>, <strong id="dcs-api-0312004__b15496655185220">128</strong>, <strong id="dcs-api-0312004__b749695545211">256</strong>, <strong id="dcs-api-0312004__b1149695535210">512</strong>, or <strong id="dcs-api-0312004__b24961455165218">1024</strong>.</li><li id="dcs-api-0312004__li20202193964313">For a single-node or master/standby DCS Redis 4.0 or 5.0 instance, the value can be <strong id="dcs-api-0312004__b91872521320">0.125</strong>, <strong id="dcs-api-0312004__b119395273218">0.25</strong>, <strong id="dcs-api-0312004__b31933524326">0.5</strong>, <strong id="dcs-api-0312004__b16194135211324">1</strong>, <strong id="dcs-api-0312004__b11194052113219">2</strong>, <strong id="dcs-api-0312004__b41946521324">4</strong>, <strong id="dcs-api-0312004__b9194652113212">8</strong>, <strong id="dcs-api-0312004__b41951552183214">16</strong>, <strong id="dcs-api-0312004__b619505215324">32</strong>, <strong id="dcs-api-0312004__b81812218338">24</strong>, <strong id="dcs-api-0312004__b718432463313">48</strong>, or <strong id="dcs-api-0312004__b7195105283212">64</strong>. For a Redis Cluster DCS Redis 4.0 or 5.0 instance, the value can be <strong id="dcs-api-0312004__b5131122710557">4</strong>, <strong id="dcs-api-0312004__b1613122755515">8</strong>, <strong id="dcs-api-0312004__b513118277552">16</strong>, <strong id="dcs-api-0312004__b18132527185516">24</strong>, <strong id="dcs-api-0312004__b171321227145512">32</strong>, <strong id="dcs-api-0312004__b213262713557">48</strong>, <strong id="dcs-api-0312004__b14132527105516">64</strong>, <strong id="dcs-api-0312004__b113232725516">96</strong>, <strong id="dcs-api-0312004__b20132627135516">128</strong>, <strong id="dcs-api-0312004__b31339278553">192</strong>, <strong id="dcs-api-0312004__b113332755512">256</strong>, <strong id="dcs-api-0312004__b1113312715515">384</strong>, <strong id="dcs-api-0312004__b1613372725513">512</strong>, <strong id="dcs-api-0312004__b9133162713556">768</strong>, or <strong id="dcs-api-0312004__b31341727195516">1024</strong>.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row185724916558"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p135072527557">no_password_access</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1251075235514">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p16515175245516">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p20518125213556">An indicator of whether a DCS instance can be accessed in password-free mode.</p>
<ul id="dcs-api-0312004__ul11520052145520"><li id="dcs-api-0312004__li15218525559"><strong id="dcs-api-0312004__b1272134753020">true</strong>: indicates that a DCS instance can be accessed without a password.</li><li id="dcs-api-0312004__li1525145212554"><strong id="dcs-api-0312004__b133205615301">false</strong>: indicates that a DCS instance can be accessed only after password authentication.</li></ul>
<p id="dcs-api-0312004__p152914529555">Default value: <strong id="dcs-api-0312004__b1163118183119">false</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row1067715208919"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p196778201791">password</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p46771620993">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p467710201891">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p19677120192">Password of a DCS instance.</p>
<div class="note" id="dcs-api-0312004__note8639182372618"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dcs-api-0312004__p14640112382613">If <strong id="dcs-api-0312004__b1378217520105935">no_password_access</strong> is set to <strong id="dcs-api-0312004__b1350289402105935">false</strong> or not set, the request must contain the <strong id="dcs-api-0312004__b1648788789105935">password </strong>parameter.</p>
</div></div>
<p id="dcs-api-0312004__p166770201896">The password of a DCS Redis instance must meet the following complexity requirements:</p>
<ul id="dcs-api-0312004__ul17145137175920"><li id="dcs-api-0312004__li6893959171311">Must be a string consisting of 8 to 32 characters.</li><li id="dcs-api-0312004__li490917347117">Must be different from the old password.</li><li id="dcs-api-0312004__li214553716597">Contains at least three of the following character types:<ul id="dcs-api-0312004__ul81451373599"><li id="dcs-api-0312004__li6145173705911">Lowercase letters</li><li id="dcs-api-0312004__li111451371598">Uppercase letters</li><li id="dcs-api-0312004__li1314519370594">Digits</li><li id="dcs-api-0312004__li0145133711599">Special characters (`~!@#$^&amp;*()-_=+\|{}:,&lt;.&gt;/?)</li></ul>
</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row567822010919"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p1867819201894">vpc_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p96788203916">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p66781520294">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p1714261924017">VPC ID.</p>
<p id="dcs-api-0312004__p16517143816118">Obtain the value by using either of the following methods:</p>
<ul id="dcs-api-0312004__ul887913435377"><li id="dcs-api-0312004__li1288004343711">Method 1: Log in to VPC console and view the VPC ID in the VPC details.</li><li id="dcs-api-0312004__li1632175415209">Method 2: Call the API for querying VPCs. For details, see the "Querying VPCs" section in the <em id="dcs-api-0312004__i646410268406">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row06787201920"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p136781201391">security_group_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p56781204916">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p12678120893">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p8364103564013">ID of the security group which the instance belongs to.</p>
<p id="dcs-api-0312004__p326554122315">This parameter is mandatory when the <strong id="dcs-api-0312004__b697511204139">engine</strong> is <strong id="dcs-api-0312004__b14981123101310">Redis</strong> and <strong id="dcs-api-0312004__b84356274138">engine_version</strong> is <strong id="dcs-api-0312004__b1466914313134">3.0</strong>. DCS Redis 3.0 instances support security group access control.</p>
<p id="dcs-api-0312004__p202651941102318">This parameter is optional when the <strong id="dcs-api-0312004__b56551658121315">engine</strong> is <strong id="dcs-api-0312004__b1596615010144">Redis</strong> and <strong id="dcs-api-0312004__b86678415142">engine_version</strong> is <strong id="dcs-api-0312004__b9207171081420">4.0</strong> or <strong id="dcs-api-0312004__b11833201317142">5.0</strong>. DCS Redis 4.0 and 5.0 instances do not support security groups.</p>
<p id="dcs-api-0312004__p1012535151112">Obtain the value by using either of the following methods:</p>
<ul id="dcs-api-0312004__ul1822354122210"><li id="dcs-api-0312004__li11469181022217">Method 1: Log in to the VPC console and view the security group ID on the security group details page.</li><li id="dcs-api-0312004__li1044377172219">Method 2: Call the API for querying security groups. For details, see the "Querying Security Groups" section in the <em id="dcs-api-0312004__i22631413204611">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row867815209918"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p166787201395">subnet_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p3678102018911">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p17678132019910">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p6957182201210">Network ID of the subnet.</p>
<p id="dcs-api-0312004__p394819577568">Obtain the value by using either of the following methods:</p>
<ul id="dcs-api-0312004__ul54643814416"><li id="dcs-api-0312004__li104641887440">Method 1: Log in to VPC console and click the target subnet on the <strong id="dcs-api-0312004__b13891917475">Subnets</strong> tab page. You can view the network ID on the displayed page.</li><li id="dcs-api-0312004__li769655192312">Method 2: Call the API for querying subnets. For details, see the "Querying Subnets" section in the <em id="dcs-api-0312004__i8176124810475">Virtual Private Cloud API Reference</em>.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row06786202098"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p46783201913">available_zones</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1567815202918">Array</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p567815201913">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p12678420696">ID of the AZ where the cache node resides and which has available resources. For details on how to obtain the value, see <a href="dcs-api-0312039.html">Querying AZ Information</a>. Check whether the AZ has available resources.</p>
<p id="dcs-api-0312004__p225014516299">Master/Standby, Proxy Cluster, and Redis Cluster DCS instances support cross-AZ deployment. You can specify an AZ for the standby node. When specifying AZs for nodes, use commas (,) to separate multiple AZs. For details, see the example request.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row11291932133811"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p114171033193818">product_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p24171633123817">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p1541713330384">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p84171833183816">ID of the product that can be created. For details, see <a href="dcs-api-0312040.html">Querying Service Specifications</a>.</p>
<p id="dcs-api-0312004__p1779643117592">The parameter value is in the format of <strong id="dcs-api-0312004__b12391454575"><em id="dcs-api-0312004__i63418515713">spec_code</em></strong><strong id="dcs-api-0312004__b4391759577">-</strong><strong id="dcs-api-0312004__b5409595712"><em id="dcs-api-0312004__i3409518574">Abbreviation of the billing mode</em></strong>. The abbreviation of the billing mode can only be <strong id="dcs-api-0312004__b17417535711">h</strong>, indicating pay-per-use.</p>
<p id="dcs-api-0312004__p164861825124619">For example, <strong id="dcs-api-0312004__b11943322173">redis.single.au1.large.1-h</strong> indicates a pay-per-use product whose specification code is redis.single.au1.large.1.</p>
<div class="note" id="dcs-api-0312004__note11537112105414"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dcs-api-0312004__p17537926543">When obtaining the product ID from the product specifications, ensure that the billing mode specified in the product ID is the same as the selected billing mode. For example, to buy a master/standby DCS Redis 3.0 instance billed in pay-per-use mode, you can search for the product ID corresponding to the record whose <strong id="dcs-api-0312004__b05121953101914">charging_type</strong> is <strong id="dcs-api-0312004__b2593105515192">Hourly</strong> and <strong id="dcs-api-0312004__b5973145861914">spec_code</strong> is <strong id="dcs-api-0312004__b02479452012">dcs.master_standby</strong> in the response message.</p>
</div></div>
</td>
</tr>
<tr id="dcs-api-0312004__row2140102716120"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p978093871216">instance_backup_policy</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p167801738191210">Object</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p8780143810122">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p2272337113029">Backup policy.</p>
<p id="dcs-api-0312004__p792195523714">This parameter is available for master/standby and cluster DCS instances. For details, see <a href="#dcs-api-0312004__table12803218151513">Table 3</a> and <a href="#dcs-api-0312004__table187492037201518">Table 4</a>.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row13628194618352"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p1121115310355">enable_publicip</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p221185383513">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p7215534359">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p182295373513">An indicator of whether to enable public access for a DCS Redis instance.</p>
<ul id="dcs-api-0312004__ul82218539359"><li id="dcs-api-0312004__li162255316357"><strong id="dcs-api-0312004__b101676359358">true</strong>: enable.</li><li id="dcs-api-0312004__li22215353515"><strong id="dcs-api-0312004__b90183209811348">false</strong>: disable.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row763018464351"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p922155316356">publicip_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p32215310353">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p202295312353">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p72212532358">ID of the elastic IP address bound to a DCS Redis instance.</p>
<p id="dcs-api-0312004__p52245313512">This parameter is mandatory if public access is enabled (that is, <strong id="dcs-api-0312004__b1534819416362">enable_publicip</strong> is set to <strong id="dcs-api-0312004__b534818493611">true</strong>).</p>
</td>
</tr>
<tr id="dcs-api-0312004__row714730165810"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p20552036165812">enable_ssl</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p11552173618588">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p1855263625817">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p125521036125811">An indicator of whether to enable SSL for public access to a DCS Redis instance.</p>
<ul id="dcs-api-0312004__ul55521036185811"><li id="dcs-api-0312004__li055253620588"><strong id="dcs-api-0312004__b311851616915">true</strong>: enable.</li><li id="dcs-api-0312004__li17552113695817"><strong id="dcs-api-0312004__b2076121213912">false</strong>: disable.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row446514164101"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p153381228151014">maintain_begin</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p333802819109">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p33381928111020">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p66508317113020">Time at which the maintenance time window starts.</p>
<p id="dcs-api-0312004__p592955153710">Format: hh:mm:ss.</p>
<ul id="dcs-api-0312004__ul933802881010"><li id="dcs-api-0312004__li16536230112213">The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see <a href="dcs-api-0312041.html">Querying Maintenance Time Window</a>.</li><li id="dcs-api-0312004__li14839240516">The start time must be set to 22:00:00, 02:00:00, 06:00:00, 10:00:00, 14:00:00, or 18:00: 00.</li><li id="dcs-api-0312004__li933892819104">Parameters <strong id="dcs-api-0312004__b49724934112956">maintain_begin</strong> and <strong id="dcs-api-0312004__b9280265112956">maintain_end</strong> must be set in pairs. If parameter <strong id="dcs-api-0312004__b24779050112956">maintain_start</strong> is left blank, parameter <strong id="dcs-api-0312004__b48544017112956">maintain_end</strong> is also blank. In this case, the system automatically set the start time to 02:00:00.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row19206161741015"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p17338728191013">maintain_end</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p7338152871019">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p63381628181015">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p23447854112852">Time at which the maintenance time window ends.</p>
<p id="dcs-api-0312004__p49215520376">Format: hh:mm:ss.</p>
<ul id="dcs-api-0312004__ul115091720122312"><li id="dcs-api-0312004__li75099200235">The start time and end time of the maintenance time window must indicate the time segment of a supported maintenance time window. For details on how to query the time segments of supported maintenance time windows, see <a href="dcs-api-0312041.html">Querying Maintenance Time Window</a>.</li></ul>
<ul id="dcs-api-0312004__ul93398285106"><li id="dcs-api-0312004__li6525231183513">The end time is four hours later than the start time. For example, if the start time is 22:00:00, the end time is 02:00:00.</li><li id="dcs-api-0312004__li173391128101019">Parameters <strong id="dcs-api-0312004__b2895140619279">maintain_begin</strong> and <strong id="dcs-api-0312004__b56137128192715">maintain_end</strong> must be set in pairs. If parameter <strong id="dcs-api-0312004__b170435649711552">maintain_end</strong> is left blank, parameter <strong id="dcs-api-0312004__b5799758011552">maintain_start</strong> is also blank. In this case, the system automatically set the end time to 06:00:00.</li></ul>
</td>
</tr>
<tr id="dcs-api-0312004__row19550187283"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p285817238284">enterprise_project_id</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p885813233284">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p19858172316283">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p185862316286">Enterprise project ID.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row0190162020288"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p14858132317287">enterprise_project_name</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p18581723192812">String</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p15858323122815">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p15858723122813">Enterprise project name.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row141711196595"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p341991912598">instance_num</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1641961911592">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p17419191965910">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p6939121921111">Number of instances to be created in batches. </p>
<p id="dcs-api-0312004__p82743811711">Default value: <strong id="dcs-api-0312004__b115851023155118">1</strong>.</p>
<p id="dcs-api-0312004__p1864253934219">Value range: 1–100.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row1555011241303"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p105521524143017">private_ips</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1132514544307">Array of strings</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p17330165413011">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p0150340526">IP address that is manually specified for a DCS instance.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row0887135310177"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p20889653141719">port</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p1188914539175">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p16889195371710">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p888916531172">Port customization, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 instances.</p>
<p id="dcs-api-0312004__p8719132713197">If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, the default port 6379 will be used. To customize a port, specify a port number in the range from 1 to 65535.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row167036820511"><td class="cellrowborder" valign="top" width="16.03%" headers="mcps1.3.3.4.2.5.1.1 "><p id="dcs-api-0312004__p1704983512">rename_commands</p>
</td>
<td class="cellrowborder" valign="top" width="11.97%" headers="mcps1.3.3.4.2.5.1.2 "><p id="dcs-api-0312004__p37055820516">Object</p>
</td>
<td class="cellrowborder" valign="top" width="11%" headers="mcps1.3.3.4.2.5.1.3 "><p id="dcs-api-0312004__p19705781758">No</p>
</td>
<td class="cellrowborder" valign="top" width="61%" headers="mcps1.3.3.4.2.5.1.4 "><p id="dcs-api-0312004__p15705681852">Critical command renaming, which is supported only by Redis 4.0 and Redis 5.0 instances and not by Redis 3.0 instances.</p>
<p id="dcs-api-0312004__p131517211479">If this parameter is not sent or is left empty when you create a Redis 4.0 or 5.0 instance, no critical command will be renamed. Currently, only <strong id="dcs-api-0312004__b1170015489558">COMMAND</strong>, <strong id="dcs-api-0312004__b157421249105512">KEYS</strong>, <strong id="dcs-api-0312004__b2679750105511">FLUSHDB</strong>, <strong id="dcs-api-0312004__b619742135516">FLUSHALL</strong>, and <strong id="dcs-api-0312004__b14900247115514">HGETALL</strong> commands can be renamed.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0312004__table12803218151513"></a><a name="table12803218151513"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table12803218151513" frame="border" border="1" rules="all"><caption><b>Table 3 </b>instance_backup_policy parameter description</caption><thead align="left"><tr id="dcs-api-0312004__row480331810159"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.5.2.5.1.1"><p id="dcs-api-0312004__p0803161819151">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.5.2.5.1.2"><p id="dcs-api-0312004__p158036184154">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.5.2.5.1.3"><p id="dcs-api-0312004__p9803181831519">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.3.5.2.5.1.4"><p id="dcs-api-0312004__p1080331819151">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row17803111817158"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.5.2.5.1.1 "><p id="dcs-api-0312004__p980301811156">save_days</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.5.2.5.1.2 "><p id="dcs-api-0312004__p280371861517">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.3 "><p id="dcs-api-0312004__p1280314189158">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.5.2.5.1.4 "><p id="dcs-api-0312004__p17241358195819">This parameter is mandatory when <strong id="dcs-api-0312004__b8774547135611">backup_type</strong> is set to <strong id="dcs-api-0312004__b54014490562">manual</strong>.</p>
<p id="dcs-api-0312004__p22191059113319">Retention period.</p>
<p id="dcs-api-0312004__p49596891113321">Unit: day.</p>
<p id="dcs-api-0312004__p992125513371">Value range: 1–7.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row58032184158"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.5.2.5.1.1 "><p id="dcs-api-0312004__p15803318161514">backup_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.5.2.5.1.2 "><p id="dcs-api-0312004__p780331841519">String</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.3 "><p id="dcs-api-0312004__p208031918181519">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.5.2.5.1.4 "><p id="dcs-api-0312004__p12864080113327">Backup type.</p>
<p id="dcs-api-0312004__p99265519371">Options:</p>
<ul id="dcs-api-0312004__ul14413194210318"><li id="dcs-api-0312004__li753214539314"><strong id="dcs-api-0312004__b9279681151187">auto</strong>: automatic backup.</li><li id="dcs-api-0312004__li134137427315"><strong id="dcs-api-0312004__b16009788721189">manual</strong>: manual backup.</li></ul>
<p id="dcs-api-0312004__p1531835311579">The default value is <strong id="dcs-api-0312004__b61131248175510">manual</strong>.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row58041218181519"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.5.2.5.1.1 "><p id="dcs-api-0312004__p780421841517">periodical_backup_plan</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.5.2.5.1.2 "><p id="dcs-api-0312004__p11804718151519">Object</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.5.2.5.1.3 "><p id="dcs-api-0312004__p1880411821511">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.5.2.5.1.4 "><p id="dcs-api-0312004__p7804101841518">Backup plan. For details, see <a href="#dcs-api-0312004__table187492037201518">Table 4</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="dcs-api-0312004__table187492037201518"></a><a name="table187492037201518"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table187492037201518" frame="border" border="1" rules="all"><caption><b>Table 4 </b>periodical_backup_plan parameter description</caption><thead align="left"><tr id="dcs-api-0312004__row175053717158"><th align="left" class="cellrowborder" valign="top" width="21%" id="mcps1.3.3.6.2.5.1.1"><p id="dcs-api-0312004__p1675013701519">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="14.000000000000002%" id="mcps1.3.3.6.2.5.1.2"><p id="dcs-api-0312004__p18750183701514">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="10%" id="mcps1.3.3.6.2.5.1.3"><p id="dcs-api-0312004__p57501737181518">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="55.00000000000001%" id="mcps1.3.3.6.2.5.1.4"><p id="dcs-api-0312004__p87501837171512">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row157502377156"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.6.2.5.1.1 "><p id="dcs-api-0312004__p117508371150">begin_at</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.6.2.5.1.2 "><p id="dcs-api-0312004__p275013377150">String</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.3 "><p id="dcs-api-0312004__p6750133711151">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.6.2.5.1.4 "><p id="dcs-api-0312004__p54598221113351">Time at which backup starts.</p>
<p id="dcs-api-0312004__p1892145513720">"00:00-01:00" indicates that backup starts at 00:00:00.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row1975013375150"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.6.2.5.1.1 "><p id="dcs-api-0312004__p13750193791519">period_type</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.6.2.5.1.2 "><p id="dcs-api-0312004__p7750133741511">String</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.3 "><p id="dcs-api-0312004__p1075017376159">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.6.2.5.1.4 "><p id="dcs-api-0312004__p63545920113358">Interval at which backup is performed.</p>
<p id="dcs-api-0312004__p1892175583714">Currently, only weekly backup is supported.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row18750133715157"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.6.2.5.1.1 "><p id="dcs-api-0312004__p875112377151">backup_at</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.6.2.5.1.2 "><p id="dcs-api-0312004__p97511037161518">Array</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.3 "><p id="dcs-api-0312004__p18751437171510">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.6.2.5.1.4 "><p id="dcs-api-0312004__p4628573511344">Day in a week on which backup starts.</p>
<p id="dcs-api-0312004__p109218555379">Value range: 1–7, where <strong id="dcs-api-0312004__b174365572167">1</strong> indicates Monday and <strong id="dcs-api-0312004__b1915802111718">7</strong> indicates Sunday.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row19127254193019"><td class="cellrowborder" valign="top" width="21%" headers="mcps1.3.3.6.2.5.1.1 "><p id="dcs-api-0312004__p191281954163019">timezone_offset</p>
</td>
<td class="cellrowborder" valign="top" width="14.000000000000002%" headers="mcps1.3.3.6.2.5.1.2 "><p id="dcs-api-0312004__p3437103311324">String</p>
</td>
<td class="cellrowborder" valign="top" width="10%" headers="mcps1.3.3.6.2.5.1.3 "><p id="dcs-api-0312004__p1612913542306">No</p>
</td>
<td class="cellrowborder" valign="top" width="55.00000000000001%" headers="mcps1.3.3.6.2.5.1.4 "><p id="dcs-api-0312004__p25829183113412">Time zone in which backup is performed.</p>
<p id="dcs-api-0312004__p1592255153710">Value range: GMT–12:00 to GMT+12:00. If this parameter is left blank, the current time zone of the DCS-Server VM is used by default.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="dcs-api-0312004__p493213764815"><strong id="dcs-api-0312004__b7300115283913">Example request</strong></p>
<ul id="dcs-api-0312004__ul1273562161214"><li id="dcs-api-0312004__li10735821151220">Request URL:<pre class="screen" id="dcs-api-0312004__screen199501621124914">POST https://{dcs_endpoint}/v1.0/{project_id}/instances</pre>
</li></ul>
<ul id="dcs-api-0312004__ul564316282198"><li id="dcs-api-0312004__li1664392811918">Example:<div class="p" id="dcs-api-0312004__p18629131710513"><a name="dcs-api-0312004__li1664392811918"></a><a name="li1664392811918"></a><strong id="dcs-api-0312004__b11443138102810">Creating a DCS Redis instance</strong><pre class="screen" id="dcs-api-0312004__screen105371415125116">{
"name": "dcs-APITest",
"description": "Test",
"engine": "Redis",
"engine_version": "3.0",
"capacity": 2,
"enterprise_project_id": "0",
"enterprise_project_name": "default",
"no_password_access": false,
"password": "********",
"vpc_id": "0402ea19-5457-4032-9d1b-eb48b98f6c66",
"security_group_id": "4b95a790-5cfc-463d-8de5-42199e55371c",
"subnet_id": "a3bd29e4-d5bc-414c-a79a-1f35ee4ead88",
"available_zones": [
"12c47a78666b4e438cd0c692b9860387"
],
"maintain_begin": "02:00",
"maintain_end": "06:00",
"product_id": "dcs.master_standby-h",
"enable_publicip": false,
"publicip_id": "",
"enable_ssl": false,
"private_ips": "",
"instance_num": 1
}</pre>
</div>
</li></ul>
</div>
<div class="section" id="dcs-api-0312004__section93113588441"><h4 class="sectiontitle">Response</h4><p id="dcs-api-0312004__p2506125544912"><strong id="dcs-api-0312004__b147314719197">Response parameters</strong></p>
<div class="p" id="dcs-api-0312004__p1997218379333"><a href="#dcs-api-0312004__table079510368334">Table 5</a> describes the response parameters.
<div class="tablenoborder"><a name="dcs-api-0312004__table079510368334"></a><a name="table079510368334"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table079510368334" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Parameter description</caption><thead align="left"><tr id="dcs-api-0312004__row187954363335"><th align="left" class="cellrowborder" valign="top" width="20.200000000000003%" id="mcps1.3.4.3.2.2.4.1.1"><p id="dcs-api-0312004__p179517363338">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23.23%" id="mcps1.3.4.3.2.2.4.1.2"><p id="dcs-api-0312004__p579563643317">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.57%" id="mcps1.3.4.3.2.2.4.1.3"><p id="dcs-api-0312004__p3795183633313">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row1379543663318"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312004__p879573633320">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312004__p879573613312">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312004__p179517368331">DCS instance ID.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row1147115371915"><td class="cellrowborder" valign="top" width="20.200000000000003%" headers="mcps1.3.4.3.2.2.4.1.1 "><p id="dcs-api-0312004__p1047185314193">instances</p>
</td>
<td class="cellrowborder" valign="top" width="23.23%" headers="mcps1.3.4.3.2.2.4.1.2 "><p id="dcs-api-0312004__p647175313196">Array of Objects</p>
</td>
<td class="cellrowborder" valign="top" width="56.57%" headers="mcps1.3.4.3.2.2.4.1.3 "><p id="dcs-api-0312004__p9471353151910">DCS instance list. For details, see <a href="#dcs-api-0312004__table128250386224">Table 6</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="tablenoborder"><a name="dcs-api-0312004__table128250386224"></a><a name="table128250386224"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table128250386224" frame="border" border="1" rules="all"><caption><b>Table 6 </b>instances parameters</caption><thead align="left"><tr id="dcs-api-0312004__row128431538102217"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="dcs-api-0312004__p5846163852213">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="23%" id="mcps1.3.4.4.2.4.1.2"><p id="dcs-api-0312004__p7851173817223">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="56.99999999999999%" id="mcps1.3.4.4.2.4.1.3"><p id="dcs-api-0312004__p15858183862215">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row886183862216"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312004__p16865143815225">instance_id</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312004__p16872203822215">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312004__p158800381229">DCS instance ID.</p>
</td>
</tr>
<tr id="dcs-api-0312004__row58828389224"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="dcs-api-0312004__p4885103815223">instance_name</p>
</td>
<td class="cellrowborder" valign="top" width="23%" headers="mcps1.3.4.4.2.4.1.2 "><p id="dcs-api-0312004__p389043832217">String</p>
</td>
<td class="cellrowborder" valign="top" width="56.99999999999999%" headers="mcps1.3.4.4.2.4.1.3 "><p id="dcs-api-0312004__p78973388224">DCS instance name.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="dcs-api-0312004__p064619919505"><strong id="dcs-api-0312004__b1970665901915">Example response</strong></p>
<pre class="screen" id="dcs-api-0312004__screen7327105315578">{
"instances": [
{
"instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f",
"instance_name": "dcs-test005"
}
],
"instance_id": "3c49fd6b-fc7c-419e-9644-b6cce008653f"
}</pre>
</div>
<div class="section" id="dcs-api-0312004__section1837410835217"><h4 class="sectiontitle">Status Code</h4><p id="dcs-api-0312004__p8674627175214"><a href="#dcs-api-0312004__table217814394526">Table 7</a> describes the status code of successful operations. For details about other status codes, see <a href="dcs-api-0312043.html#dcs-api-0312043__table5210141351517">Table 1</a>. </p>
<div class="tablenoborder"><a name="dcs-api-0312004__table217814394526"></a><a name="table217814394526"></a><table cellpadding="4" cellspacing="0" summary="" id="dcs-api-0312004__table217814394526" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Status code</caption><thead align="left"><tr id="dcs-api-0312004__row19178103985215"><th align="left" class="cellrowborder" valign="top" width="15.98%" id="mcps1.3.5.3.2.3.1.1"><p id="dcs-api-0312004__p1817919395523">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="84.02%" id="mcps1.3.5.3.2.3.1.2"><p id="dcs-api-0312004__p171795391523">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="dcs-api-0312004__row617963985216"><td class="cellrowborder" valign="top" width="15.98%" headers="mcps1.3.5.3.2.3.1.1 "><p id="dcs-api-0312004__p11179113965212">200</p>
</td>
<td class="cellrowborder" valign="top" width="84.02%" headers="mcps1.3.5.3.2.3.1.2 "><p id="dcs-api-0312004__p1817918393520">DCS instance created successfully.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="dcs-api-0312003.html">Lifecycle Management APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink