yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
c5d2d3b6dc5789a66b755b1ee4d30fcbb6efa06d
doc-exports/docs/asm/api-ref/asm_api_0104.html
qiujiandong1 0a1983aa72 ASM API initial version 20240430 
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-10 11:27:25 +00:00

431 lines
29 KiB
HTML
Raw Blame History

<a name="asm_api_0104"></a><a name="asm_api_0104"></a>
<h1 class="topictitle1">Querying the Service Mesh List</h1>
<div id="body2158mcpsimp"><div class="section" id="asm_api_0104__section2159mcpsimp"><h4 class="sectiontitle">Function</h4><p id="asm_api_0104__p2161mcpsimp">This API is used to obtain details about all service meshes.</p>
</div>
<div class="section" id="asm_api_0104__section2162mcpsimp"><h4 class="sectiontitle">URI</h4><p id="asm_api_0104__p2164mcpsimp">GET /v1/meshes</p>
</div>
<div class="section" id="asm_api_0104__section2165mcpsimp"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104__table2167mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Request header parameters</caption><thead align="left"><tr id="asm_api_0104__row2175mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="asm_api_0104__p2177mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.2"><p id="asm_api_0104__p2179mcpsimp">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.3"><p id="asm_api_0104__p2181mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.2.2.5.1.4"><p id="asm_api_0104__p2183mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2185mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="asm_api_0104__p2187mcpsimp">X-Auth-Token</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="asm_api_0104__p2189mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="asm_api_0104__p2191mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="asm_api_0104__p2193mcpsimp">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.</p>
</td>
</tr>
<tr id="asm_api_0104__row2194mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="asm_api_0104__p2196mcpsimp">X-Apply-ProjectID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="asm_api_0104__p2198mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="asm_api_0104__p2200mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="asm_api_0104__p2202mcpsimp">ID of the project that the service mesh belongs to.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="asm_api_0104__section2203mcpsimp"><h4 class="sectiontitle">Response Parameters</h4><p id="asm_api_0104__p2205mcpsimp"><strong id="asm_api_0104__b187621556389">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104__table2207mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0104__row2214mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="asm_api_0104__p2216mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.2"><p id="asm_api_0104__p2218mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.3.2.4.1.3"><p id="asm_api_0104__p2220mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2222mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0104__p2224mcpsimp">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0104__p2226mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0104__p2228mcpsimp">API version. The value is fixed at <strong id="asm_api_0104__b167952452494647">v1</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="asm_api_0104__row2229mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0104__p2231mcpsimp">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0104__p2233mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0104__p2235mcpsimp">API type. The value is fixed at <strong id="asm_api_0104__b3212995194647">MeshList</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="asm_api_0104__row2236mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0104__p2238mcpsimp">items</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0104__p2240mcpsimp">Array of <a href="#asm_api_0104___d1e3384">Table 3 Mesh</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0104__p2243mcpsimp">Service mesh list.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0104___d1e3384"></a><a name="_d1e3384"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104___d1e3384" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Mesh</caption><thead align="left"><tr id="asm_api_0104__row2250mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="asm_api_0104__p2252mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.2"><p id="asm_api_0104__p2254mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.4.2.4.1.3"><p id="asm_api_0104__p2256mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2258mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0104__p2260mcpsimp">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0104__p2262mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0104__p2264mcpsimp">API version. The value is fixed at <strong id="asm_api_0104__b163339840494647">v1</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="asm_api_0104__row2265mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0104__p2267mcpsimp">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0104__p2269mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0104__p2271mcpsimp">API type. The value is fixed at <strong id="asm_api_0104__b105217845694647">Mesh</strong> or <strong id="asm_api_0104__b2381982794647">mesh</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="asm_api_0104__row2272mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0104__p2274mcpsimp">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0104__p2276mcpsimp"><a href="#asm_api_0104___d1e3461">Table 4 MeshMetadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0104__p2279mcpsimp">Basic information about the service mesh. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="asm_api_0104__row2280mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0104__p2282mcpsimp">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0104__p2284mcpsimp"><a href="#asm_api_0104___d1e3536">Table 5 MeshSpec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0104__p1827mcpsimp">Detailed description of the service mesh. ASM creates or updates the service mesh by <strong id="asm_api_0104__b918775053114021">spec</strong>.</p>
</td>
</tr>
<tr id="asm_api_0104__row2288mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0104__p2290mcpsimp">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0104__p2292mcpsimp"><a href="#asm_api_0104___d1e3837">Table 8 MeshStatus</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0104__p1835mcpsimp">Service mesh status,</p>
<p id="asm_api_0104__p1836mcpsimp">which is automatically generated by ASM.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0104___d1e3461"></a><a name="_d1e3461"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104___d1e3461" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MeshMetadata</caption><thead align="left"><tr id="asm_api_0104__row2303mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="asm_api_0104__p2305mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.2"><p id="asm_api_0104__p2307mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.5.2.4.1.3"><p id="asm_api_0104__p2309mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2311mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0104__p2313mcpsimp">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0104__p2315mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0104__p2317mcpsimp">Service mesh name.</p>
</td>
</tr>
<tr id="asm_api_0104__row2318mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0104__p2320mcpsimp">uid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0104__p2322mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0104__p2324mcpsimp">Service mesh ID, which is unique and automatically generated after the service mesh is created.</p>
</td>
</tr>
<tr id="asm_api_0104__row2341mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0104__p2343mcpsimp">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0104__p2345mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0104__p2347mcpsimp">Time when the service mesh was created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0104___d1e3536"></a><a name="_d1e3536"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104___d1e3536" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MeshSpec</caption><thead align="left"><tr id="asm_api_0104__row2354mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="asm_api_0104__p2356mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.2"><p id="asm_api_0104__p2358mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.6.2.4.1.3"><p id="asm_api_0104__p2360mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2362mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="asm_api_0104__p2364mcpsimp">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="asm_api_0104__p2366mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="asm_api_0104__p2368mcpsimp">Region where the control plane components of the service mesh are located.</p>
</td>
</tr>
<tr id="asm_api_0104__row2369mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="asm_api_0104__p2371mcpsimp">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="asm_api_0104__p2373mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="asm_api_0104__p2375mcpsimp">Service mesh type.</p>
<p id="asm_api_0104__p2376mcpsimp"><strong id="asm_api_0104__b4651452101120">InCluster</strong>: service mesh with an in-cluster control plane. The value is <strong id="asm_api_0104__b56529526115">InCluster</strong> for the service mesh of the Basic edition.</p>
</td>
</tr>
<tr id="asm_api_0104__row2377mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="asm_api_0104__p2379mcpsimp">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="asm_api_0104__p2381mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="asm_api_0104__p2383mcpsimp">Service mesh version.</p>
</td>
</tr>
<tr id="asm_api_0104__row2384mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="asm_api_0104__p2386mcpsimp">extendParams</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="asm_api_0104__p2388mcpsimp"><a href="#asm_api_0104___d1e3599">Table 6 MeshExtendParams</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="asm_api_0104__p2391mcpsimp">Extensions of the service mesh.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0104___d1e3599"></a><a name="_d1e3599"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104___d1e3599" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MeshExtendParams</caption><thead align="left"><tr id="asm_api_0104__row2398mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="asm_api_0104__p2400mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.2"><p id="asm_api_0104__p2402mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.7.2.4.1.3"><p id="asm_api_0104__p2404mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2406mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="asm_api_0104__p2408mcpsimp">clusters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="asm_api_0104__p2410mcpsimp">Array of <a href="#asm_api_0104___d1e3631">Table 7 MeshCluster</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="asm_api_0104__p2413mcpsimp">Information about clusters in service meshes (only for the Basic edition).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0104___d1e3631"></a><a name="_d1e3631"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104___d1e3631" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MeshCluster</caption><thead align="left"><tr id="asm_api_0104__row2420mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="asm_api_0104__p2422mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.2"><p id="asm_api_0104__p2424mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.8.2.4.1.3"><p id="asm_api_0104__p2426mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2428mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="asm_api_0104__p2430mcpsimp">clusterID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="asm_api_0104__p2432mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="asm_api_0104__p2434mcpsimp">Cluster ID, which is unique and can be used to query the cluster to be added.</p>
</td>
</tr>
<tr id="asm_api_0104__row2435mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="asm_api_0104__p2437mcpsimp">projectID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="asm_api_0104__p2439mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="asm_api_0104__p2441mcpsimp">ID of the project that the cluster belongs to.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0104___d1e3837"></a><a name="_d1e3837"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104___d1e3837" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MeshStatus</caption><thead align="left"><tr id="asm_api_0104__row2448mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.1"><p id="asm_api_0104__p2450mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.9.2.4.1.2"><p id="asm_api_0104__p2452mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.9.2.4.1.3"><p id="asm_api_0104__p2454mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2456mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0104__p2458mcpsimp">phase</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0104__p2460mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0104__p2462mcpsimp">Service mesh status. The options are as follows:</p>
<ul id="asm_api_0104__ul2463mcpsimp"><li id="asm_api_0104__li2464mcpsimp"><strong id="asm_api_0104__b2030220141312">Running</strong>: The service mesh is running.</li><li id="asm_api_0104__li2465mcpsimp"><strong id="asm_api_0104__b187371655894647">Creating</strong>: The service mesh is being created.</li><li id="asm_api_0104__li2466mcpsimp"><strong id="asm_api_0104__b66267437594647">CreateFailed</strong>: The service mesh fails to be created.</li><li id="asm_api_0104__li2467mcpsimp"><strong id="asm_api_0104__b38458925494647">Deleting</strong>: The service mesh is being deleted.</li><li id="asm_api_0104__li2468mcpsimp"><strong id="asm_api_0104__b47258177394647">DeleteFailed</strong>: The service mesh fails to be deleted.</li><li id="asm_api_0104__li2469mcpsimp"><strong id="asm_api_0104__b133879567194647">Upgrading</strong>: The service mesh is being upgraded.</li><li id="asm_api_0104__li2470mcpsimp"><strong id="asm_api_0104__b63267076994647">UpgradeFailed</strong>: The service mesh fails to be upgraded.</li><li id="asm_api_0104__li2471mcpsimp"><strong id="asm_api_0104__b32283035994647">RollingBack</strong>: The service mesh is being rolled back.</li><li id="asm_api_0104__li2472mcpsimp"><strong id="asm_api_0104__b171229920394647">RollbackFailed</strong>: The service mesh fails to be rolled back.</li></ul>
</td>
</tr>
<tr id="asm_api_0104__row2473mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0104__p2475mcpsimp">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0104__p2477mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0104__p2479mcpsimp">Time when the service mesh was updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="asm_api_0104__p2480mcpsimp"><strong id="asm_api_0104__b27415200137">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104__table2482mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0104__row2489mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.1"><p id="asm_api_0104__p2491mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.11.2.4.1.2"><p id="asm_api_0104__p2493mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.11.2.4.1.3"><p id="asm_api_0104__p2495mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2497mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="asm_api_0104__p2499mcpsimp">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="asm_api_0104__p2501mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="asm_api_0104__p2503mcpsimp">Error code.</p>
<p id="asm_api_0104__p36891437111519">Minimum length: <strong id="asm_api_0104__b196891937191514">8</strong></p>
<p id="asm_api_0104__p17689143711153">Maximum length: <strong id="asm_api_0104__b5469153771316">36</strong></p>
</td>
</tr>
<tr id="asm_api_0104__row2504mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.1 "><p id="asm_api_0104__p2506mcpsimp">errorMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.11.2.4.1.2 "><p id="asm_api_0104__p2508mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.11.2.4.1.3 "><p id="asm_api_0104__p2510mcpsimp">Error message.</p>
<p id="asm_api_0104__p413643213156">Minimum length: <strong id="asm_api_0104__b15136432141511">2</strong></p>
<p id="asm_api_0104__p1413653215153">Maximum length: <strong id="asm_api_0104__b1619734615138">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="asm_api_0104__p2511mcpsimp"><strong id="asm_api_0104__b2512mcpsimp">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104__table2513mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0104__row2520mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.1"><p id="asm_api_0104__p2522mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.13.2.4.1.2"><p id="asm_api_0104__p2524mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.13.2.4.1.3"><p id="asm_api_0104__p2526mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2528mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="asm_api_0104__p2530mcpsimp">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="asm_api_0104__p2532mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="asm_api_0104__p2534mcpsimp">Error code.</p>
<p id="asm_api_0104__p99689371468">Minimum length: <strong id="asm_api_0104__b1196893719469">8</strong></p>
<p id="asm_api_0104__p3968637154619">Maximum length: <strong id="asm_api_0104__b83144188144">36</strong></p>
</td>
</tr>
<tr id="asm_api_0104__row2535mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.1 "><p id="asm_api_0104__p2537mcpsimp">errorMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.13.2.4.1.2 "><p id="asm_api_0104__p2539mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.13.2.4.1.3 "><p id="asm_api_0104__p2541mcpsimp">Error message.</p>
<p id="asm_api_0104__p109684373467">Minimum length: <strong id="asm_api_0104__b189512717147">2</strong></p>
<p id="asm_api_0104__p99681137134610">Maximum length: <strong id="asm_api_0104__b1351133116149">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="asm_api_0104__section2542mcpsimp"><h4 class="sectiontitle">Example Request</h4><p id="asm_api_0104__p2544mcpsimp">None</p>
</div>
<div class="section" id="asm_api_0104__section2545mcpsimp"><h4 class="sectiontitle">Example Response</h4><p id="asm_api_0104__p2547mcpsimp"><strong id="asm_api_0104__b12550544171417">Status code: 200</strong></p>
<p id="asm_api_0104__p2549mcpsimp">The details about all service meshes are obtained.</p>
<pre class="screen" id="asm_api_0104__screen2550mcpsimp">{
"kind" : "MeshList",
"apiVersion" : "v1",
"items" : [ {
"kind" : "Mesh",
"apiVersion" : "v1",
"metadata" : {
"name" : "mesh-test-api1",
"uid" : "b0906529-5871-xxxx-xxxx-8f93784d267c",
"creationTimestamp" : "2024-12-10T07:29:37Z"
},
"spec" : {
"domainID": "06e6bafb794746xxxxxxxx536497ea95",
"region" : "eu-de-01",
"type" : "InCluster",
"version" : "1.15.7-r4",
"extendParams" : {
"clusters" : [ {
"clusterID" : "8df4c986-b052-xxxx-xxxx-0255ac101231",
"meshID": "b0906529-5871-xxxx-xxxx-8f93784d267c",
"region": "eu-de-01",
"projectID" : "719217bc273743xxxxxxxxae8bc34480"
"provider": "CCE",
"proxyMode": "sidecar"
} ]
}
},
"status" : {
"phase" : "Running",
"updateTimestamp" : "2024-12-10T07:36:42Z"
}
}, {
"kind" : "Mesh",
"apiVersion" : "v1",
"metadata" : {
"name" : "mesh-test-api1",
"uid" : "b6b976fa-8c96-xxxx-xxxx-42e03a0cb8ab",
"creationTimestamp" : "2024-12-03T11:37:50Z"
},
"spec" : {
"domainID": "06e6bafb794746xxxxxxxx536497ea95",
"region" : "eu-de-01",
"type" : "InCluster",
"version" : "1.18.7-r4",
"extendParams" : {
"clusters" : [ {
"clusterID" : "12ce3034-294c-xxxx-xxxx-0255ac1001ba",
"meshID": "b6b976fa-8c96-xxxx-xxxx-42e03a0cb8ab",
"region": "eu-de-01",
"projectID" : "719217bc273743xxxxxxxxae8bc34480",
"provider": "CCE",
"proxyMode": "sidecar"
} ]
}
},
"status" : {
"phase" : "Running",
"updateTimestamp" : "2024-12-10T07:36:42Z"
}
} ]
}</pre>
</div>
<div class="section" id="asm_api_0104__section2551mcpsimp"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0104__table2553mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="asm_api_0104__row2558mcpsimp"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="asm_api_0104__p2560mcpsimp">Status Code</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="85%" id="mcps1.3.7.2.1.3.1.2"><p id="asm_api_0104__p2562mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0104__row2564mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0104__p2566mcpsimp">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0104__p2568mcpsimp">The details about all service meshes are obtained.</p>
</td>
</tr>
<tr id="asm_api_0104__row2569mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0104__p2571mcpsimp">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0104__p2573mcpsimp">Verification failed due to incorrect parameters for obtaining the details about all service meshes.</p>
</td>
</tr>
<tr id="asm_api_0104__row2574mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0104__p2576mcpsimp">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0104__p2578mcpsimp">An error occurs during the service mesh query.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div>
<div class="familylinks">
<div class="parentlink"><strong>Parent topic:</strong> <a href="asm_api_0100.html">Service Mesh APIs</a></div>
</div>
</div>
View Git Blame Copy Permalink