forked from docs/doc-exports
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
338 lines
30 KiB
HTML
338 lines
30 KiB
HTML
<a name="CreateOneDashboard"></a><a name="CreateOneDashboard"></a>
|
|
|
|
<h1 class="topictitle1">Creating or Copying a Dashboard</h1>
|
|
<div id="body8662426"><div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section59435911012"><h4 class="sectiontitle">Function</h4><p id="CreateOneDashboard__en-us_topic_0000001694892353_p179431994015">This API is used to create or copy a dashboard.</p>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section13943692020"><h4 class="sectiontitle">URI</h4><p id="CreateOneDashboard__en-us_topic_0000001694892353_p19434911012">POST /v2/{project_id}/dashboards</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_table19943097016" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row79431691002"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1594429602">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p159441891702">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p11944199707">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p13944793017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row89430915014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p5944691504">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p394419912016">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p149442916010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="CreateOneDashboard__p1235902804418">Project ID.</p>
|
|
<p id="CreateOneDashboard__p2359102816441">For details about how to obtain the project ID, see <a href="ces_03_0057.html">Obtaining a Project ID</a>.</p>
|
|
<p id="CreateOneDashboard__p1135982817445">Minimum: <strong id="CreateOneDashboard__b173174805234142">1</strong></p>
|
|
<p id="CreateOneDashboard__p935919281442">Maximum: <strong id="CreateOneDashboard__b213435267383344">64</strong></p>
|
|
<p id="CreateOneDashboard__p9359102810448"><strong id="CreateOneDashboard__b9213195464248">Regular expression matching:</strong> ^[a-zA-Z0-9-]{1,64}$</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section1694410916014"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row694419913015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p49451291602">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p169455910018">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p19945109809">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p199451391605">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row169441391502"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p14945139902">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p11945109805">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p9945891504">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p3945699019">MIME type of the request body. <strong id="CreateOneDashboard__b49764195102143">application/json</strong> is recommended.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p39452916017">Default value: <strong id="CreateOneDashboard__b104419381302143">application/json; charset=UTF-8</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p1494519705">Minimum: <strong id="CreateOneDashboard__b138618041634142">1</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p19451191016">Maximum: <strong id="CreateOneDashboard__b24635257783344">64</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row1194416917014"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p89451891008">X-Auth-Token</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p2945699017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1594516917010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="CreateOneDashboard__p1059961584017">User token. It is a response to the API for obtaining a user token. This API is the only one that does not require authentication. After a response is returned, the value of <strong id="CreateOneDashboard__b37636926533948">X-Subject-Token</strong> in the response header is the token.</p>
|
|
<p id="CreateOneDashboard__p059916156403">Minimum: <strong id="CreateOneDashboard__b63723907134142">1</strong></p>
|
|
<p id="CreateOneDashboard__p5599161544013">Maximum: <strong id="CreateOneDashboard__b1097017228128">16384</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_request_CreateDashboardRequestBody" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request body parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row1994617915015"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p19946593019">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1994620915011">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p129461397012">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p694618914013">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row49461091307"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1994615917011">dashboard_name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p109471995017">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1947298010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1494789600">Custom dashboard name.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p49471391607">Minimum: <strong id="CreateOneDashboard__b15875098834142">1</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p1594716919012">Maximum: <strong id="CreateOneDashboard__b9428985828040">128</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p11947399010"><strong id="CreateOneDashboard__b11790601428320">Regular expression matching:</strong> ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row09461793016"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p79471591902">enterprise_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p9947491509">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1794769407">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p2947109102">Enterprise project ID.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p1294714910012"><strong id="CreateOneDashboard__b59665874282739">Regular expression matching</strong>: ^((([a-z]|[0-9]){8}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){4}-([a-z]|[0-9]){12})|0)$</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row994689603"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p169471591009">dashboard_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p139471891101">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p4947491206">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p9947109302">Dashboard ID. If a dashboard ID is specified, the dashboard will be copied.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p14947492012"><strong id="CreateOneDashboard__en-us_topic_0000001694892353_b12947179805">Regular expression matching</strong>: ^db([a-z]|[A-Z]|[0-9]){22}</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row794620910012"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p10947169603">row_widget_num</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p2948169108">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p20948109807">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1894879109">How a graph is displayed. <strong id="CreateOneDashboard__b370412013011">0</strong> indicates that you can customize <strong id="CreateOneDashboard__b1752582317302">top</strong> and <strong id="CreateOneDashboard__b1697692416301">left</strong> of the graph. <strong id="CreateOneDashboard__b183418273306">1</strong> indicates one graph per row.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p89481991102">Minimum: <strong id="CreateOneDashboard__b161073373244050">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p9948119108">Maximum: <strong id="CreateOneDashboard__en-us_topic_0000001694892353_b17948891005">3</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p109481191602">Default: <strong id="CreateOneDashboard__b15443202812315">0</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section99482091902"><h4 class="sectiontitle">Response Parameters</h4><p id="CreateOneDashboard__en-us_topic_0000001694892353_p13948189203"><strong id="CreateOneDashboard__b2125390873112017">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_response_CreateDashboardResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row294819308"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p29489915020">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p994816916010">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p89481691203">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row5948691600"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1994913912015">dashboard_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p169491495018">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p4949391902">Dashboard ID.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p4949393019"><strong id="CreateOneDashboard__en-us_topic_0000001694892353_b394979609">Regular expression matching:</strong> ^db([a-z]|[A-Z]|[0-9]){22}</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p10949991601"><strong id="CreateOneDashboard__b206551147954113">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_response_GoAPIErrorResponseV2" frame="border" border="1" rules="all"><caption><b>Table 5 </b>Response body parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row9949129709"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p149491997010">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.5.2.4.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p59491091608">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.5.2.4.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p169491194011">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row149491691906"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p17949794019">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1994919806">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1795009707">Status code customized by each cloud service when a request error occurs.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p159509918013">Minimum: <strong id="CreateOneDashboard__b153943003374840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p139501191906">Maximum: <strong id="CreateOneDashboard__b4817630755137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row1894911920015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p29503916018">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p09501591602">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p4950991208">Request error message.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p14950691607">Minimum: <strong id="CreateOneDashboard__b115599925574840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p395019109">Maximum: <strong id="CreateOneDashboard__b3797556995137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row79491917020"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p39501991100">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.5.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p495017911010">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.5.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p59501919011">Request ID.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p595009801">Minimum: <strong id="CreateOneDashboard__b61726043574840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p89501998017">Maximum: <strong id="CreateOneDashboard__b4129600455137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p2950149900"><strong id="CreateOneDashboard__b1931029518113934">Status code: 401</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_table29509910015" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row1395120919011"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p09511697020">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.7.2.4.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p16951392010">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.7.2.4.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p59511391501">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row169515919010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p119511091108">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p169511891108">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p199511692013">Status code customized by each cloud service when a request error occurs.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p209517916010">Minimum: <strong id="CreateOneDashboard__b160136395474840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p8951199709">Maximum: <strong id="CreateOneDashboard__b17949134135137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row109511991203"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p169511791014">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p139521692015">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p16952491607">Request error message.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p995210919012">Minimum: <strong id="CreateOneDashboard__b2846762974840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p109521291304">Maximum: <strong id="CreateOneDashboard__b8755222395137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row89511496016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p995212916018">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.7.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p89521291603">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.7.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p12952394012">Request ID.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p795216915017">Minimum: <strong id="CreateOneDashboard__b119007310074840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p179521195011">Maximum: <strong id="CreateOneDashboard__b569692125137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p79521994020"><strong id="CreateOneDashboard__b18091499432023">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_table17952495017" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row20952891006"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p29531491012">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p2095319917015">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p14953139305">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row1795219912016"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p109531795015">error_code</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p17953998020">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p179531394019">Status code customized by each cloud service when a request error occurs.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p8953598016">Minimum: <strong id="CreateOneDashboard__b11600295374840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p4953791703">Maximum: <strong id="CreateOneDashboard__b4318888845137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row13952291107"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p149531491801">error_msg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p15953191400">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p179533913013">Request error message.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p29531791304">Minimum: <strong id="CreateOneDashboard__b142923323374840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p109539919017">Maximum: <strong id="CreateOneDashboard__b14804192485137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row119520910017"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p15953096018">request_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p69531497013">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p119531399012">Request ID.</p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p4953891507">Minimum: <strong id="CreateOneDashboard__b3835473174840">0</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p149535914012">Maximum: <strong id="CreateOneDashboard__b3801402665137">256</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section99531893010"><h4 class="sectiontitle">Example Requests</h4><p id="CreateOneDashboard__p4805953102713">Create a dashboard.</p>
|
|
<pre class="screen" id="CreateOneDashboard__en-us_topic_0000001694892353_screen14954994019">{
|
|
"dashboard_name" : "dashboard_name",
|
|
"enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
"row_widget_num" : 3
|
|
}</pre>
|
|
<p id="CreateOneDashboard__p34511563323">Copy a dashboard.</p>
|
|
<pre class="screen" id="CreateOneDashboard__screen320751019339">{
|
|
"dashboard_name" : "dashboard_name",
|
|
"enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
|
|
"dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
|
|
"row_widget_num" : 3
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section195414920013"><h4 class="sectiontitle">Example Responses</h4><p id="CreateOneDashboard__en-us_topic_0000001694892353_p295418910019"><strong id="CreateOneDashboard__b717588999112017">Status code: 201</strong></p>
|
|
<p id="CreateOneDashboard__en-us_topic_0000001694892353_p2095418910010">OK</p>
|
|
<p id="CreateOneDashboard__p69349249353">Create a dashboard.</p>
|
|
<pre class="screen" id="CreateOneDashboard__en-us_topic_0000001694892353_screen195489104">{
|
|
"dashboard_id" : "dbxxxxxxxxx"
|
|
}</pre>
|
|
<p id="CreateOneDashboard__p847163873514">Copy a dashboard.</p>
|
|
<pre class="screen" id="CreateOneDashboard__screen94718384356">{
|
|
"dashboard_id" : "dbxxxxxxxxx"
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section19954491501"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="CreateOneDashboard__en-us_topic_0000001694892353_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row4954291014"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p7954691407">Status Code</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="CreateOneDashboard__en-us_topic_0000001694892353_p18955997017">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="CreateOneDashboard__en-us_topic_0000001694892353_row1295414915017"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p14955159108">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1495519700">OK</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row159541695014"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p7955189206">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1195579607">The server failed to process the request.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row199549918013"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p19554918014">401</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p119551391010">Token authentication is required.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="CreateOneDashboard__en-us_topic_0000001694892353_row129542919012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p10955191701">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1955590020">Failed to complete the request because of an internal server error.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="CreateOneDashboard__en-us_topic_0000001694892353_section13955291102"><h4 class="sectiontitle">Error Codes</h4><p id="CreateOneDashboard__en-us_topic_0000001694892353_p1095529703">See <a href="ErrorCode.html">Error Codes</a>.</p>
|
|
</div>
|
|
</div>
|
|
<div>
|
|
<div class="familylinks">
|
|
<div class="parentlink"><strong>Parent topic:</strong> <a href="topic_300000011.html">Dashboards</a></div>
|
|
</div>
|
|
</div>
|
|
|