更新网格 - UpdateMesh
功能介绍
该API用于更新网格
调用方法
请参见如何调用API。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，需具备如下身份策略权限。
URI
PUT /v2/projects/{project_id}/meshes/{mesh_id}
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
项目ID。 |
|
mesh_id |
是 |
String |
网格ID。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值。 |
|
Content-Type |
是 |
String |
消息体的类型（格式）。 取值范围： |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
action |
是 |
String |
网格更新动作，当前仅支持update |
|
meshConfig |
否 |
MeshConfig object |
需要更新的网格配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
proxyConfig |
否 |
ProxyConfig object |
网格数据面配置 |
|
telemetryConfig |
否 |
TelemetryConfig object |
网格的可观测性配置 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
includeIPRanges |
否 |
String |
拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段 |
|
excludeIPRanges |
否 |
String |
排除拦截对外访问的地址范围，以半角英文逗号（,）分隔的IP网段 |
|
excludeOutboundPorts |
否 |
String |
排除拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表 |
|
excludeInboundPorts |
否 |
String |
排除拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表 |
|
includeOutboundPorts |
否 |
String |
拦截对外访问端口，以半角英文逗号（,）分隔的出站端口列表 |
|
includeInboundPorts |
否 |
String |
拦截访问服务的端口，以半角英文逗号（,）分隔的入站端口列表 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
metrics |
否 |
Metric object |
应用指标配置，用于上报ASM网格指标数据。如果要启用该配置，集群需安装云原生监控插件。 |
|
accessLogging |
否 |
AccessLogging object |
AccessLog配置，用于上报ASM网格内Istio代理的访问日志。如果要启用该配置，集群需安装云原生日志采集插件。 |
|
tracing |
否 |
Tracing object |
Tracing配置，用于上报ASM网格内的调用链数据。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
logGroupID |
否 |
String |
AccessLog日志组ID |
|
logStreamID |
否 |
String |
AccessLog输出日志流ID |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
randomSamplingPercentage |
否 |
Float |
tracing采样率 |
|
defaultProviders |
否 |
Array of strings |
tracing默认上报的provider名称，必须与extensionProviders中的name字段匹配，或使用ASM预设的provider "apm-otel"。 如果使用"apm-otel"，需确认当前region已支持APM2.0且网格版本大于1.18。 |
|
extensionProviders |
否 |
Array of TracingExtensionProvider objects |
用户自配置provider，目前支持zipkin协议。 如果用户配置zipkin协议的provider，请保证网格版本大于等于1.15。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
name |
否 |
String |
provider实例name |
|
zipkin |
否 |
ZipkinTracingProvider object |
zipkin协议provider自有配置 |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
- |
String |
表示网格更新成功 |
状态码：400
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误码 |
|
errorMsg |
String |
错误描述 |
状态码：500
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
errorCode |
String |
错误码 |
|
errorMsg |
String |
错误描述 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
表示网格更新成功 |
|
400 |
用户提供的参数有问题，未通过校验 |
|
500 |
内部错误 |
错误码
请参见错误码。
