yexinru/doc-exports
1
0
Fork 0
forked from docs/doc-exports
Code Pull Requests Activity
Files
7310adf178164ec66a09347294abe2014afa8552
doc-exports/docs/asm/api-ref/asm_api_0103.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

425 lines
29 KiB
HTML
Raw Blame History

<a name="asm_api_0103"></a><a name="asm_api_0103"></a>
<h1 class="topictitle1">Querying a Service Mesh</h1>
<div id="body1707mcpsimp"><div class="section" id="asm_api_0103__section1708mcpsimp"><h4 class="sectiontitle">Function</h4><p id="asm_api_0103__p1710mcpsimp">This API is used to obtain details about a service mesh.</p>
</div>
<div class="section" id="asm_api_0103__section1711mcpsimp"><h4 class="sectiontitle">URI</h4><p id="asm_api_0103__p1713mcpsimp">GET /v1/meshes/{mesh_id}</p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table1714mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="asm_api_0103__row1722mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="asm_api_0103__p1724mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.2"><p id="asm_api_0103__p1726mcpsimp">Mandatory</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.3"><p id="asm_api_0103__p1728mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.2.3.2.5.1.4"><p id="asm_api_0103__p1730mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1732mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="asm_api_0103__p1734mcpsimp">mesh_id</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="asm_api_0103__p1736mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="asm_api_0103__p1738mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="asm_api_0103__p1740mcpsimp">Service mesh ID.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="asm_api_0103__section1741mcpsimp"><h4 class="sectiontitle">Request Parameters</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table1743mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="asm_api_0103__row1751mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="asm_api_0103__p1753mcpsimp">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_0103__p1755mcpsimp">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_0103__p1757mcpsimp">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_0103__p1759mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1761mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="asm_api_0103__p1763mcpsimp">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_0103__p1765mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="asm_api_0103__p1767mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="asm_api_0103__p1769mcpsimp">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_0103__row1770mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="asm_api_0103__p1772mcpsimp">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_0103__p1774mcpsimp">Yes</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="asm_api_0103__p1776mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="asm_api_0103__p1778mcpsimp">ID of the project that the service mesh belongs to.</p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="asm_api_0103__section1779mcpsimp"><h4 class="sectiontitle">Response Parameters</h4><p id="asm_api_0103__p1781mcpsimp"><strong id="asm_api_0103__b1782mcpsimp">Status code: 200</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table1783mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0103__row1790mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="asm_api_0103__p1792mcpsimp">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_0103__p1794mcpsimp">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_0103__p1796mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1798mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0103__p1800mcpsimp">apiVersion</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0103__p1802mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0103__p1804mcpsimp">API version. The value is fixed at <strong id="asm_api_0103__b164088272594656">v1</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="asm_api_0103__row1805mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0103__p1807mcpsimp">kind</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0103__p1809mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0103__p1811mcpsimp">API type. The value is fixed at <strong id="asm_api_0103__b193939086594656">Mesh</strong> or <strong id="asm_api_0103__b185374828794656">mesh</strong> and cannot be changed.</p>
</td>
</tr>
<tr id="asm_api_0103__row1812mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0103__p1814mcpsimp">metadata</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0103__p1816mcpsimp"><a href="#asm_api_0103___d1e2597">Table4 MeshMetadata</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0103__p1819mcpsimp">Basic information about the service mesh. Metadata is a collection of attributes.</p>
</td>
</tr>
<tr id="asm_api_0103__row1820mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0103__p1822mcpsimp">spec</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0103__p1824mcpsimp"><a href="#asm_api_0103___d1e2672">Table 5 MeshSpec</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0103__p1827mcpsimp">Detailed description of the service mesh. ASM creates or updates the service mesh by <strong id="asm_api_0103__b79940232394656">spec</strong>.</p>
</td>
</tr>
<tr id="asm_api_0103__row1828mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0103__p1830mcpsimp">status</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0103__p1832mcpsimp"><a href="#asm_api_0103___d1e2973">Table 8 MeshStatus</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0103__p1835mcpsimp">Service mesh status,</p>
<p id="asm_api_0103__p1836mcpsimp">which is automatically generated by ASM.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0103___d1e2597"></a><a name="_d1e2597"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103___d1e2597" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MeshMetadata</caption><thead align="left"><tr id="asm_api_0103__row1843mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="asm_api_0103__p1845mcpsimp">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_0103__p1847mcpsimp">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_0103__p1849mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1851mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0103__p1853mcpsimp">name</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0103__p1855mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0103__p1857mcpsimp">Service mesh name.</p>
</td>
</tr>
<tr id="asm_api_0103__row1858mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0103__p1860mcpsimp">uid</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0103__p1862mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0103__p1864mcpsimp">Service mesh ID, which is unique and automatically generated after the service mesh is created.</p>
</td>
</tr>
<tr id="asm_api_0103__row1881mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0103__p1883mcpsimp">creationTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0103__p1885mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0103__p1887mcpsimp">Time when the service mesh was created.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0103___d1e2672"></a><a name="_d1e2672"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103___d1e2672" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MeshSpec</caption><thead align="left"><tr id="asm_api_0103__row1894mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="asm_api_0103__p1896mcpsimp">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_0103__p1898mcpsimp">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_0103__p1900mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1902mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0103__p1904mcpsimp">region</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0103__p1906mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0103__p1908mcpsimp">Region where the control plane components of the service mesh are located.</p>
</td>
</tr>
<tr id="asm_api_0103__row1909mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0103__p1911mcpsimp">type</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0103__p1913mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0103__p1915mcpsimp">Service mesh type.</p>
<p id="asm_api_0103__p1916mcpsimp"><strong id="asm_api_0103__b1743711393355">InCluster</strong>: service mesh with an in-cluster control plane. The value is <strong id="asm_api_0103__b74371139173518">InCluster</strong> for the service mesh of the Basic edition.</p>
</td>
</tr>
<tr id="asm_api_0103__row1917mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0103__p1919mcpsimp">version</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0103__p1921mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0103__p1923mcpsimp">Service mesh version.</p>
</td>
</tr>
<tr id="asm_api_0103__row1924mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0103__p1926mcpsimp">extendParams</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0103__p1928mcpsimp"><a href="#asm_api_0103___d1e2735">Table 6 MeshExtendParams</a> object</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0103__p1931mcpsimp">Extensions of the service mesh.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0103___d1e2735"></a><a name="_d1e2735"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103___d1e2735" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MeshExtendParams</caption><thead align="left"><tr id="asm_api_0103__row1938mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="asm_api_0103__p1940mcpsimp">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_0103__p1942mcpsimp">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_0103__p1944mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1946mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="asm_api_0103__p1948mcpsimp">clusters</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="asm_api_0103__p1950mcpsimp">Array of <a href="#asm_api_0103___d1e2767">Table 7 MeshCluster</a> objects</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="asm_api_0103__p1953mcpsimp">Information about clusters in service meshes (only for the Basic edition).</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0103___d1e2767"></a><a name="_d1e2767"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103___d1e2767" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MeshCluster</caption><thead align="left"><tr id="asm_api_0103__row1960mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="asm_api_0103__p1962mcpsimp">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_0103__p1964mcpsimp">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_0103__p1966mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1968mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="asm_api_0103__p1970mcpsimp">clusterID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="asm_api_0103__p1972mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="asm_api_0103__p1974mcpsimp">Cluster ID, which is unique and can be used to query the cluster to be added.</p>
</td>
</tr>
<tr id="asm_api_0103__row1975mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="asm_api_0103__p1977mcpsimp">projectID</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="asm_api_0103__p1979mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="asm_api_0103__p1981mcpsimp">ID of the project that the cluster belongs to.</p>
</td>
</tr>
</tbody>
</table>
</div>
<div class="tablenoborder"><a name="asm_api_0103___d1e2973"></a><a name="_d1e2973"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103___d1e2973" frame="border" border="1" rules="all"><caption><b>Table 8 </b>MeshStatus</caption><thead align="left"><tr id="asm_api_0103__row1988mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.8.2.4.1.1"><p id="asm_api_0103__p1990mcpsimp">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_0103__p1992mcpsimp">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_0103__p1994mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row1996mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="asm_api_0103__p1998mcpsimp">phase</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="asm_api_0103__p2000mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="asm_api_0103__p2002mcpsimp">Service mesh status. The options are as follows:</p>
<ul id="asm_api_0103__ul2003mcpsimp"><li id="asm_api_0103__li2004mcpsimp"><strong id="asm_api_0103__b618911073715">Running</strong>: The service mesh is running.</li><li id="asm_api_0103__li2005mcpsimp"><strong id="asm_api_0103__b440001003712">Creating</strong>: The service mesh is being created.</li><li id="asm_api_0103__li2006mcpsimp"><strong id="asm_api_0103__b15293813123718">CreateFailed</strong>: The service mesh fails to be created.</li><li id="asm_api_0103__li2007mcpsimp"><strong id="asm_api_0103__b187459591894656">Deleting</strong>: The service mesh is being deleted.</li><li id="asm_api_0103__li2008mcpsimp"><strong id="asm_api_0103__b154390347594656">DeleteFailed</strong>: The service mesh fails to be deleted.</li><li id="asm_api_0103__li2009mcpsimp"><strong id="asm_api_0103__b108844299494656">Upgrading</strong>: The service mesh is being upgraded.</li><li id="asm_api_0103__li2010mcpsimp"><strong id="asm_api_0103__b4997874994656">UpgradeFailed</strong>: The service mesh fails to be upgraded.</li><li id="asm_api_0103__li2011mcpsimp"><strong id="asm_api_0103__b153175364994656">RollingBack</strong>: The service mesh is being rolled back.</li><li id="asm_api_0103__li2012mcpsimp"><strong id="asm_api_0103__b129983745994656">RollbackFailed</strong>: The service mesh fails to be rolled back.</li></ul>
</td>
</tr>
<tr id="asm_api_0103__row2013mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.1 "><p id="asm_api_0103__p2015mcpsimp">updateTimestamp</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.8.2.4.1.2 "><p id="asm_api_0103__p2017mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.8.2.4.1.3 "><p id="asm_api_0103__p2019mcpsimp">Time when the service mesh was updated.</p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="asm_api_0103__p2020mcpsimp"><strong id="asm_api_0103__b1973512395377">Status code: 400</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table2022mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 9 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0103__row2029mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.1"><p id="asm_api_0103__p2031mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.10.2.4.1.2"><p id="asm_api_0103__p2033mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.10.2.4.1.3"><p id="asm_api_0103__p2035mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row2037mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="asm_api_0103__p2039mcpsimp">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="asm_api_0103__p2041mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="asm_api_0103__p2043mcpsimp">Error code.</p>
<p id="asm_api_0103__p48227374461">Minimum length: <strong id="asm_api_0103__b682263715467">8</strong></p>
<p id="asm_api_0103__p3822193724620">Maximum length: <strong id="asm_api_0103__b109857548371">36</strong></p>
</td>
</tr>
<tr id="asm_api_0103__row2044mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.1 "><p id="asm_api_0103__p2046mcpsimp">errorMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.10.2.4.1.2 "><p id="asm_api_0103__p2048mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.10.2.4.1.3 "><p id="asm_api_0103__p2050mcpsimp">Error message.</p>
<p id="asm_api_0103__p1940517259169">Minimum length: <strong id="asm_api_0103__b11405725151620">2</strong></p>
<p id="asm_api_0103__p1940512514166">Maximum length: <strong id="asm_api_0103__b263713114381">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="asm_api_0103__p2051mcpsimp"><strong id="asm_api_0103__b15306171523819">Status code: 404</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table2053mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0103__row2060mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.1"><p id="asm_api_0103__p2062mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.12.2.4.1.2"><p id="asm_api_0103__p2064mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.12.2.4.1.3"><p id="asm_api_0103__p2066mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row2068mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="asm_api_0103__p2070mcpsimp">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="asm_api_0103__p2072mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="asm_api_0103__p2074mcpsimp">Error code.</p>
<p id="asm_api_0103__p99689371468">Minimum length: <strong id="asm_api_0103__b1196893719469">8</strong></p>
<p id="asm_api_0103__p3968637154619">Maximum length: <strong id="asm_api_0103__b172661436144317">36</strong></p>
</td>
</tr>
<tr id="asm_api_0103__row2075mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.1 "><p id="asm_api_0103__p2077mcpsimp">errorMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.12.2.4.1.2 "><p id="asm_api_0103__p2079mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.12.2.4.1.3 "><p id="asm_api_0103__p2081mcpsimp">Error message.</p>
<p id="asm_api_0103__p2835193719469">Minimum length: <strong id="asm_api_0103__b18835837164613">2</strong></p>
<p id="asm_api_0103__p883510373460">Maximum length: <strong id="asm_api_0103__b530164584317">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
<p id="asm_api_0103__p2082mcpsimp"><strong id="asm_api_0103__b2083mcpsimp">Status code: 500</strong></p>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table2084mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 11 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0103__row2091mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="asm_api_0103__p2093mcpsimp">Parameter</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.2"><p id="asm_api_0103__p2095mcpsimp">Type</p>
</th>
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.14.2.4.1.3"><p id="asm_api_0103__p2097mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row2099mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="asm_api_0103__p2101mcpsimp">errorCode</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="asm_api_0103__p2103mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="asm_api_0103__p2105mcpsimp">Error code.</p>
<p id="asm_api_0103__p186901495161">Minimum length: <strong id="asm_api_0103__b6690292169">8</strong></p>
<p id="asm_api_0103__p16690159201617">Maximum length: <strong id="asm_api_0103__b19930459144319">36</strong></p>
</td>
</tr>
<tr id="asm_api_0103__row2106mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="asm_api_0103__p2108mcpsimp">errorMsg</p>
</td>
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="asm_api_0103__p2110mcpsimp">String</p>
</td>
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="asm_api_0103__p2112mcpsimp">Error message.</p>
<p id="asm_api_0103__p542281851618">Minimum length: <strong id="asm_api_0103__b194221918111614">2</strong></p>
<p id="asm_api_0103__p204221718111612">Maximum length: <strong id="asm_api_0103__b157463131441">512</strong></p>
</td>
</tr>
</tbody>
</table>
</div>
</div>
<div class="section" id="asm_api_0103__section2113mcpsimp"><h4 class="sectiontitle">Example Request</h4><p id="asm_api_0103__p2115mcpsimp">None</p>
</div>
<div class="section" id="asm_api_0103__section2116mcpsimp"><h4 class="sectiontitle">Example Response</h4><p id="asm_api_0103__p2118mcpsimp"><strong id="asm_api_0103__b1118752514441">Status code: 200</strong></p>
<p id="asm_api_0103__p2120mcpsimp">The details about the service mesh are obtained.</p>
<pre class="screen" id="asm_api_0103__screen2121mcpsimp">{
"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": "729f4f96-5790-xxxx-xxxx-f9afaac38726",
"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_0103__section2122mcpsimp"><h4 class="sectiontitle">Status Codes</h4>
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0103__table2124mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="asm_api_0103__row2129mcpsimp"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="asm_api_0103__p2131mcpsimp">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_0103__p2133mcpsimp">Description</p>
</th>
</tr>
</thead>
<tbody><tr id="asm_api_0103__row2135mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0103__p2137mcpsimp">200</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0103__p2139mcpsimp">The details about the service mesh are obtained.</p>
</td>
</tr>
<tr id="asm_api_0103__row2140mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0103__p2142mcpsimp">400</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0103__p2144mcpsimp">Verification failed due to incorrect parameters for obtaining the details about the service mesh.</p>
</td>
</tr>
<tr id="asm_api_0103__row2145mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0103__p2147mcpsimp">404</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0103__p2149mcpsimp">The specified service mesh is not found.</p>
</td>
</tr>
<tr id="asm_api_0103__row2150mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0103__p2152mcpsimp">500</p>
</td>
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0103__p2154mcpsimp">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