yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
11026d61f2e2533adb2928f398d8cdbe520e650e
doc-exports/docs/cce/api-ref/ListCharts.html
qiujiandong1 ebc8247e23 CCE API update 20250114 version 
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com>
Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com>
Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
2025-03-05 16:51:16 +00:00

217 lines
15 KiB
HTML
Raw Blame History

<a name="ListCharts"></a><a name="ListCharts"></a>
<h1 class="topictitle1">Obtaining a Chart List</h1>
<div id="body32001227"><div class="section" id="ListCharts__section933042817317"><h4 class="sectiontitle">Function</h4><p id="ListCharts__p14331152883118">This API is used to obtain the chart list.</p>
</div>
<div class="section" id="ListCharts__en-us_topic_0000001850048554_atuogenerate_1"><h4 class="sectiontitle">URI</h4><p id="ListCharts__p10331182813312">GET /v2/charts</p>
</div>
<div class="section" id="ListCharts__section203311428113112"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCharts__en-us_topic_0000001850048554_HeaderParameter" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header parameters</caption><thead align="left"><tr id="ListCharts__row8332172823118"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="ListCharts__p1933342833117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="ListCharts__p933332812316">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="ListCharts__p123331328113117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="ListCharts__p83331828163119">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCharts__row13332152816316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListCharts__p1933418284311">Content-Type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListCharts__p18334122843119">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListCharts__p2334162873114">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListCharts__p175132048141618">Details:</p>
<p id="ListCharts__p1513184851611">Request body type or format.</p>
<p id="ListCharts__p363312163118">Constraints:</p>
<p id="ListCharts__p86331116121112">The GET method is not verified.</p>
<p id="ListCharts__p36336166115">Options:</p>
<ul id="ListCharts__ul166331116111111"><li id="ListCharts__li6633516101110">application/json</li><li id="ListCharts__li1363351614116">application/json;charset=utf-8</li><li id="ListCharts__li0633191617110">application/x-pem-file</li><li id="ListCharts__li192591549143012">multipart/form-data (It can be used when the <strong id="ListCharts__uploadchart_b1058912225107">FormData</strong> parameter exists.)</li></ul>
<p id="ListCharts__p363331671112">Default value:</p>
<p id="ListCharts__p5633151617112">N/A</p>
</td>
</tr>
<tr id="ListCharts__row43325286312"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="ListCharts__p133351228123111">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="ListCharts__p1933532813317">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="ListCharts__p14335152843116">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="ListCharts__p103354281312">Requests for calling an API can be authenticated using either a token or AK/SK. If token-based authentication is used, this parameter is mandatory and must be set to a user token. For details, see <a href="cce_02_0004.html">API Usage Guidelines</a>.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCharts__section13335112814319"><h4 class="sectiontitle">Response Parameters</h4><p id="ListCharts__p7336628173111"><strong id="ListCharts__b11336192813313">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCharts__en-us_topic_0000001850048554_response_ChartRespList" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Response body parameters</caption><thead align="left"><tr id="ListCharts__row0336162811317"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="ListCharts__p1533782893117">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="ListCharts__p19337528123116">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="ListCharts__p233716280312">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCharts__row193362288313"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="ListCharts__p233842811311">[items]</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="ListCharts__p1933832893118">Array of <a href="#ListCharts__en-us_topic_0000001850048554_response_ChartResp">ChartResp</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="ListCharts__p153381286310">Chart list</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="ListCharts__en-us_topic_0000001850048554_response_ChartResp"></a><a name="en-us_topic_0000001850048554_response_ChartResp"></a><table cellpadding="4" cellspacing="0" summary="" id="ListCharts__en-us_topic_0000001850048554_response_ChartResp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>ChartResp</caption><thead align="left"><tr id="ListCharts__row93391828123117"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="ListCharts__p1734582883114">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="ListCharts__p10345828143117">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="ListCharts__p23469287319">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCharts__row133392028163110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p133468289319">id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p034672803116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p2034610288316">Chart ID</p>
</td>
</tr>
<tr id="ListCharts__row93391628113116"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p5347122817312">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p173472028133117">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p163477282318">Chart name</p>
</td>
</tr>
<tr id="ListCharts__row20339152820317"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p334742863117">values</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p93481287316">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p7348628113117">Chart value</p>
</td>
</tr>
<tr id="ListCharts__row93401928123113"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p1734818289316">translate</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p1634813287312">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p153481285312">Chart translation resources</p>
</td>
</tr>
<tr id="ListCharts__row034162813119"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p4349122823114">instruction</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p534914283313">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p1234913285315">Chart description</p>
</td>
</tr>
<tr id="ListCharts__row13342182893120"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p8349172843114">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p2349228153116">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p15350192843119">Chart version</p>
</td>
</tr>
<tr id="ListCharts__row1734352813315"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p4350928153115">description</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p2035013282316">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p935017283311">Chart description</p>
</td>
</tr>
<tr id="ListCharts__row6343028113110"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p735015280314">source</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p63511528173110">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p123513283315">Chart source</p>
</td>
</tr>
<tr id="ListCharts__row14343128113114"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p33511528193116">icon_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p1435112863115">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p16351142818313">URL to chart icons</p>
</td>
</tr>
<tr id="ListCharts__row203437283318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p635142893111">public</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p1035292815313">Boolean</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p14352112853115">Whether the chart is public</p>
</td>
</tr>
<tr id="ListCharts__row33441728153118"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p20352192823116">chart_url</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p8352122812311">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p16352528193118">URL to the chart</p>
</td>
</tr>
<tr id="ListCharts__row7344152810318"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p535310287318">create_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p5353122853111">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p10353928143115">Created at</p>
</td>
</tr>
<tr id="ListCharts__row634472818314"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="ListCharts__p20353122815319">update_at</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="ListCharts__p4354152873120">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="ListCharts__p1635432823113">Updated at</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCharts__section1235442814313"><h4 class="sectiontitle">Example Requests</h4><p id="ListCharts__p9354192811311">None</p>
</div>
<div class="section" id="ListCharts__section1335482843111"><h4 class="sectiontitle">Example Responses</h4><p id="ListCharts__p1335415285313"><strong id="ListCharts__b1535520280312">Status code: 200</strong></p>
<p id="ListCharts__p13554287313">OK</p>
<pre class="screen" id="ListCharts__screen73552028173110">[ {
"id" : "1abd3bd6-0258-11ec-b8b0-0255ac100b05",
"name" : "magento-mysql",
"values" : "{\"basic\":{\"admin_password\":\"******\",\"admin_username\":\"username\",\"app_name\":\"magento\",\"mysql_database\":\"magento\",\"mysql_name\":\"mysql\",\"mysql_password\":\"******\",\"mysql_port\":3306,\"mysql_root_password\":\"******\",\"mysql_user\":\"magento\",\"storage_class\":\"csi-nas\",\"storage_mode\":\"ReadWriteMany\",\"storage_size\":\"10G\"},\"global\":{\"magento_EIP\":\"100.100.100.100\",\"magento_EPORT\":32080,\"namespace\":\"default\"},\"image\":{\"magento_image\":\"example.com/everest/magento:latest\",\"mysql_image\":\"example.com/everest/mysql:5.7.14\"}}",
"translate" : "",
"instruction" : "",
"version" : "1.0.0",
"description" : "chart description",
"source" : "",
"icon_url" : "https://example.com/magento-stack-110x117.png",
"public" : false,
"chart_url" : "magento-mysql-1.0.0.tgz",
"create_at" : "2021-08-20T08:00:29Z",
"update_at" : "2021-08-20T08:00:29Z"
} ]</pre>
</div>
<div class="section" id="ListCharts__section1535722811316"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="ListCharts__en-us_topic_0000001850048554_status_code" frame="border" border="1" rules="all"><thead align="left"><tr id="ListCharts__row5358028163120"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="ListCharts__p6358132843118">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="ListCharts__p63581128173120">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="ListCharts__row1535818280311"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="ListCharts__p935912843117">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="ListCharts__p1335962818314">OK</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="ListCharts__section1035942813116"><h4 class="sectiontitle">Error Codes</h4><p id="ListCharts__p5359172843112">See <a href="cce_02_0250.html">Error Codes</a>.</p>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="chart_lifecycle_management.html">Chart Management</a></div>
</div>
</div>
View Git Blame Copy Permalink