forked from docs/doc-exports
Su, Xiaomeng
57a0d535be
Reviewed-by: Pruthi, Vineet <vineet.pruthi@t-systems.com> Co-authored-by: Su, Xiaomeng <suxiaomeng1@huawei.com> Co-committed-by: Su, Xiaomeng <suxiaomeng1@huawei.com>
200 lines
16 KiB
HTML
200 lines
16 KiB
HTML
<a name="dli_02_0028"></a><a name="dli_02_0028"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Database</h1>
|
|
<div id="body8662426"><div class="section" id="dli_02_0028__s545659956d954d3c95dd3c934f1e7c49"><h4 class="sectiontitle">Function</h4><p id="dli_02_0028__en-us_topic_0069077898_p41237052">This API is used to add a database.</p>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__s0f75ae4923904edda319ed810bb139d5"><h4 class="sectiontitle">URI</h4><ul id="dli_02_0028__en-us_topic_0069077898_ul51866941"><li id="dli_02_0028__en-us_topic_0069077898_li64149293">URI format<p id="dli_02_0028__en-us_topic_0069077898_p40472731"><a name="dli_02_0028__en-us_topic_0069077898_li64149293"></a><a name="en-us_topic_0069077898_li64149293"></a>POST /v1.0/{project_id}/databases</p>
|
|
</li><li id="dli_02_0028__li1725612218454">Parameter description
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0028__en-us_topic_0069077803_table60779388" frame="border" border="1" rules="all"><caption><b>Table 1 </b>URI parameter</caption><thead align="left"><tr id="dli_02_0028__en-us_topic_0069077803_row61411666"><th align="left" class="cellrowborder" valign="top" width="11.881188118811883%" id="mcps1.3.2.2.2.1.2.5.1.1"><p id="dli_02_0028__a420a62a594f9410eaea229ffc8037a61">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.671067106710671%" id="mcps1.3.2.2.2.1.2.5.1.2"><p id="dli_02_0028__en-us_topic_0069077803_p873025824211">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="13.211321132113211%" id="mcps1.3.2.2.2.1.2.5.1.3"><p id="dli_02_0028__p10858141823114">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="64.23642364236424%" id="mcps1.3.2.2.2.1.2.5.1.4"><p id="dli_02_0028__a692d3cd97b464aed90ba6d841900a4a5">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0028__en-us_topic_0069077803_row48589216"><td class="cellrowborder" valign="top" width="11.881188118811883%" headers="mcps1.3.2.2.2.1.2.5.1.1 "><p id="dli_02_0028__en-us_topic_0069077803_p43412436">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.671067106710671%" headers="mcps1.3.2.2.2.1.2.5.1.2 "><p id="dli_02_0028__en-us_topic_0069077803_p26746391">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="13.211321132113211%" headers="mcps1.3.2.2.2.1.2.5.1.3 "><p id="dli_02_0028__p58581218193112">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="64.23642364236424%" headers="mcps1.3.2.2.2.1.2.5.1.4 "><p id="dli_02_0028__p1310472724012">Project ID, which is used for resource isolation. For details about how to obtain its value, see <a href="dli_02_0183.html">Obtaining a Project ID</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</li></ul>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__s297827ccb50c487cb07f373601c92843"><h4 class="sectiontitle">Request</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0028__en-us_topic_0069077898_table15679275" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request parameters</caption><thead align="left"><tr id="dli_02_0028__en-us_topic_0069077898_row3340134"><th align="left" class="cellrowborder" valign="top" width="20.02%" id="mcps1.3.3.2.2.5.1.1"><p id="dli_02_0028__a6f9756135d034e70b9211503804b7e51">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.64%" id="mcps1.3.3.2.2.5.1.2"><p id="dli_02_0028__a0d32354b58f84e559b6380bcb15b4331">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="9.98%" id="mcps1.3.3.2.2.5.1.3"><p id="dli_02_0028__p190771111211">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="58.36%" id="mcps1.3.3.2.2.5.1.4"><p id="dli_02_0028__a874b634bcc114acea00818e8eadad0fc">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0028__en-us_topic_0069077898_row25164041"><td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0028__en-us_topic_0069077898_p25021415">database_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0028__en-us_topic_0069077898_p13468701">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.98%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0028__p3907171101214">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0028__en-us_topic_0069077898_p17222996">Name of the created database.</p>
|
|
<ul id="dli_02_0028__ul15601233161016"><li id="dli_02_0028__li360173314106">The database name can contain only digits, letters, and underscores (_), but cannot contain only digits or start with an underscore (_).</li><li id="dli_02_0028__li120753518108">The database name is case insensitive and cannot be left blank.</li><li id="dli_02_0028__li68378360106">The length of the database name cannot exceed 128 characters.</li></ul>
|
|
<div class="note" id="dli_02_0028__note146952014174510"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0028__p4695514184519">The <strong id="dli_02_0028__b842352706114045">default</strong> database is a built-in database. You cannot create a database named <strong id="dli_02_0028__b84235270611410">default</strong>.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__en-us_topic_0069077898_row20789239"><td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0028__en-us_topic_0069077898_p6206802">description</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0028__en-us_topic_0069077898_p32988929">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.98%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0028__p11907511151211">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0028__en-us_topic_0069077898_p54857581">Information about the created database.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__row99921916412"><td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0028__p6269533134318">enterprise_project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0028__p15269183364318">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.98%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0028__p5269103315439">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0028__p1326917339437">Enterprise project ID. The value <strong id="dli_02_0028__b39815487512">0</strong> indicates the default enterprise project. </p>
|
|
<div class="note" id="dli_02_0028__note1358194815815"><span class="notetitle"> NOTE: </span><div class="notebody"><p id="dli_02_0028__p16581348175819">Users who have enabled Enterprise Management can set this parameter to bind a specified project.</p>
|
|
</div></div>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__row6889152816223"><td class="cellrowborder" valign="top" width="20.02%" headers="mcps1.3.3.2.2.5.1.1 "><p id="dli_02_0028__p135102615814">tags</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.64%" headers="mcps1.3.3.2.2.5.1.2 "><p id="dli_02_0028__p251011605810">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="9.98%" headers="mcps1.3.3.2.2.5.1.3 "><p id="dli_02_0028__p451066135816">Array of Objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="58.36%" headers="mcps1.3.3.2.2.5.1.4 "><p id="dli_02_0028__p55101469587">Database tag. For details, see <a href="#dli_02_0028__table9391124139">Table 3</a>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0028__table9391124139"></a><a name="table9391124139"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0028__table9391124139" frame="border" border="1" rules="all"><caption><b>Table 3 </b>tags parameters</caption><thead align="left"><tr id="dli_02_0028__row1440020130"><th align="left" class="cellrowborder" valign="top" width="14.899999999999999%" id="mcps1.3.3.3.2.5.1.1"><p id="dli_02_0028__p194012219139">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="10.83%" id="mcps1.3.3.3.2.5.1.2"><p id="dli_02_0028__p540724136">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="16.470000000000002%" id="mcps1.3.3.3.2.5.1.3"><p id="dli_02_0028__p840162161315">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="57.8%" id="mcps1.3.3.3.2.5.1.4"><p id="dli_02_0028__p16401271318">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0028__row194013231317"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dli_02_0028__p13401329138">Key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.83%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dli_02_0028__p940102141313">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dli_02_0028__p64019231317">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dli_02_0028__p5401021139">Tag key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__row1141142181320"><td class="cellrowborder" valign="top" width="14.899999999999999%" headers="mcps1.3.3.3.2.5.1.1 "><p id="dli_02_0028__p164118215134">value</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="10.83%" headers="mcps1.3.3.3.2.5.1.2 "><p id="dli_02_0028__p1141112181317">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="16.470000000000002%" headers="mcps1.3.3.3.2.5.1.3 "><p id="dli_02_0028__p174114281318">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="57.8%" headers="mcps1.3.3.3.2.5.1.4 "><p id="dli_02_0028__p16411125137">Tag key.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__s6d7a3bcfe0464ea08b122472d4675570"><h4 class="sectiontitle">Response</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0028__en-us_topic_0069077898_table788650" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response parameters</caption><thead align="left"><tr id="dli_02_0028__en-us_topic_0069077898_row7508508"><th align="left" class="cellrowborder" valign="top" width="13.850000000000001%" id="mcps1.3.4.2.2.5.1.1"><p id="dli_02_0028__ad0bd974b725d4091912f6364aeaee223">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="12.22%" id="mcps1.3.4.2.2.5.1.2"><p id="dli_02_0028__p1485013544139">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="11.709999999999999%" id="mcps1.3.4.2.2.5.1.3"><p id="dli_02_0028__en-us_topic_0069077898_p989195113104">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="62.22%" id="mcps1.3.4.2.2.5.1.4"><p id="dli_02_0028__a09b68f09628c4e7ba61cbf7f014d5052">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0028__en-us_topic_0069077898_row21729351"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0028__en-us_topic_0069077898_p15247038">is_success</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.22%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0028__p7850054151310">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.709999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0028__en-us_topic_0069077898_p43609175">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.22%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0028__p6746116171411">Whether the request is successfully executed. Value <span class="parmvalue" id="dli_02_0028__parmvalue1801866516843"><b>true</b></span> indicates that the request is successfully executed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__en-us_topic_0069077898_row48596519"><td class="cellrowborder" valign="top" width="13.850000000000001%" headers="mcps1.3.4.2.2.5.1.1 "><p id="dli_02_0028__en-us_topic_0069077898_p44003968">message</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="12.22%" headers="mcps1.3.4.2.2.5.1.2 "><p id="dli_02_0028__p68501054161315">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="11.709999999999999%" headers="mcps1.3.4.2.2.5.1.3 "><p id="dli_02_0028__en-us_topic_0069077898_p7707181">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="62.22%" headers="mcps1.3.4.2.2.5.1.4 "><p id="dli_02_0028__a4fa277540d3e42e48cec2027a36ca6bc">System prompt. If execution succeeds, the parameter setting may be left blank.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__section149621181487"><h4 class="sectiontitle">Example Request</h4><p id="dli_02_0028__p1475817103917">Create a test database named <strong id="dli_02_0028__b19613432201915">db1</strong>.</p>
|
|
<pre class="screen" id="dli_02_0028__screen18104185151417">{
|
|
"database_name": "db1",
|
|
"description": "this is for test"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__section25926710151335"><h4 class="sectiontitle">Example Response</h4><pre class="screen" id="dli_02_0028__screen54978032151453">{
|
|
"is_success": true,
|
|
"message": ""
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__sf39cfd445ad24e9e82754fcb0027179d"><h4 class="sectiontitle">Status Codes</h4><p id="dli_02_0028__a04144ca3a08e4576b386c6a98f43a2ae"><a href="#dli_02_0028__tb12870f1c5f24b27abd55ca24264af36">Table 5</a> describes the status code.</p>
|
|
|
|
<div class="tablenoborder"><a name="dli_02_0028__tb12870f1c5f24b27abd55ca24264af36"></a><a name="tb12870f1c5f24b27abd55ca24264af36"></a><table cellpadding="4" cellspacing="0" summary="" id="dli_02_0028__tb12870f1c5f24b27abd55ca24264af36" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Status codes</caption><thead align="left"><tr id="dli_02_0028__r8d54231f95b14c01a5e55e95f3b2e838"><th align="left" class="cellrowborder" valign="top" width="30%" id="mcps1.3.7.3.2.3.1.1"><p id="dli_02_0028__ab49d21f312644072a331f43e92baf853">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="70%" id="mcps1.3.7.3.2.3.1.2"><p id="dli_02_0028__aea1d3bd107bb4c499da79a88832d256c">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="dli_02_0028__r211ad4eb571d4d938e5579998723174e"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0028__a3153e07b3a9749adba92599fe6628fbf">200</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0028__p104431642124811">The job is created successfully.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__row44937531727"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0028__p184941532219">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0028__p2049413539219">Request error.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="dli_02_0028__row65331212142411"><td class="cellrowborder" valign="top" width="30%" headers="mcps1.3.7.3.2.3.1.1 "><p id="dli_02_0028__p5537171216249">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="70%" headers="mcps1.3.7.3.2.3.1.2 "><p id="dli_02_0028__p953813124249">Internal service error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="dli_02_0028__section13596141025715"><h4 class="sectiontitle">Error Codes</h4><p id="dli_02_0028__p420584425712">If an error occurs when this API is invoked, the system does not return the result similar to the preceding example, but returns the error code and error information. For details, see <a href="dli_02_0056.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="dli_02_0027.html">Database-related APIs</a></div>
|
|
</div>
|
|
</div>
|
|
|