forked from docs/doc-exports
qiujiandong1
d7efa23b27
Reviewed-by: Eotvos, Oliver <oliver.eotvos@t-systems.com> Co-authored-by: qiujiandong1 <qiujiandong1@huawei.com> Co-committed-by: qiujiandong1 <qiujiandong1@huawei.com>
1214 lines
83 KiB
HTML
1214 lines
83 KiB
HTML
<a name="asm_api_0101"></a><a name="asm_api_0101"></a>
|
|
|
|
<h1 class="topictitle1">Creating a Service Mesh</h1>
|
|
<div id="body221mcpsimp"><div class="section" id="asm_api_0101__section222mcpsimp"><h4 class="sectiontitle">Function</h4><p id="asm_api_0101__p224mcpsimp">This API is used to create a service mesh.</p>
|
|
</div>
|
|
<div class="section" id="asm_api_0101__section225mcpsimp"><h4 class="sectiontitle">URI</h4><p id="asm_api_0101__p227mcpsimp">POST /v1/{project_id}/meshes</p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table1606mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 1 </b>Path parameters</caption><thead align="left"><tr id="asm_api_0101__row1614mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.2.3.2.5.1.1"><p id="asm_api_0101__p1616mcpsimp">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_0101__p1618mcpsimp">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_0101__p1620mcpsimp">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_0101__p1622mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row1624mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.1 "><p id="asm_api_0101__p1626mcpsimp">project_id</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.2 "><p id="asm_api_0101__p1628mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.2.3.2.5.1.3 "><p id="asm_api_0101__p1630mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.2.3.2.5.1.4 "><p id="asm_api_0101__p1632mcpsimp">Project ID.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="asm_api_0101__section228mcpsimp"><h4 class="sectiontitle">Request Parameters</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table230mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 2 </b>Request header parameters</caption><thead align="left"><tr id="asm_api_0101__row238mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.2.2.5.1.1"><p id="asm_api_0101__p240mcpsimp">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_0101__p242mcpsimp">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_0101__p244mcpsimp">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_0101__p246mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row248mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="asm_api_0101__p250mcpsimp">Content-Type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.2 "><p id="asm_api_0101__p252mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="asm_api_0101__p254mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="asm_api_0101__p256mcpsimp">Message body type or format.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row257mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.1 "><p id="asm_api_0101__p259mcpsimp">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_0101__p261mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.2.2.5.1.3 "><p id="asm_api_0101__p263mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.2.2.5.1.4 "><p id="asm_api_0101__p265mcpsimp">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>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table275mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 3 </b>Parameters in the request body</caption><thead align="left"><tr id="asm_api_0101__row283mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.1"><p id="asm_api_0101__p285mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.2"><p id="asm_api_0101__p287mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.3.2.5.1.3"><p id="asm_api_0101__p289mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.3.2.5.1.4"><p id="asm_api_0101__p291mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row293mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="asm_api_0101__p295mcpsimp">apiVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="asm_api_0101__p297mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="asm_api_0101__p299mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="asm_api_0101__p301mcpsimp">API version. The value is fixed at <strong id="asm_api_0101__b51077205394713">v1</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row302mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="asm_api_0101__p304mcpsimp">kind</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="asm_api_0101__p306mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="asm_api_0101__p308mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="asm_api_0101__p310mcpsimp">API type. The value is fixed at <strong id="asm_api_0101__b169540079294713">Mesh</strong> or <strong id="asm_api_0101__b119836493694713">mesh</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row311mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="asm_api_0101__p313mcpsimp">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="asm_api_0101__p315mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="asm_api_0101__p317mcpsimp"><a href="#asm_api_0101___request_MeshMetadata">Table 4</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="asm_api_0101__p320mcpsimp">Basic information about the service mesh. Metadata is a collection of attributes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row321mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.1 "><p id="asm_api_0101__p323mcpsimp">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.2 "><p id="asm_api_0101__p325mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.3.2.5.1.3 "><p id="asm_api_0101__p327mcpsimp"><a href="#asm_api_0101___request_MeshSpec">Table 5</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.3.2.5.1.4 "><p id="asm_api_0101__p330mcpsimp">Detailed description of the service mesh. ASM creates or updates the service mesh by <strong id="asm_api_0101__b162788137494713">spec</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_MeshMetadata"></a><a name="_request_MeshMetadata"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_MeshMetadata" frame="border" border="1" rules="all"><caption><b>Table 4 </b>MeshMetadata</caption><thead align="left"><tr id="asm_api_0101__row338mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.1"><p id="asm_api_0101__p340mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.2"><p id="asm_api_0101__p342mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.4.2.5.1.3"><p id="asm_api_0101__p344mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.4.2.5.1.4"><p id="asm_api_0101__p346mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row348mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.1 "><p id="asm_api_0101__p350mcpsimp">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.2 "><p id="asm_api_0101__p352mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.4.2.5.1.3 "><p id="asm_api_0101__p354mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.4.2.5.1.4 "><p id="asm_api_0101__p356mcpsimp">Service mesh name.</p>
|
|
<p id="asm_api_0101__p357mcpsimp">Enter 4 to 64 characters. The name must start with a lowercase letter and not end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_MeshSpec"></a><a name="_request_MeshSpec"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_MeshSpec" frame="border" border="1" rules="all"><caption><b>Table 5 </b>MeshSpec</caption><thead align="left"><tr id="asm_api_0101__row394mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.1"><p id="asm_api_0101__p396mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.2"><p id="asm_api_0101__p398mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.5.2.5.1.3"><p id="asm_api_0101__p400mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.5.2.5.1.4"><p id="asm_api_0101__p402mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row413mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="asm_api_0101__p415mcpsimp">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="asm_api_0101__p417mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="asm_api_0101__p419mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="asm_api_0101__p421mcpsimp">Service mesh type.</p>
|
|
<p id="asm_api_0101__p422mcpsimp"><strong id="asm_api_0101__b40679186194713">InCluster</strong>: service mesh with an in-cluster control plane. The value is <strong id="asm_api_0101__b204932299794713">InCluster</strong> for the service mesh of the Basic edition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row423mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="asm_api_0101__p425mcpsimp">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="asm_api_0101__p427mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="asm_api_0101__p429mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="asm_api_0101__p431mcpsimp">Service mesh version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row432mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="asm_api_0101__p434mcpsimp">extendParams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="asm_api_0101__p436mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="asm_api_0101__p438mcpsimp"><a href="#asm_api_0101___request_MeshExtendParams">Table 6</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="asm_api_0101__p441mcpsimp">Extensions of the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row11734746123019"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="asm_api_0101__p1802mcpsimp">ipv6Enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="asm_api_0101__p1804mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="asm_api_0101__p1806mcpsimp">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="asm_api_0101__p1808mcpsimp">Whether the service mesh supports IPv6.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row77349461304"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.1 "><p id="asm_api_0101__p1811mcpsimp">config</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.2 "><p id="asm_api_0101__p1813mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.5.2.5.1.3 "><p id="asm_api_0101__p1815mcpsimp"><a href="#asm_api_0101___request_MeshConfig">Table 12</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.5.2.5.1.4 "><p id="asm_api_0101__p1818mcpsimp">Service mesh configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_MeshExtendParams"></a><a name="_request_MeshExtendParams"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_MeshExtendParams" frame="border" border="1" rules="all"><caption><b>Table 6 </b>MeshExtendParams</caption><thead align="left"><tr id="asm_api_0101__row449mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.1"><p id="asm_api_0101__p451mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.2"><p id="asm_api_0101__p453mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.6.2.5.1.3"><p id="asm_api_0101__p455mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.6.2.5.1.4"><p id="asm_api_0101__p457mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row459mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.1 "><p id="asm_api_0101__p461mcpsimp">clusters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.2 "><p id="asm_api_0101__p463mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.6.2.5.1.3 "><p id="asm_api_0101__p465mcpsimp">Array of <a href="#asm_api_0101___request_MeshCluster">Table 7</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.6.2.5.1.4 "><p id="asm_api_0101__p468mcpsimp">Cluster information in the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_MeshCluster"></a><a name="_request_MeshCluster"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_MeshCluster" frame="border" border="1" rules="all"><caption><b>Table 7 </b>MeshCluster</caption><thead align="left"><tr id="asm_api_0101__row476mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.1"><p id="asm_api_0101__p478mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.2"><p id="asm_api_0101__p480mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.7.2.5.1.3"><p id="asm_api_0101__p482mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.7.2.5.1.4"><p id="asm_api_0101__p484mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row486mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="asm_api_0101__p488mcpsimp">clusterID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="asm_api_0101__p490mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="asm_api_0101__p492mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="asm_api_0101__p494mcpsimp">Cluster ID, which is unique and can be used to query the cluster to be added.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row504mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="asm_api_0101__p506mcpsimp">injection</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="asm_api_0101__p508mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="asm_api_0101__p510mcpsimp"><a href="#asm_api_0101___request_InjectionConfig">Table 8</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="asm_api_0101__p513mcpsimp">Sidecar injection configuration.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row514mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.1 "><p id="asm_api_0101__p516mcpsimp">installation</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.2 "><p id="asm_api_0101__p518mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.7.2.5.1.3 "><p id="asm_api_0101__p520mcpsimp"><a href="#asm_api_0101___request_InstallationConfig">Table 9</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.7.2.5.1.4 "><p id="asm_api_0101__p523mcpsimp">Installation configuration of service mesh components.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_InjectionConfig"></a><a name="_request_InjectionConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_InjectionConfig" frame="border" border="1" rules="all"><caption><b>Table 8 </b>InjectionConfig</caption><thead align="left"><tr id="asm_api_0101__row531mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.1"><p id="asm_api_0101__p533mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.2"><p id="asm_api_0101__p535mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.8.2.5.1.3"><p id="asm_api_0101__p537mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.8.2.5.1.4"><p id="asm_api_0101__p539mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row541mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.1 "><p id="asm_api_0101__p543mcpsimp">namespaces</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.2 "><p id="asm_api_0101__p545mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.8.2.5.1.3 "><p id="asm_api_0101__p547mcpsimp"><a href="#asm_api_0101___request_Selector">Table 10</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.8.2.5.1.4 "><p id="asm_api_0101__p550mcpsimp">Namespaces where sidecars to be injected.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_InstallationConfig"></a><a name="_request_InstallationConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_InstallationConfig" frame="border" border="1" rules="all"><caption><b>Table 9 </b>InstallationConfig</caption><thead align="left"><tr id="asm_api_0101__row558mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.1"><p id="asm_api_0101__p560mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.2"><p id="asm_api_0101__p562mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.9.2.5.1.3"><p id="asm_api_0101__p564mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.9.2.5.1.4"><p id="asm_api_0101__p566mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row568mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.1 "><p id="asm_api_0101__p570mcpsimp">nodes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.2 "><p id="asm_api_0101__p572mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.9.2.5.1.3 "><p id="asm_api_0101__p574mcpsimp"><a href="#asm_api_0101___request_Selector">Table 10</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.9.2.5.1.4 "><p id="asm_api_0101__p577mcpsimp">Nodes where service mesh components are installed.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_Selector"></a><a name="_request_Selector"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_Selector" frame="border" border="1" rules="all"><caption><b>Table 10 </b>Selector</caption><thead align="left"><tr id="asm_api_0101__row585mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.1"><p id="asm_api_0101__p587mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.2"><p id="asm_api_0101__p589mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.10.2.5.1.3"><p id="asm_api_0101__p591mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.10.2.5.1.4"><p id="asm_api_0101__p593mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row595mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.1 "><p id="asm_api_0101__p597mcpsimp">fieldSelector</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.2 "><p id="asm_api_0101__p599mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.10.2.5.1.3 "><p id="asm_api_0101__p601mcpsimp"><a href="#asm_api_0101___request_FieldSelector">Table 11</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.10.2.5.1.4 "><p id="asm_api_0101__p604mcpsimp">Field selector.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_FieldSelector"></a><a name="_request_FieldSelector"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_FieldSelector" frame="border" border="1" rules="all"><caption><b>Table 11 </b>FieldSelector</caption><thead align="left"><tr id="asm_api_0101__row612mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.1"><p id="asm_api_0101__p614mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.2"><p id="asm_api_0101__p616mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.11.2.5.1.3"><p id="asm_api_0101__p618mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.11.2.5.1.4"><p id="asm_api_0101__p620mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row622mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="asm_api_0101__p624mcpsimp">key</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.2 "><p id="asm_api_0101__p626mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="asm_api_0101__p628mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.11.2.5.1.4 "><p id="asm_api_0101__p630mcpsimp">Key.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row631mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="asm_api_0101__p633mcpsimp">operator</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.2 "><p id="asm_api_0101__p635mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="asm_api_0101__p637mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.11.2.5.1.4 "><p id="asm_api_0101__p639mcpsimp">Operator. The value can only be <strong id="asm_api_0101__b186989904694713">In</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row640mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.1 "><p id="asm_api_0101__p642mcpsimp">values</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.2 "><p id="asm_api_0101__p644mcpsimp">Yes</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.11.2.5.1.3 "><p id="asm_api_0101__p646mcpsimp">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.11.2.5.1.4 "><p id="asm_api_0101__p648mcpsimp">Values.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_MeshConfig"></a><a name="_request_MeshConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_MeshConfig" frame="border" border="1" rules="all"><caption><b>Table 12 </b>MeshConfig</caption><thead align="left"><tr id="asm_api_0101__row2024mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.1"><p id="asm_api_0101__p2026mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.2"><p id="asm_api_0101__p2028mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.12.2.5.1.3"><p id="asm_api_0101__p2030mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.12.2.5.1.4"><p id="asm_api_0101__p2032mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2034mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="asm_api_0101__p2036mcpsimp">proxyConfig</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.2 "><p id="asm_api_0101__p2038mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="asm_api_0101__p2040mcpsimp"><a href="#asm_api_0101___request_ProxyConfig">Table 13</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.12.2.5.1.4 "><p id="asm_api_0101__p2043mcpsimp">Data plane configuration of the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2044mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.1 "><p id="asm_api_0101__p2046mcpsimp">telemetryConfig</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.2 "><p id="asm_api_0101__p2048mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.12.2.5.1.3 "><p id="asm_api_0101__p2050mcpsimp"><a href="#asm_api_0101___request_TelemetryConfig">Table 14</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.12.2.5.1.4 "><p id="asm_api_0101__p2053mcpsimp">Observability configuration of the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_ProxyConfig"></a><a name="_request_ProxyConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_ProxyConfig" frame="border" border="1" rules="all"><caption><b>Table 13 </b>ProxyConfig</caption><thead align="left"><tr id="asm_api_0101__row2061mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.13.2.5.1.1"><p id="asm_api_0101__p2063mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.13.2.5.1.2"><p id="asm_api_0101__p2065mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.13.2.5.1.3"><p id="asm_api_0101__p2067mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.13.2.5.1.4"><p id="asm_api_0101__p2069mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2071mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="asm_api_0101__p2073mcpsimp">includeIPRanges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.2 "><p id="asm_api_0101__p2075mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="asm_api_0101__p2077mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.13.2.5.1.4 "><p id="asm_api_0101__p2079mcpsimp">IP address ranges that will be included for outbound traffic redirection. Use commas (,) to separate the IP address ranges.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2080mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="asm_api_0101__p2082mcpsimp">excludeIPRanges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.2 "><p id="asm_api_0101__p2084mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="asm_api_0101__p2086mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.13.2.5.1.4 "><p id="asm_api_0101__p2088mcpsimp">IP address ranges that will be excluded for outbound traffic redirection. Use commas (,) to separate the IP address ranges.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2089mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="asm_api_0101__p2091mcpsimp">excludeOutboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.2 "><p id="asm_api_0101__p2093mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="asm_api_0101__p2095mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.13.2.5.1.4 "><p id="asm_api_0101__p2097mcpsimp">Ports that will be excluded for outbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2098mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="asm_api_0101__p2100mcpsimp">excludeInboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.2 "><p id="asm_api_0101__p2102mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="asm_api_0101__p2104mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.13.2.5.1.4 "><p id="asm_api_0101__p2106mcpsimp">Ports that will be excluded for inbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2107mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="asm_api_0101__p2109mcpsimp">includeOutboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.2 "><p id="asm_api_0101__p2111mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="asm_api_0101__p2113mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.13.2.5.1.4 "><p id="asm_api_0101__p2115mcpsimp">Ports that will be included for outbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2116mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.1 "><p id="asm_api_0101__p2118mcpsimp">includeInboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.2 "><p id="asm_api_0101__p2120mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.13.2.5.1.3 "><p id="asm_api_0101__p2122mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.13.2.5.1.4 "><p id="asm_api_0101__p2124mcpsimp">Ports that will be included for inbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_TelemetryConfig"></a><a name="_request_TelemetryConfig"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_TelemetryConfig" frame="border" border="1" rules="all"><caption><b>Table 14 </b>TelemetryConfig</caption><thead align="left"><tr id="asm_api_0101__row2132mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.14.2.5.1.1"><p id="asm_api_0101__p2134mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.14.2.5.1.2"><p id="asm_api_0101__p2136mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.14.2.5.1.3"><p id="asm_api_0101__p2138mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.14.2.5.1.4"><p id="asm_api_0101__p2140mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2162mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.14.2.5.1.1 "><p id="asm_api_0101__p2164mcpsimp">tracing</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.14.2.5.1.2 "><p id="asm_api_0101__p2166mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.14.2.5.1.3 "><p id="asm_api_0101__p2168mcpsimp"><a href="#asm_api_0101___request_Tracing">Table 15</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.14.2.5.1.4 "><p id="asm_api_0101__p2171mcpsimp">Tracing configuration, which is used to report traces in the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_Tracing"></a><a name="_request_Tracing"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_Tracing" frame="border" border="1" rules="all"><caption><b>Table 15 </b>Tracing</caption><thead align="left"><tr id="asm_api_0101__row2294mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.15.2.5.1.1"><p id="asm_api_0101__p2296mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.15.2.5.1.2"><p id="asm_api_0101__p2298mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.15.2.5.1.3"><p id="asm_api_0101__p2300mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.15.2.5.1.4"><p id="asm_api_0101__p2302mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2304mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.1 "><p id="asm_api_0101__p2306mcpsimp">randomSamplingPercentage</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.2 "><p id="asm_api_0101__p2308mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.3 "><p id="asm_api_0101__p2310mcpsimp">Float</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.15.2.5.1.4 "><p id="asm_api_0101__p2312mcpsimp">Tracing sampling rate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2313mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.1 "><p id="asm_api_0101__p2315mcpsimp">defaultProviders</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.2 "><p id="asm_api_0101__p2317mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.3 "><p id="asm_api_0101__p2319mcpsimp">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.15.2.5.1.4 "><p id="asm_api_0101__p2321mcpsimp">Name of the default provider that tracing reports data to, which must match the <strong id="asm_api_0101__b17291127164419">name</strong> field in <strong id="asm_api_0101__b772912719447">extensionProviders</strong> or use the preset provider <strong id="asm_api_0101__b17291727134416">apm-otel</strong> of ASM.</p>
|
|
<p id="asm_api_0101__p2322mcpsimp">If <strong id="asm_api_0101__b19591388014">apm-otel</strong> is used, ensure that APM 2.0 is supported in the current region and the service mesh version is later than 1.18.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2323mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.1 "><p id="asm_api_0101__p2325mcpsimp">extensionProviders</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.2 "><p id="asm_api_0101__p2327mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.15.2.5.1.3 "><p id="asm_api_0101__p2329mcpsimp">Array of <a href="#asm_api_0101___request_TracingExtensionProvider">Table 16</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.15.2.5.1.4 "><p id="asm_api_0101__p2332mcpsimp">User-defined provider. Currently, Zipkin is supported.</p>
|
|
<p id="asm_api_0101__p2333mcpsimp">If you configure the Zipkin provider, ensure that the service mesh version is 1.15 or later.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_TracingExtensionProvider"></a><a name="_request_TracingExtensionProvider"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_TracingExtensionProvider" frame="border" border="1" rules="all"><caption><b>Table 16 </b>TracingExtensionProvider</caption><thead align="left"><tr id="asm_api_0101__row2341mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.16.2.5.1.1"><p id="asm_api_0101__p2343mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.16.2.5.1.2"><p id="asm_api_0101__p2345mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.16.2.5.1.3"><p id="asm_api_0101__p2347mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.16.2.5.1.4"><p id="asm_api_0101__p2349mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2351mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.16.2.5.1.1 "><p id="asm_api_0101__p2353mcpsimp">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.16.2.5.1.2 "><p id="asm_api_0101__p2355mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.16.2.5.1.3 "><p id="asm_api_0101__p2357mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.16.2.5.1.4 "><p id="asm_api_0101__p2359mcpsimp">Provider name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2360mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.16.2.5.1.1 "><p id="asm_api_0101__p2362mcpsimp">zipkin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.16.2.5.1.2 "><p id="asm_api_0101__p2364mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.16.2.5.1.3 "><p id="asm_api_0101__p2366mcpsimp"><a href="#asm_api_0101___request_ZipkinTracingProvider">Table 17</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.16.2.5.1.4 "><p id="asm_api_0101__p2369mcpsimp">Self-defined configuration of Zipkin.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___request_ZipkinTracingProvider"></a><a name="_request_ZipkinTracingProvider"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___request_ZipkinTracingProvider" frame="border" border="1" rules="all"><caption><b>Table 17 </b>ZipkinTracingProvider</caption><thead align="left"><tr id="asm_api_0101__row2377mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.17.2.5.1.1"><p id="asm_api_0101__p2379mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.17.2.5.1.2"><p id="asm_api_0101__p2381mcpsimp">Mandatory</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.3.17.2.5.1.3"><p id="asm_api_0101__p2383mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="40%" id="mcps1.3.3.17.2.5.1.4"><p id="asm_api_0101__p2385mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2387mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.17.2.5.1.1 "><p id="asm_api_0101__p2389mcpsimp">service</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.17.2.5.1.2 "><p id="asm_api_0101__p2391mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.17.2.5.1.3 "><p id="asm_api_0101__p2393mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.17.2.5.1.4 "><p id="asm_api_0101__p2395mcpsimp">Service address of Zipkin.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2396mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.17.2.5.1.1 "><p id="asm_api_0101__p2398mcpsimp">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.17.2.5.1.2 "><p id="asm_api_0101__p2400mcpsimp">No</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.3.17.2.5.1.3 "><p id="asm_api_0101__p2402mcpsimp">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="40%" headers="mcps1.3.3.17.2.5.1.4 "><p id="asm_api_0101__p2404mcpsimp">Service port of Zipkin.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="asm_api_0101__section649mcpsimp"><h4 class="sectiontitle">Response Parameters</h4><p id="asm_api_0101__p651mcpsimp"><strong id="asm_api_0101__b652mcpsimp">Status code: 201</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table653mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 18 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0101__row660mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.3.2.4.1.1"><p id="asm_api_0101__p662mcpsimp">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_0101__p664mcpsimp">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_0101__p666mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row668mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0101__p670mcpsimp">apiVersion</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0101__p672mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0101__p674mcpsimp">API version. The value is fixed at <strong id="asm_api_0101__b129952421694713">v1</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row675mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0101__p677mcpsimp">kind</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0101__p679mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0101__p681mcpsimp">API type. The value is fixed at <strong id="asm_api_0101__b192741745394713">Mesh</strong> or <strong id="asm_api_0101__b142031296594713">mesh</strong> and cannot be changed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row682mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0101__p684mcpsimp">metadata</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0101__p686mcpsimp"><a href="#asm_api_0101___d1e904">Table 19</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0101__p689mcpsimp">Basic information about the service mesh. Metadata is a collection of attributes.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row690mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0101__p692mcpsimp">spec</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0101__p694mcpsimp"><a href="#asm_api_0101___d1e979">Table 20</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0101__p1827mcpsimp">Detailed description of the service mesh. ASM creates or updates the service mesh by <strong id="asm_api_0101__b3341221144013">spec</strong>.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row698mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.1 "><p id="asm_api_0101__p700mcpsimp">status</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.3.2.4.1.2 "><p id="asm_api_0101__p702mcpsimp"><a href="#asm_api_0101___d1e1280">Table 29</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.3.2.4.1.3 "><p id="asm_api_0101__p1835mcpsimp">Service mesh status,</p>
|
|
<p id="asm_api_0101__p1836mcpsimp">which is automatically generated by ASM.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d1e904"></a><a name="_d1e904"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d1e904" frame="border" border="1" rules="all"><caption><b>Table 19 </b>MeshMetadata</caption><thead align="left"><tr id="asm_api_0101__row713mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.4.2.4.1.1"><p id="asm_api_0101__p715mcpsimp">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_0101__p717mcpsimp">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_0101__p719mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row721mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0101__p723mcpsimp">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0101__p725mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0101__p727mcpsimp">Service mesh name.</p>
|
|
<p id="asm_api_0101__p2484mcpsimp">Enter 4 to 64 characters. The name must start with a lowercase letter and not end with a hyphen (-). Only lowercase letters, digits, and hyphens (-) are allowed.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row5218635112316"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0101__p17253105116236">uid</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0101__p12253145115235">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0101__p182531851132317">Service mesh ID, which is unique and automatically generated after the service mesh is created. A custom value will not take effect.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row744mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.1 "><p id="asm_api_0101__p746mcpsimp">creationTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.4.2.4.1.2 "><p id="asm_api_0101__p748mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.4.2.4.1.3 "><p id="asm_api_0101__p750mcpsimp">Time when the service mesh was created.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d1e979"></a><a name="_d1e979"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d1e979" frame="border" border="1" rules="all"><caption><b>Table 20 </b>MeshSpec</caption><thead align="left"><tr id="asm_api_0101__row757mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.5.2.4.1.1"><p id="asm_api_0101__p759mcpsimp">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_0101__p761mcpsimp">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_0101__p763mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row772mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0101__p774mcpsimp">type</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0101__p776mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0101__p778mcpsimp">Service mesh type.</p>
|
|
<p id="asm_api_0101__p779mcpsimp"><strong id="asm_api_0101__b1716464234817">InCluster</strong>: service mesh with an in-cluster control plane. The value is <strong id="asm_api_0101__b1416444211482">InCluster</strong> for the service mesh of the Basic edition.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row780mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0101__p782mcpsimp">version</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0101__p784mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0101__p786mcpsimp">Service mesh version.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row787mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0101__p789mcpsimp">extendParams</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0101__p791mcpsimp"><a href="#asm_api_0101___d1e1042">Table 21</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0101__p794mcpsimp">Extensions of the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row14628658153512"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0101__p2538mcpsimp">ipv6Enable</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0101__p2540mcpsimp">Boolean</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0101__p2542mcpsimp">Whether the service mesh supports IPv6.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row11628158183510"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.1 "><p id="asm_api_0101__p2545mcpsimp">config</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.5.2.4.1.2 "><p id="asm_api_0101__p2547mcpsimp"><a href="#asm_api_0101___d0e1786">Table 23</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.5.2.4.1.3 "><p id="asm_api_0101__p2550mcpsimp">Service mesh configuration.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d1e1042"></a><a name="_d1e1042"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d1e1042" frame="border" border="1" rules="all"><caption><b>Table 21 </b>MeshExtendParams</caption><thead align="left"><tr id="asm_api_0101__row801mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.6.2.4.1.1"><p id="asm_api_0101__p803mcpsimp">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_0101__p805mcpsimp">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_0101__p807mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row809mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.1 "><p id="asm_api_0101__p811mcpsimp">clusters</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.6.2.4.1.2 "><p id="asm_api_0101__p813mcpsimp">Array of <a href="#asm_api_0101___d1e1074">Table 22</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.6.2.4.1.3 "><p id="asm_api_0101__p816mcpsimp">Information about clusters in service meshes (only for the Basic edition).</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d1e1074"></a><a name="_d1e1074"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d1e1074" frame="border" border="1" rules="all"><caption><b>Table 22 </b>MeshCluster</caption><thead align="left"><tr id="asm_api_0101__row823mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.7.2.4.1.1"><p id="asm_api_0101__p825mcpsimp">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_0101__p827mcpsimp">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_0101__p829mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row831mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.1 "><p id="asm_api_0101__p833mcpsimp">clusterID</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.7.2.4.1.2 "><p id="asm_api_0101__p835mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.7.2.4.1.3 "><p id="asm_api_0101__p837mcpsimp">Cluster ID, which is unique and can be used to query the cluster to be added.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d0e1786"></a><a name="_d0e1786"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d0e1786" frame="border" border="1" rules="all"><caption><b>Table 23 </b>MeshConfig</caption><thead align="left"><tr id="asm_api_0101__row2600mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.1"><p id="asm_api_0101__p2602mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.8.2.4.1.2"><p id="asm_api_0101__p2604mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.8.2.4.1.3"><p id="asm_api_0101__p2606mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2608mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="asm_api_0101__p2610mcpsimp">proxyConfig</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="asm_api_0101__p2612mcpsimp"><a href="#asm_api_0101___d0e1885">Table 24</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="asm_api_0101__p2615mcpsimp">Data plane configuration of the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2616mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.1 "><p id="asm_api_0101__p2618mcpsimp">telemetryConfig</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.8.2.4.1.2 "><p id="asm_api_0101__p2620mcpsimp"><a href="#asm_api_0101___d0e1964">Table 25</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.8.2.4.1.3 "><p id="asm_api_0101__p2623mcpsimp">Observability configuration of the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d0e1885"></a><a name="_d0e1885"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d0e1885" frame="border" border="1" rules="all"><caption><b>Table 24 </b>ProxyConfig</caption><thead align="left"><tr id="asm_api_0101__row2630mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.1"><p id="asm_api_0101__p2632mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.9.2.4.1.2"><p id="asm_api_0101__p2634mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.9.2.4.1.3"><p id="asm_api_0101__p2636mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2638mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0101__p2640mcpsimp">includeIPRanges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0101__p2642mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0101__p2644mcpsimp">IP address ranges that will be included for outbound traffic redirection. Use commas (,) to separate the IP address ranges.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2645mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0101__p2647mcpsimp">excludeIPRanges</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0101__p2649mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0101__p2651mcpsimp">IP address ranges that will be excluded for outbound traffic redirection. Use commas (,) to separate the IP address ranges.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2652mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0101__p2654mcpsimp">excludeOutboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0101__p2656mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0101__p2658mcpsimp">Ports that will be excluded for outbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2659mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0101__p2661mcpsimp">excludeInboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0101__p2663mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0101__p2665mcpsimp">Ports that will be excluded for inbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2666mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0101__p2668mcpsimp">includeOutboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0101__p2670mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0101__p2672mcpsimp">Ports that will be included for outbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2673mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.1 "><p id="asm_api_0101__p2675mcpsimp">includeInboundPorts</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.9.2.4.1.2 "><p id="asm_api_0101__p2677mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.9.2.4.1.3 "><p id="asm_api_0101__p2679mcpsimp">Ports that will be included for inbound traffic redirection. Use commas (,) to separate the ports.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d0e1964"></a><a name="_d0e1964"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d0e1964" frame="border" border="1" rules="all"><caption><b>Table 25 </b>TelemetryConfig</caption><thead align="left"><tr id="asm_api_0101__row2686mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.1"><p id="asm_api_0101__p2688mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.10.2.4.1.2"><p id="asm_api_0101__p2690mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.10.2.4.1.3"><p id="asm_api_0101__p2692mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2710mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.1 "><p id="asm_api_0101__p2712mcpsimp">tracing</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.10.2.4.1.2 "><p id="asm_api_0101__p2714mcpsimp"><a href="#asm_api_0101___d0e2151">Table 26</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.10.2.4.1.3 "><p id="asm_api_0101__p2717mcpsimp">Tracing configuration, which is used to report traces in the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d0e2151"></a><a name="_d0e2151"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d0e2151" frame="border" border="1" rules="all"><caption><b>Table 26 </b>Tracing</caption><thead align="left"><tr id="asm_api_0101__row2817mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.1"><p id="asm_api_0101__p2819mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.11.2.4.1.2"><p id="asm_api_0101__p2821mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.11.2.4.1.3"><p id="asm_api_0101__p2823mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2825mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="asm_api_0101__p2827mcpsimp">randomSamplingPercentage</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="asm_api_0101__p2829mcpsimp">Float</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="asm_api_0101__p2831mcpsimp">Tracing sampling rate.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2832mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="asm_api_0101__p2834mcpsimp">defaultProviders</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="asm_api_0101__p2836mcpsimp">Array of strings</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="asm_api_0101__p2838mcpsimp">Name of the default provider that tracing reports data to, which must match the <strong id="asm_api_0101__b1054184294413">name</strong> field in <strong id="asm_api_0101__b05411342184417">extensionProviders</strong> or use the preset provider <strong id="asm_api_0101__b165413425445">apm-otel</strong> of ASM.</p>
|
|
<p id="asm_api_0101__p2839mcpsimp">If <strong id="asm_api_0101__b7672122311014">apm-otel</strong> is used, ensure that APM 2.0 is supported in the current region and the service mesh version is later than 1.18.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2840mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.1 "><p id="asm_api_0101__p2842mcpsimp">extensionProviders</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.11.2.4.1.2 "><p id="asm_api_0101__p2844mcpsimp">Array of <a href="#asm_api_0101___d0e2207">Table 27</a> objects</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.11.2.4.1.3 "><p id="asm_api_0101__p2847mcpsimp">User-defined provider. Currently, Zipkin is supported.</p>
|
|
<p id="asm_api_0101__p2848mcpsimp">If you configure the Zipkin provider, ensure that the service mesh version is 1.15 or later.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d0e2207"></a><a name="_d0e2207"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d0e2207" frame="border" border="1" rules="all"><caption><b>Table 27 </b>TracingExtensionProvider</caption><thead align="left"><tr id="asm_api_0101__row2855mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.1"><p id="asm_api_0101__p2857mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.12.2.4.1.2"><p id="asm_api_0101__p2859mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.12.2.4.1.3"><p id="asm_api_0101__p2861mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2863mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="asm_api_0101__p2865mcpsimp">name</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="asm_api_0101__p2867mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="asm_api_0101__p2869mcpsimp">Provider name.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2870mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.1 "><p id="asm_api_0101__p2872mcpsimp">zipkin</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.12.2.4.1.2 "><p id="asm_api_0101__p2874mcpsimp"><a href="#asm_api_0101___d0e2248">Table 28</a> object</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.12.2.4.1.3 "><p id="asm_api_0101__p2877mcpsimp">Self-defined configuration of Zipkin.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d0e2248"></a><a name="_d0e2248"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d0e2248" frame="border" border="1" rules="all"><caption><b>Table 28 </b>ZipkinTracingProvider</caption><thead align="left"><tr id="asm_api_0101__row2884mcpsimp"><th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.13.2.4.1.1"><p id="asm_api_0101__p2886mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="25%" id="mcps1.3.4.13.2.4.1.2"><p id="asm_api_0101__p2888mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="50%" id="mcps1.3.4.13.2.4.1.3"><p id="asm_api_0101__p2890mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row2892mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="asm_api_0101__p2894mcpsimp">service</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="asm_api_0101__p2896mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="asm_api_0101__p2898mcpsimp">Service address of Zipkin.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row2899mcpsimp"><td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.1 "><p id="asm_api_0101__p2901mcpsimp">port</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="25%" headers="mcps1.3.4.13.2.4.1.2 "><p id="asm_api_0101__p2903mcpsimp">Integer</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="50%" headers="mcps1.3.4.13.2.4.1.3 "><p id="asm_api_0101__p2905mcpsimp">Service port of Zipkin.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
|
|
<div class="tablenoborder"><a name="asm_api_0101___d1e1280"></a><a name="_d1e1280"></a><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101___d1e1280" frame="border" border="1" rules="all"><caption><b>Table 29 </b>MeshStatus</caption><thead align="left"><tr id="asm_api_0101__row968mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.14.2.4.1.1"><p id="asm_api_0101__p970mcpsimp">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_0101__p972mcpsimp">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_0101__p974mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row976mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="asm_api_0101__p978mcpsimp">phase</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="asm_api_0101__p980mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="asm_api_0101__p982mcpsimp">Service mesh status. The options are as follows:</p>
|
|
<ul id="asm_api_0101__ul983mcpsimp"><li id="asm_api_0101__li984mcpsimp"><strong id="asm_api_0101__b24164544794713">Running</strong>: The service mesh is running.</li><li id="asm_api_0101__li985mcpsimp"><strong id="asm_api_0101__b40640414494713">Creating</strong>: The service mesh is being created.</li><li id="asm_api_0101__li986mcpsimp"><strong id="asm_api_0101__b118645022394713">CreateFailed</strong>: The service mesh fails to be created.</li><li id="asm_api_0101__li987mcpsimp"><strong id="asm_api_0101__b56409803294713">Deleting</strong>: The service mesh is being deleted.</li><li id="asm_api_0101__li988mcpsimp"><strong id="asm_api_0101__b54226196494713">DeleteFailed</strong>: The service mesh fails to be deleted.</li><li id="asm_api_0101__li989mcpsimp"><strong id="asm_api_0101__b53351357894713">Upgrading</strong>: The service mesh is being upgraded.</li><li id="asm_api_0101__li990mcpsimp"><strong id="asm_api_0101__b4240109294713">UpgradeFailed</strong>: The service mesh fails to be upgraded.</li><li id="asm_api_0101__li991mcpsimp"><strong id="asm_api_0101__b184772257394713">RollingBack</strong>: The service mesh is being rolled back.</li><li id="asm_api_0101__li992mcpsimp"><strong id="asm_api_0101__b71854829994713">RollbackFailed</strong>: The service mesh fails to be rolled back.</li></ul>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row993mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.1 "><p id="asm_api_0101__p995mcpsimp">updateTimestamp</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.14.2.4.1.2 "><p id="asm_api_0101__p997mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.14.2.4.1.3 "><p id="asm_api_0101__p999mcpsimp">Time when the service mesh was updated.</p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="asm_api_0101__p1000mcpsimp"><strong id="asm_api_0101__b179631722105816">Status code: 400</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table1002mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 30 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0101__row1009mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.16.2.4.1.1"><p id="asm_api_0101__p1011mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.16.2.4.1.2"><p id="asm_api_0101__p1013mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.16.2.4.1.3"><p id="asm_api_0101__p1015mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row1017mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="asm_api_0101__p1019mcpsimp">errorCode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="asm_api_0101__p1021mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="asm_api_0101__p1023mcpsimp">Error code.</p>
|
|
<p id="asm_api_0101__p62871637164618">Minimum length: <strong id="asm_api_0101__b19287143784619">8</strong></p>
|
|
<p id="asm_api_0101__p1728733734613">Maximum length: <strong id="asm_api_0101__b18207163713594">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row1024mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.1 "><p id="asm_api_0101__p1026mcpsimp">errorMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.16.2.4.1.2 "><p id="asm_api_0101__p1028mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.16.2.4.1.3 "><p id="asm_api_0101__p1030mcpsimp">Error message.</p>
|
|
<p id="asm_api_0101__p1428893714613">Minimum length: <strong id="asm_api_0101__b20237813505">2</strong></p>
|
|
<p id="asm_api_0101__p72881137194611">Maximum length: <strong id="asm_api_0101__b26229161001">512</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="asm_api_0101__p1031mcpsimp"><strong id="asm_api_0101__b1032mcpsimp">Status code: 409</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table1033mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 31 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0101__row1040mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.18.2.4.1.1"><p id="asm_api_0101__p1042mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.18.2.4.1.2"><p id="asm_api_0101__p1044mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.18.2.4.1.3"><p id="asm_api_0101__p1046mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row1048mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.1 "><p id="asm_api_0101__p1050mcpsimp">errorCode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.2 "><p id="asm_api_0101__p1052mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.18.2.4.1.3 "><p id="asm_api_0101__p1054mcpsimp">Error code.</p>
|
|
<p id="asm_api_0101__p02502010181813">Minimum length: <strong id="asm_api_0101__b025021061817">8</strong></p>
|
|
<p id="asm_api_0101__p182507109184">Maximum length: <strong id="asm_api_0101__b1637212101915">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row1055mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.1 "><p id="asm_api_0101__p1057mcpsimp">errorMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.18.2.4.1.2 "><p id="asm_api_0101__p1059mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.18.2.4.1.3 "><p id="asm_api_0101__p1061mcpsimp">Error message.</p>
|
|
<p id="asm_api_0101__p149175771719">Minimum length: <strong id="asm_api_0101__b1319714233118">2</strong></p>
|
|
<p id="asm_api_0101__p114925711715">Maximum length: <strong id="asm_api_0101__b15168126812">512</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<p id="asm_api_0101__p1062mcpsimp"><strong id="asm_api_0101__b1063mcpsimp">Status code: 500</strong></p>
|
|
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table1064mcpsimp" frame="border" border="1" rules="all"><caption><b>Table 32 </b>Parameters in the response body</caption><thead align="left"><tr id="asm_api_0101__row1071mcpsimp"><th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.20.2.4.1.1"><p id="asm_api_0101__p1073mcpsimp">Parameter</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="20%" id="mcps1.3.4.20.2.4.1.2"><p id="asm_api_0101__p1075mcpsimp">Type</p>
|
|
</th>
|
|
<th align="left" class="cellrowborder" valign="top" width="60%" id="mcps1.3.4.20.2.4.1.3"><p id="asm_api_0101__p1077mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row1079mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.1 "><p id="asm_api_0101__p1081mcpsimp">errorCode</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.2 "><p id="asm_api_0101__p1083mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.20.2.4.1.3 "><p id="asm_api_0101__p1085mcpsimp">Error code.</p>
|
|
<p id="asm_api_0101__p61091391820">Minimum length: <strong id="asm_api_0101__b910201381810">8</strong></p>
|
|
<p id="asm_api_0101__p710131391812">Maximum length: <strong id="asm_api_0101__b3655184812110">36</strong></p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row1086mcpsimp"><td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.1 "><p id="asm_api_0101__p1088mcpsimp">errorMsg</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="20%" headers="mcps1.3.4.20.2.4.1.2 "><p id="asm_api_0101__p1090mcpsimp">String</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="60%" headers="mcps1.3.4.20.2.4.1.3 "><p id="asm_api_0101__p1092mcpsimp">Error message.</p>
|
|
<p id="asm_api_0101__p76092059161714">Minimum length: <strong id="asm_api_0101__b9609155981713">2</strong></p>
|
|
<p id="asm_api_0101__p196091594172">Maximum length: <strong id="asm_api_0101__b17541357317">512</strong></p>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</div>
|
|
<div class="section" id="asm_api_0101__section1093mcpsimp"><h4 class="sectiontitle">Example Request</h4><p id="asm_api_0101__p1095mcpsimp">Creating a service mesh</p>
|
|
<pre class="screen" id="asm_api_0101__screen3040mcpsimp">POST /v1/719217bc273743xxxxxxxxae8bc34480/meshes
|
|
|
|
{
|
|
"apiVersion" : "v1",
|
|
"kind" : "Mesh",
|
|
"metadata" : {
|
|
"name" : "mesh-test-api"
|
|
},
|
|
"spec" : {
|
|
"type" : "InCluster",
|
|
"version" : "1.18.7-r5",
|
|
"extendParams" : {
|
|
"clusters" : [ {
|
|
"clusterID" : "cb0ef541-xxxx-xxxx-xxxx-0255ac1001b7",
|
|
"installation" : {
|
|
"nodes" : {
|
|
"fieldSelector" : {
|
|
"key" : "UID",
|
|
"operator" : "In",
|
|
"values" : [ "1c531b0c-xxxx-xxxx-xxxx-0255ac100b08" ]
|
|
}
|
|
}
|
|
},
|
|
"injection" : {
|
|
"namespaces" : {
|
|
"fieldSelector" : {
|
|
"key" : "Name",
|
|
"operator" : "In",
|
|
"values" : [ "default" ]
|
|
}
|
|
}
|
|
}
|
|
} ]
|
|
},
|
|
"config" : {
|
|
"proxyConfig" : {
|
|
"includeIPRanges" : "10.247.0.0/16"
|
|
},
|
|
"telemetryConfig" : {
|
|
"tracing" : {
|
|
"randomSamplingPercentage" : 1,
|
|
"defaultProviders" : [ "zipkin" ],
|
|
"extensionProviders" : [ {
|
|
"name" : "zipkin",
|
|
"zipkin" : {
|
|
"service" : "zipkin.monitoring.svc.cluster.local",
|
|
"port" : 9411
|
|
}
|
|
} ]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="asm_api_0101__section1097mcpsimp"><h4 class="sectiontitle">Example Response</h4><p id="asm_api_0101__p1099mcpsimp"><strong id="asm_api_0101__b1060237832">Status code: 201</strong></p>
|
|
<p id="asm_api_0101__p1101mcpsimp">The service mesh creation task is delivered and the service mesh creation starts.</p>
|
|
<pre class="screen" id="asm_api_0101__screen3046mcpsimp">{
|
|
"kind" : "Mesh",
|
|
"apiVersion" : "v1",
|
|
"metadata" : {
|
|
"name" : "mesh-test-api",
|
|
"uid" : "a1efdc3e-xxxx-xxxx-xxxx-94bef433347e",
|
|
"creationTimestamp" : "2025-04-10T07:48:37Z"
|
|
},
|
|
"spec" : {
|
|
"type" : "InCluster",
|
|
"version" : "1.18.7-r5",
|
|
"config" : {
|
|
"telemetryConfig" : {
|
|
"tracing" : {
|
|
"randomSamplingPercentage" : 1,
|
|
"defaultProviders" : [ "zipkin" ],
|
|
"extensionProviders" : [ {
|
|
"name" : "zipkin",
|
|
"zipkin" : {
|
|
"service" : "zipkin.monitoring.svc.cluster.local",
|
|
"port" : 9411
|
|
}
|
|
} ]
|
|
}
|
|
},
|
|
"proxyConfig" : {
|
|
"includeIPRanges" : "10.247.0.0/16"
|
|
}
|
|
},
|
|
"extendParams" : {
|
|
"clusters" : [ {
|
|
"clusterID" : "cb0ef541-xxxx-xxxx-xxxx-0255ac1001b7"
|
|
} ]
|
|
}
|
|
},
|
|
"status" : {
|
|
"phase" : "Creating"
|
|
}
|
|
}</pre>
|
|
</div>
|
|
<div class="section" id="asm_api_0101__section1103mcpsimp"><h4 class="sectiontitle">Status Codes</h4>
|
|
<div class="tablenoborder"><table cellpadding="4" cellspacing="0" summary="" id="asm_api_0101__table1105mcpsimp" frame="border" border="1" rules="all"><thead align="left"><tr id="asm_api_0101__row1110mcpsimp"><th align="left" class="cellrowborder" valign="top" width="15%" id="mcps1.3.7.2.1.3.1.1"><p id="asm_api_0101__p1112mcpsimp">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_0101__p1114mcpsimp">Description</p>
|
|
</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody><tr id="asm_api_0101__row1116mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0101__p1118mcpsimp">201</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0101__p1120mcpsimp">The service mesh creation task is delivered and the service mesh creation starts.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row1121mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0101__p1123mcpsimp">400</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0101__p1125mcpsimp">Verification failed due to incorrect parameters for creating the service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row1126mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0101__p1128mcpsimp">409</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0101__p1130mcpsimp">The service mesh to be created conflicts with an existing service mesh.</p>
|
|
</td>
|
|
</tr>
|
|
<tr id="asm_api_0101__row1131mcpsimp"><td class="cellrowborder" valign="top" width="15%" headers="mcps1.3.7.2.1.3.1.1 "><p id="asm_api_0101__p1133mcpsimp">500</p>
|
|
</td>
|
|
<td class="cellrowborder" valign="top" width="85%" headers="mcps1.3.7.2.1.3.1.2 "><p id="asm_api_0101__p1135mcpsimp">An error occurs during the service mesh creation.</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>
|
|
|