yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
03e77f3e5b0080047fdcb72efdfd3333dd3bcf92
doc-exports/docs/ces/api-ref/ListDashboardInfos.html
qiujiandong1 e9265fb6b0 CES API Update -20250521 version 
Reviewed-by: Ziuzko, Alevtina <alevtina.ziuzko@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-12-05 10:48:24 +00:00

378 lines
35 KiB
HTML
Raw Blame History

<a name="ListDashboardInfos"></a><a name="ListDashboardInfos"></a>
<h1 class="topictitle1">Querying Dashboards</h1>
<div id="body8662426"><div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section826972113014"><h4 class="sectiontitle">Function</h4><p id="ListDashboardInfos__en-us_topic_0000001646851902_p62693212000">This API is used to query dashboards.</p>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section6269821602"><h4 class="sectiontitle">URI</h4><p id="ListDashboardInfos__en-us_topic_0000001646851902_p82691021409">GET /v2/{project_id}/dashboards</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_table1526922118019" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row22697212011"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p192702211803">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p42708211502">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p18270112110010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p182701321809">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row426919212007"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p16270102117010">project_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p172701721202">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p12703218013">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="ListDashboardInfos__p1235902804418">Project ID.</p>
<p id="ListDashboardInfos__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="ListDashboardInfos__p1135982817445">Minimum: <strong id="ListDashboardInfos__b166426462034143">1</strong></p>
<p id="ListDashboardInfos__p935919281442">Maximum: <strong id="ListDashboardInfos__b37537033844413">64</strong></p>
<p id="ListDashboardInfos__p9359102810448"><strong id="ListDashboardInfos__b13175780934250">Regular expression matching:</strong> ^[a-zA-Z0-9-]{1,64}$</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_table92714211008" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Query parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1270102112017"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p162716211907">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1627118211002">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.4.2.5.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1927110217016">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.4.2.5.1.4"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p162719211001">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row162701211402"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p142713211706">is_favorite</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p227110212019">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p10271172117017">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1327113215020">Whether a dashboard in an enterprise project is added to favorites. The value can be <strong id="ListDashboardInfos__b927103023212">true</strong> (added to favorites) and <strong id="ListDashboardInfos__b570232203218">false</strong> (not added to favorites). If this parameter is specified, <strong id="ListDashboardInfos__b443019366326">enterprise_id</strong> is mandatory.</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row15271172112017"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p15272721805">dashboard_name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p0272821808">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p7272142117012">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p3272321908">Dashboard name.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p627219210014">Minimum: <strong id="ListDashboardInfos__b78594308434143">1</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p172725210018">Maximum: <strong id="ListDashboardInfos__b20602634898042">128</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p82721421103"><strong id="ListDashboardInfos__b116809038321">Regular expression matching:</strong> ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row102711821203"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p132727211303">dashboard_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p52721821501">No</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.4.2.5.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p192721521202">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.4.2.5.1.4 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p127222119019">Dashboard ID.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p1627216211901"><strong id="ListDashboardInfos__en-us_topic_0000001646851902_b152721221107">Regular expression matching:</strong> ^db([a-z]|[A-Z]|[0-9]){22}</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section22726213019"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Request header parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row172721421300"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1427317211309">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p142731221708">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1327311217017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1127312114013">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row6272021808"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p15273152119015">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p827320211909">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p11273921001">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListDashboardInfos__p6902173510408">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="ListDashboardInfos__b40516247833950">X-Subject-Token</strong> in the response header is the token.</p>
<p id="ListDashboardInfos__p49022351404">Minimum: <strong id="ListDashboardInfos__b101892150634143">1</strong></p>
<p id="ListDashboardInfos__p1990283516403">Maximum: <strong id="ListDashboardInfos__b77053522591227">16384</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section13273421508"><h4 class="sectiontitle">Response Parameters</h4><p id="ListDashboardInfos__en-us_topic_0000001646851902_p727311212011"><strong id="ListDashboardInfos__b182281890983023">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_response_ListDashboardResponseBody" frame="border" border="1" rules="all"><caption><b>Table 4 </b>Response body parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row72731721508"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p5274182120014">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.3.2.4.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p427422116017">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.3.2.4.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p62747212017">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row727412118017"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p122743216017">dashboards</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p182741521907">Array of <a href="#ListDashboardInfos__en-us_topic_0000001646851902_response_DashBoardInfo">DashBoardInfo</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p11274321407">Dashboard list.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p32745214017">Array length: <strong id="ListDashboardInfos__b1340797809103915">0</strong> to <strong id="ListDashboardInfos__b1453943818103915">10</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListDashboardInfos__en-us_topic_0000001646851902_response_DashBoardInfo"></a><a name="en-us_topic_0000001646851902_response_DashBoardInfo"></a><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_response_DashBoardInfo" frame="border" border="1" rules="all"><caption><b>Table 5 </b>DashBoardInfo</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row15274721103"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p15275921501">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.4.2.4.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1027572112010">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.4.2.4.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p927513216015">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1275221107"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p427532117014">dashboard_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1927592116020">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p11275162112018">Dashboard ID.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p727519211909"><strong id="ListDashboardInfos__en-us_topic_0000001646851902_b182751721604">Regular expression matching:</strong> ^db([a-z]|[A-Z]|[0-9]){22}</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row227516211011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p7275421702">dashboard_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p172754211902">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p13275122116019">Custom dashboard name.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p1827652114019">Minimum: <strong id="ListDashboardInfos__b95563451434143">1</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p202766216019">Maximum: <strong id="ListDashboardInfos__b3637417098042">128</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p132761218020"><strong id="ListDashboardInfos__b12333604518321">Regular expression matching:</strong> ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row927502114015"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p42761021104">enterprise_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1327682116014">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p62761321709">Enterprise project ID.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p15276152119018"><strong id="ListDashboardInfos__b75265898782741">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="ListDashboardInfos__en-us_topic_0000001646851902_row13275421902"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p102763211000">creator_name</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p132767217014">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p14276192114012">Name of the user who created the dashboard.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p72768211209">Minimum: <strong id="ListDashboardInfos__b191015039134143">1</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p027672112015">Maximum: <strong id="ListDashboardInfos__b12019762798042">128</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p182767211206"><strong id="ListDashboardInfos__b10620244808321">Regular expression matching:</strong> ^([\u4E00-\u9FFF]|[a-z]|[A-Z]|[0-9]|_|-)+$</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1275112119013"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p8276102110013">create_time</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p132766217016">Long</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p3276122114017">Time when the dashboard was created. The value is a timestamp, in milliseconds.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p11276162117018">Minimum: <strong id="ListDashboardInfos__b163526894955251">1111111111111</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p162760216012">Maximum: <strong id="ListDashboardInfos__b156201812055320">9999999999999</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row827522112011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1027622113011">row_widget_num</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p15277182114016">Integer</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p42774211908">How a graph is displayed. <strong id="ListDashboardInfos__b829954373616">0</strong> indicates that you can customize <strong id="ListDashboardInfos__b15299134313368">top</strong> and <strong id="ListDashboardInfos__b929934313361">left</strong> of the graph. <strong id="ListDashboardInfos__b1029915435369">1</strong> indicates one graph per row.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p927782111017">Minimum: <strong id="ListDashboardInfos__b45576111544052">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p427702115012">Maximum: <strong id="ListDashboardInfos__en-us_topic_0000001646851902_b52777218014">3</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p32771021004">Default: <strong id="ListDashboardInfos__b12685550123612">3</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1827514214018"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p102771621907">is_favorite</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p15277122117012">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p11277112114018">Whether a dashboard is added to favorites. The value can be <strong id="ListDashboardInfos__b12921842375">true</strong> or <strong id="ListDashboardInfos__b84185516370">false</strong>.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p19277821605"><strong id="ListDashboardInfos__b111571028854115">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_response_GoAPIErrorResponseV2" frame="border" border="1" rules="all"><caption><b>Table 6 </b>Response body parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row18277142120010"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p142788211808">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.6.2.4.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p132781121400">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.6.2.4.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p142784217012">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1927782117010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1727882118014">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1827813211405">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p17278821604">Status code customized by each cloud service when a request error occurs.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p142789216016">Minimum: <strong id="ListDashboardInfos__b73229670174842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p1227812215017">Maximum: <strong id="ListDashboardInfos__b11414016745139">256</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1527717216011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p52787214011">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p62784219018">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p17278221206">Request error message.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p1327815211605">Minimum: <strong id="ListDashboardInfos__b130610160274842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p8278142118019">Maximum: <strong id="ListDashboardInfos__b18342060155139">256</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row102774213010"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p327815211004">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.6.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p52783212008">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.6.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p182782021600">Request ID.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p8278132113018">Minimum: <strong id="ListDashboardInfos__b100605368974842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p62784211600">Maximum: <strong id="ListDashboardInfos__b16194339295139">256</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p8279221907"><strong id="ListDashboardInfos__b317507939113935">Status code: 401</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_table727918210015" frame="border" border="1" rules="all"><caption><b>Table 7 </b>Response body parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row227910216017"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p9279192110012">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p172791521001">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p102796211505">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row727922117012"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p82791521505">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p02792214014">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p122791921905">Status code customized by each cloud service when a request error occurs.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p14279182111012">Minimum: <strong id="ListDashboardInfos__b87511381774842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p52793215011">Maximum: <strong id="ListDashboardInfos__b18660358155139">256</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1127920211709"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p11280172116012">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p22801121905">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p0280172118012">Request error message.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p19280821708">Minimum: <strong id="ListDashboardInfos__b115375763874842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p628011211407">Maximum: <strong id="ListDashboardInfos__b15354487625139">256</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1827919218017"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p10280721201">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p32808211804">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p52801218014">Request ID.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p22801021905">Minimum: <strong id="ListDashboardInfos__b207511684774842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p142801421502">Maximum: <strong id="ListDashboardInfos__b8063634815139">256</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p112803211206"><strong id="ListDashboardInfos__b120259663032025">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_table18280202119016" frame="border" border="1" rules="all"><caption><b>Table 8 </b>Response body parameters</caption><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1128072120016"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p19281172118013">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p72811621301">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p52811621401">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row1828014212005"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1228115211020">error_code</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p22812211901">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p228117218012">Status code customized by each cloud service when a request error occurs.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p132810219013">Minimum: <strong id="ListDashboardInfos__b15830439674842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p72817215016">Maximum: <strong id="ListDashboardInfos__b6138663865139">256</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row62808211707"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1428112211000">error_msg</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p11281122111013">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p52819211709">Request error message.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p7281821202">Minimum: <strong id="ListDashboardInfos__b193608593874842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p4281112119010">Maximum: <strong id="ListDashboardInfos__b16705384105139">256</strong></p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row028042112011"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1728118216019">request_id</p>
</td>
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p42818211002">String</p>
</td>
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p728119215012">Request ID.</p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p1128114217015">Minimum: <strong id="ListDashboardInfos__b23782151874842">0</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p428210214011">Maximum: <strong id="ListDashboardInfos__b2191226425139">256</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section72821021505"><h4 class="sectiontitle">Example Requests</h4><p id="ListDashboardInfos__en-us_topic_0000001646851902_p428219211605">None</p>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section328214211903"><h4 class="sectiontitle">Example Responses</h4><p id="ListDashboardInfos__en-us_topic_0000001646851902_p142821214012"><strong id="ListDashboardInfos__b71350917883023">Status code: 200</strong></p>
<p id="ListDashboardInfos__en-us_topic_0000001646851902_p928219211809">OK</p>
<pre class="screen" id="ListDashboardInfos__en-us_topic_0000001646851902_screen18282122119017">{
"dashboards" : [ {
"dashboard_id" : "dbxxxxxxxxxxxxxxxxxxxxxx",
"dashboard_name" : "dashboard_name",
"enterprise_id" : "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"creator_name" : "creator_name",
"create_time" : 1111111111111,
"row_widget_num" : 3,
"is_favorite" : false
} ]
}</pre>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section172821121801"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListDashboardInfos__en-us_topic_0000001646851902_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row142838215019"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p428316211104">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListDashboardInfos__en-us_topic_0000001646851902_p112831211703">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListDashboardInfos__en-us_topic_0000001646851902_row828382119019"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p82836211904">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p1828312214014">OK</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row19283202120012"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p228311215018">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p122834216018">The server failed to process the request.</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row162835219016"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p8283152113012">401</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p154601421505">Token authentication is required.</p>
</td>
</tr>
<tr id="ListDashboardInfos__en-us_topic_0000001646851902_row16283521106"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p12460121202">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListDashboardInfos__en-us_topic_0000001646851902_p15460182116017">Failed to complete the request because of an internal server error.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListDashboardInfos__en-us_topic_0000001646851902_section1546010219017"><h4 class="sectiontitle">Error Codes</h4><p id="ListDashboardInfos__en-us_topic_0000001646851902_p446013211105">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>
View Git Blame Copy Permalink