UpdateMeshFeature_服务网格_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
servicemesh:UpdateMeshFeature
Update
全部资源
*

请求参数

字段名称字段详情
ServiceMeshIdstring

服务网格 ID。

示例值:cb8963379255149cb98c8686f274x****参考取值来源:
    CreateServiceMesh
    AddClusterIntoServiceMesh
    DescribeServiceMeshes
Tracingboolean

启用链路追踪(需要开通可观测链路 OpenTelemetry 版)。取值:展开详情

示例值:false
TraceSamplingnumber<float>

链路追踪采样百分比。

示例值:100
TraceCustomTagsstring

自定义链路追踪标签设置,格式为 JSON,结构为:展开详情

示例值:{"mytag": {"literal":{"value":"test"}}}
TraceMaxPathTagLengthstring

HttpUrl Span 标签中包含的请求路径的最大长度,默认值为256

示例值:256
LocalityLoadBalancingboolean

是否启用跨地域负载均衡,取值:展开详情

示例值:true
LocalityLBConfstring

跨地域负载均衡配置,取值:展开详情

示例值:{"failover":[{"from":"cn-hangzhou","to":"cn-shanghai"}]}
Telemetryboolean

是否开启采集 Prometheus 监控指标(建议使用阿里云 Prometheus 监控),取值:展开详情

示例值:false
OpenAgentPolicyboolean

是否集成开放策略代理(OPA)插件,取值:展开详情

示例值:false
OPALogLevelstring

OPA 代理容器日志级别,取值:展开详情

示例值:info
OPARequestCPUstring

OPA 代理容器的 CPU 资源请求。

示例值:1
OPARequestMemorystring

OPA 代理容器的内存资源请求。

示例值:512Mi
OPALimitCPUstring

OPA 代理容器的 CPU 资源限制。

示例值:2
OPALimitMemorystring

OPA 代理容器的内存资源限制。

示例值:1024Mi
EnableAuditboolean

是否启用网格审计(需要开通阿里云日志服务),取值:展开详情

示例值:false
AuditProjectstring

网格审计对应的日志项目名称。展开详情

示例值:mesh-log-c08ba3fd1e64xxb0f8cc1ad8****
CustomizedZipkinboolean

是否启用自建 Zipkin,取值:展开详情

示例值:false
OutboundTrafficPolicystring

对外部服务的访问策略,取值:展开详情

示例值:ALLOW_ANY
ProxyRequestCPUstring

CPU 所需资源。

示例值:100m
ProxyRequestMemorystring

内存所需资源。

示例值:128Mi
ProxyLimitCPUstring

CPU 资源限制。

示例值:2000m
ProxyLimitMemorystring

内存资源限制。

示例值:1024Mi
IncludeIPRangesstring

拦截对外访问的地址范围。

示例值:*
ExcludeIPRangesstring

排除拦截对外访问的地址范围。

示例值:100.100.XXX.XXX
ExcludeOutboundPortsstring

以英文半角逗号(,)分隔的出站端口列表。

示例值:80,81
IncludeInboundPortsstring

设置端口使 Inbound 流量经过 Sidecar。

示例值:80,81
ExcludeInboundPortsstring

以英文半角逗号(,)分隔的入站端口列表。

示例值:80,81
EnableNamespacesByDefaultboolean

是否为所有命名空间开启自动注入功能,取值:展开详情

示例值:false
AutoInjectionPolicyEnabledboolean

是否开启通过 Pod Annotations 实现自动注入 Sidecar,取值:展开详情

示例值:false
SidecarInjectorRequestCPUstring

Sidecar 注入器 Pod 的 CPU 请求资源。

示例值:1000m参考取值来源:
    DescribeServiceMeshDetail
SidecarInjectorRequestMemorystring

Sidecar 注入器 Pod 的内存请求资源。

示例值:512Mi
SidecarInjectorLimitCPUstring

Sidecar 注入器 Pod 的 CPU 限制资源。

示例值:4000m参考取值来源:
    DescribeServiceMeshDetail
SidecarInjectorLimitMemorystring

Sidecar 注入器 Pod 的内存限制资源。

示例值:2048Mi
SidecarInjectorWebhookAsYamlstring

其他自动注入 Sidecar 的配置(YAML 格式)。

示例值:{"injectedAnnotations":{"test/istio-init":"runtime/default2","test/istio-proxy":"runtime/default"},"replicaCount":2,"nodeSelector":{"beta.kubernetes.io/os":"linux"}}
CniEnabledboolean

是否启用 CNI,取值:展开详情

示例值:false
CniExcludeNamespacesstring

CNI 排除的命名空间。

示例值:kube-system
OpaEnabledboolean

是否启用 OPA,取值:展开详情

示例值:false
Http10Enabledboolean

是否支持 HTTP1.0,取值:展开详情

示例值:false
KialiEnabledboolean

是否启用网格拓扑(需先开启采集 Prometheus 监控指标,当该项更新为false时,本项强制为false),取值:展开详情

示例值:false
CustomizedPrometheusboolean

是否自定义 Prometheus,取值:展开详情

示例值:false
PrometheusUrlstring

Prometheus 服务地址(非自定义情况下,使用 ARMS 地址格式)。

示例值:http://prometheus:9090
AccessLogEnabledboolean

是否启用访问日志采集,取值:展开详情

示例值:false
deprecatedMSEEnabledboolean

是否启用 MSE 微服务引擎,取值:展开详情

示例值:false
RedisFilterEnabledboolean

是否启用 RedisFilter,取值:展开详情

示例值:false
MysqlFilterEnabledboolean

是否启用 MysqlFilter,取值:展开详情

示例值:false
ThriftFilterEnabledboolean

是否启用 ThriftFilter,取值:展开详情

示例值:false
WebAssemblyFilterEnabledboolean

是否启用 WebAssemblyFilter,取值:展开详情

示例值:false
DNSProxyingEnabledboolean

是否启用 DNS Proxying,取值:展开详情

示例值:false
DubboFilterEnabledboolean

是否启用 DubboFilter,取值:展开详情

示例值:false
FilterGatewayClusterConfigboolean

是否启用 Gateway 配置过滤,取值:展开详情

示例值:false
EnableSDSServerboolean

是否启用 SDS 服务,取值:展开详情

示例值:false
AccessLogServiceEnabledboolean

是否启用 Envoy 的 gRPC 日志服务,取值:展开详情

示例值:false
AccessLogServiceHoststring

启用 Envoy 的 gRPC 日志服务(ALS)的地址。

示例值:0.0.0.0参考取值来源:
    DescribeServiceMeshDetail
AccessLogServicePortinteger<int32>

启用 Envoy 的 gRPC 日志服务(ALS)的端口。

示例值:9999
GatewayAPIEnabledboolean

是否启用 Gateway API,取值:展开详情

示例值:false
ConfigSourceEnabledboolean

是否启用外部服务注册中心,取值:展开详情

示例值:false
ConfigSourceNacosIDstring

Nacos 注册中心实例 ID。

示例值:mse-cn-tl326******
AccessLogFormatstring

自定义访问日志的格式(需先启用访问日志,否则自动忽略本项)。本项字符串为 JSON 格式,且 JSON 字符串中必须至少包含以下键值:authority_for、bytes_received、bytes_sent、downstream_local_address、downstream_remote_address、duration、istio_policy_status、method、path、protocol、requested_server_name、response_code、response_flags、route_name、start_time、trace_id、upstream_cluster、upstream_host、upstream_local_address、upstream_service_time、upstream_transport_failure_reason、user_agent、x_forwarded_for。

示例值:{"authority_for":"%REQ(:AUTHORITY)%","bytes_received":"%BYTES_RECEIVED%","bytes_sent":"%BYTES_SENT%","downstream_local_address":"%DOWNSTREAM_LOCAL_ADDRESS%","downstream_remote_address":"%DOWNSTREAM_REMOTE_ADDRESS%","duration":"%DURATION%","istio_policy_status":"%DYNAMIC_METADATA(istio.mixer:status)%","method":"%REQ(:METHOD)%","path":"%REQ(X-ENVOY-ORIGINAL-PATH?:PATH)%","protocol":"%PROTOCOL%","request_id":"%REQ(X-REQUEST-ID)%","requested_server_name":"%REQUESTED_SERVER_NAME%","response_code":"%RESPONSE_CODE%","response_flags":"%RESPONSE_FLAGS%","route_name":"%ROUTE_NAME%","start_time":"%START_TIME%","trace_id":"%REQ(X-B3-TRACEID)%","upstream_cluster":"%UPSTREAM_CLUSTER%","upstream_host":"%UPSTREAM_HOST%","upstream_local_address":"%UPSTREAM_LOCAL_ADDRESS%","upstream_service_time":"%RESP(X-ENVOY-UPSTREAM-SERVICE-TIME)%","upstream_transport_failure_reason":"%UPSTREAM_TRANSPORT_FAILURE_REASON%","user_agent":"%REQ(USER-AGENT)%","x_forwarded_for":"%REQ(X-FORWARDED-FOR)%"}
AccessLogFilestring

开启和关闭访问日志,取值:展开详情

示例值:“”
AccessLogProjectstring

自定义日志服务 SLS 采集的 Project。

示例值:mesh-log-cf245a429b6ff4b6e97f20797758e****
EnableCRHistoryboolean

设置是否启用 ASM 的 Istio 资源历史版本管理功能。

示例值:false
CRAggregationEnabledboolean

设置是否启用数据面集群 Kubernetes API 访问 Istio 资源(需 ASM 实例 v1.9.7.93 版本以上)。

示例值:false
TerminationDrainDurationstring

istio-proxy 终止等待时长,例如 5 秒,输入为 5s。

示例值:5s
ProxyInitCPUResourceLimitstring

istio-init 初始化容器 CPU 资源限制。

示例值:2000m
ProxyInitMemoryResourceLimitstring

istio-init 初始化容器内存资源限制。

示例值:1024Mi
ProxyInitCPUResourceRequeststring

istio-init 初始化容器 CPU 资源所需。

示例值:10m
ProxyInitMemoryResourceRequeststring

istio-init 初始化容器内存资源所需。

示例值:10Mi
Lifecyclestring

istio-proxy 生命周期。

示例值:{"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}}
MultiBufferEnabledboolean

开启 MultiBuffer 加速功能。

示例值:false
MultiBufferPollDelaystring

MultiBuffer 的策略拉取延迟,默认为空 。

示例值:0.02s
DiscoverySelectorsstring

用于选择性服务发现的数据平面命名空间标签选择器列表。

示例值:[{"matchExpressions":[{"key":"asm-discovery","operator":"Exists"}]}]
ClusterSpecstring

服务网格实例规格,取值:展开详情

示例值:standard
OPAScopeInjectedboolean

是否启用 OPA 注入范围控制能力,取值:展开详情

示例值:false
OPAInjectorCPURequirementstring

负责注入 OPA 代理的 Pod 所申请的最少 CPU 核数。例如1000m表示 1 核 CPU。

示例值:80m
OPAInjectorMemoryRequirementstring

负责注入 OPA 代理的 Pod 所申请的最少内存。例如50 Mi表示 50 MB。

示例值:50Mi
OPAInjectorCPULimitstring

负责注入 OPA 代理的 Pod 所限制的最大 CPU 核数。例如1000m表示 1 核 CPU。

示例值:1000m
OPAInjectorMemoryLimitstring

负责注入 OPA 代理的 Pod 所限制的最大内存。例如1024Mi表示 1024 MB。

示例值:1024Mi
IntegrateKialiboolean

是否为访问 ASM 网格拓扑创建 CLB。

示例值:false
NFDEnabledboolean

是否启用节点特征自动获取能力。

示例值:false
NFDLabelPrunedboolean

是否在禁用节点特征自动获取能力时,清除节点上的特征相关标签。展开详情

示例值:false
TracingOnExtZipkinRequestCPUstring

负载链路追踪导出的代理服务所申请的最少 CPU 核数。例如1000m表示 1 核 CPU。

示例值:200m
TracingOnExtZipkinRequestMemorystring

负载链路追踪导出的代理服务所申请的最少内存。例如1Mi表示 1 MB。

示例值:200Mi
TracingOnExtZipkinLimitCPUstring

负载链路追踪导出的代理服务所限制的最大 CPU 核数。例如1000m表示 1 核 CPU。

示例值:1000Mi
TracingOnExtZipkinLimitMemorystring

负载链路追踪导出的代理服务所限制的最大内存。例如1Mi表示 1 MB。

示例值:1024Mi
TracingOnExtZipkinReplicaCountstring

负载链路追踪导出的代理服务的副本数量。

示例值:2
AccessLogGatewayLifecycleinteger<int32>

采集到 SLS 的入口网关访问日志的存储周期(天)。例如30代表 30 天。

示例值:30
AccessLogSidecarLifecycleinteger<int32>

采集到 SLS 的 Sidecar 访问日志的存储周期(天)。例如30代表 30 天。

示例值:30
EnableAutoDiagnosisboolean

是否启用网格自动诊断功能(开启后,当修改网格内 Istio 资源时,将会自动对网格进行诊断)。

示例值:true
IncludeOutboundPortsstring

设置端口使 outbound 流量经过 Sidecar。

示例值:8000,8001
LogLevelstring

设置数据面 Sidecar 代理的日志级别。日志级别按输出日志信息量从低到高排序依次为noneerrorwarninfodebug

示例值:info
Concurrencyinteger<int32>

设置数据面 Sidecar 代理的并行度。

示例值:2
HoldApplicationUntilProxyStartsboolean

设置在 Pod 启动时是否先等待 Sidecar 代理容器启动再启动业务容器。

示例值:true
ProxyStatsMatcherstring

设定数据面 Sidecar 代理额外上报的指标。

示例值:{"inclusionRegexps":".*adaptive_concurrency.*"}
InterceptionModestring

Sidecar 对入向流量的拦截策略。取值:展开详情

示例值:TPROXY
EnableBootstrapXdsAgentboolean

设定是否令 Sidecar 代理在启动前加载 bootstrap 配置

示例值:true
KialiArmsAuthTokensstring

当启用网格拓扑功能且集成 ARMS Prometheus 采集监控指标时,若 ARMS Prometheus 实例配置了鉴权 token,通过此参数设定 ARMS Prometheus 的鉴权 Token,以授权网格拓扑访问 ARMS Prometheus 实例。展开详情

示例值:{"c31e3b******5634b":"token_example"}
DefaultComponentsScheduleConfigstring

ASM 下发到数据面组件的默认调度配置。支持以 JSON 的形式配置nodeSelectortolerations展开详情

示例值:{"tolerations":[{"key":"test-taints", "operator":"Exists", "effect":"NoSchedule"}], "nodeSelector":{"kubernetes.io/hostname":"test-nodes"}}
KialiServiceAnnotationsstring

当开启网格拓扑且为访问网格拓扑创建 CLB 时,通过此参数使用 Annotation 配置不同集群中网格拓扑服务的 CLB。展开详情

示例值:{"c31e3b******5634b":{"service.beta.kubernetes.io/alibaba-cloud-loadbalancer-address-type":"intranet"}}
AccessLogGatewayEnabledboolean

是否启用将 ASM 网关访问日志采集到阿里云日志服务 SLS。

示例值:false
AccessLogSidecarEnabledboolean

是否启用将 ASM 网格代理(Sidecar)的日志采集到阿里云日志服务 SLS。

示例值:false
LabelsForOffloadedWorkloadsstring

隔离工作负载的标签

示例值:name=xx,region=xx
ExistingRootCaCertstring

新的 RootCert。仅当创建网格时使用了自定义证书时才可以修改该参数。

示例值:Base64编码的PEM证书。
ExistingCaCertstring

新的 CaCert。仅当创建网格时使用了自定义证书时才可以修改该参数。

示例值:Base64编码的PEM证书。
ExistingCaKeystring

新的 CaKey。仅当创建网格时使用了自定义证书时才可以修改该参数。

示例值:Base64编码的PEM私钥。
CertChainstring

从 CaCert 到 RootCert 的证书链,至少包含两个证书。

示例值:Base64编码的PEM证书链。
SMCEnabledboolean

是否安装 SMC 加速

示例值:false
PilotEnableQuicListenersboolean

是否启用 HTTP/3 支持。

示例值:false

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

示例值:BD65C0AD-D3C6-48D3-8D93-38D2015C****

返回示例

变更历史

变更时间变更内容概要操作
2024-06-26
新增请求参数PilotEnableQuicListeners
2024-06-24
新增请求参数TracingOnExtZipkinReplicaCount
2024-05-17
新增请求参数SMCEnabled
2024-02-04
新增请求参数ExistingRootCaCert
新增请求参数ExistingCaCert
新增请求参数ExistingCaKey
新增请求参数CertChain
2024-01-27
新增请求参数LabelsForOffloadedWorkloads
2023-08-31
新增请求参数AccessLogGatewayEnabled
新增请求参数AccessLogSidecarEnabled
2023-06-02
新增请求参数KialiServiceAnnotations
2023-04-13
删除请求参数GlobalRateLimitEnabled

相关示例