Help Center/ Application Service Mesh/ API Reference/ API/ Mesh APIs/ Updating a Mesh
Updated on 2026-06-25 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Updating a Mesh

Function

This API is used to update a mesh.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    asm:mesh:update

    Write

    mesh *

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    -

    -

URI

PUT /v2/projects/{project_id}/meshes/{mesh_id}

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID

mesh_id

Yes

String

Mesh ID

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

API calling can be authenticated using a token or AK/SK. If you use a token, this parameter is mandatory and must be set to the token.

Content-Type

Yes

String

Message body type (format)

Range:

  • application/json;charset=utf-8: The content is in JSON format and encoded using UTF-8.

  • application/json: The content is in JSON format.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

action

Yes

String

Mesh update action. Currently, only update is supported.

meshConfig

No

MeshConfig object

Mesh configuration to be updated
Table 4 MeshConfig

Parameter

Mandatory

Type

Description

proxyConfig

No

ProxyConfig object

Data plane configuration of a mesh

telemetryConfig

No

TelemetryConfig object

Observability configuration of a mesh
Table 5 ProxyConfig

Parameter

Mandatory

Type

Description

includeIPRanges

No

String

IP address ranges that will be included for outbound traffic redirection. Use commas (,) to separate the IP address ranges.

excludeIPRanges

No

String

IP address ranges that will be excluded for outbound traffic redirection. Use commas (,) to separate the IP address ranges.

excludeOutboundPorts

No

String

Ports that will be excluded for outbound traffic redirection. Use commas (,) to separate the ports.

excludeInboundPorts

No

String

Ports that will be excluded for inbound traffic redirection. Use commas (,) to separate the ports.

includeOutboundPorts

No

String

Ports that will be included for outbound traffic redirection. Use commas (,) to separate the ports.

includeInboundPorts

No

String

Ports that will be included for inbound traffic redirection. Use commas (,) to separate the ports.
Table 6 TelemetryConfig

Parameter

Mandatory

Type

Description

metrics

No

Metric object

Application metric configuration, which is used to report mesh metrics. To enable this configuration, you need to install the Cloud Native Cluster Monitoring add-on in the cluster.

accessLogging

No

AccessLogging object

Access log configuration, which is used to report access logs of Istio proxies in a mesh. To enable this configuration, you need to install the Cloud Native Log Collection add-on in the cluster.

tracing

No

Tracing object

Tracing configuration, which is used to report traces in a mesh.
Table 7 Metric

Parameter

Mandatory

Type

Description

aom

No

Array of Aom objects

AOM instance configuration
Table 8 Aom

Parameter

Mandatory

Type

Description

instanceID

Yes

String

AOM instance ID
Table 9 AccessLogging

Parameter

Mandatory

Type

Description

lts

No

Array of LtsConfig objects

LTS configuration
Table 10 LtsConfig

Parameter

Mandatory

Type

Description

logGroupID

No

String

Log group ID of access logs

logStreamID

No

String

Log stream ID of access logs
Table 11 Tracing

Parameter

Mandatory

Type

Description

randomSamplingPercentage

No

Float

Tracing sampling rate

defaultProviders

No

Array of strings

Name of the default provider that tracing reports data to, which must match the name field in extensionProviders or use the preset provider apm-otel of ASM.

If apm-otel is used, ensure that APM 2.0 is supported in the current region and the mesh version is later than 1.18.

extensionProviders

No

Array of TracingExtensionProvider objects

User-defined provider. Currently, Zipkin is supported.

If Zipkin is used, ensure that the mesh version is 1.15 or later.
Table 12 TracingExtensionProvider

Parameter

Mandatory

Type

Description

name

No

String

Provider instance name

zipkin

No

ZipkinTracingProvider object

Provider's Zipkin configuration
Table 13 ZipkinTracingProvider

Parameter

Mandatory

Type

Description

service

No

String

Service address of Zipkin

port

No

Integer

Service port of Zipkin

Response Parameters

Status code: 200

Table 14 Response body parameters

Parameter

Type

Description

-

String

The mesh is updated.

Status code: 400

Table 15 Response body parameters

Parameter

Type

Description

errorCode

String

Error code

Status code: 500

Table 16 Response body parameters

Parameter

Type

Description

errorCode

String

Error code

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The mesh is updated.

400

Verification failed due to incorrect parameters.

500

Internal error.

Error Codes

See Error Codes.

Parent topic: Mesh APIs