文档

UpdateMeshFeature - 更新服务网格的功能配置

更新时间:

调用UpdateMeshFeature更新服务网格的功能配置。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
ServiceMeshIdstring

服务网格 ID。

cb8963379255149cb98c8686f274x****
Tracingboolean

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

  • true:启用链路追踪。

  • false:不启用链路追踪。

默认值:false

false
TraceSamplingfloat

链路追踪采样百分比。

100
TraceCustomTagsstring

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

{
    "name1": CustomTag,
    "name2": CustomTag
}

CustomTag 结构为:literal、header 或 environment,请任选其一。

{
    "literal": {
        "value": "固定值"
    }
    "header": {
        "name": "HEADER 名称",
        "defaultValue": "若指定 HEADER 不存在,使用的默认值。"
    }
    "environment": {
        "name": "环境变量名称",
        "defaultValue": "若指定环境变量不存在,使用的默认值。"
    }
}
{"mytag": {"literal":{"value":"test"}}}
TraceMaxPathTagLengthstring

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

256
LocalityLoadBalancingboolean

是否启用跨地域负载均衡,取值:

  • true:启用跨地域负载均衡。

  • false:不启用跨地域负载均衡。

默认值:false

true
LocalityLBConfstring

跨地域负载均衡配置,取值:

  • failover:跨地域故障转移配置,例如:
    failover: [//  struct,跨地域故障转移配置。
        {
            // 当北京地域服务故障时,流量转移到杭州同服务。
            from: "cn-beijing", 
            to: "cn-hangzhou",
        }
    ]
  • distribute:跨地域流量分布配置,例如:
distribute: [ // struct, 跨地域流量分布配置 。
        {
            // 路由到北京地域的流量 70%分配到北京,30%分配到杭州。
            "from": "cn-beijing",
            "to": {
                "cn-beijing": 70,
                "cn-hangzhou": 30,
            }
        }
    ]
{"failover":[{"from":"cn-hangzhou","to":"cn-shanghai"}]}
Telemetryboolean

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

  • true:开启采集 Prometheus 监控指标。

  • false:不开启采集 Prometheus 监控指标。

默认值:false

false
OpenAgentPolicyboolean

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

  • true:集成开放策略代理(OPA)插件。

  • false:不集成开放策略代理(OPA)插件。

默认值:false

false
OPALogLevelstring

OPA 代理容器日志级别,取值:

  • info:输出所有信息。

  • debug:输出调试信息和错误信息。

  • error:仅输出错误信息。

info
OPARequestCPUstring

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

1
OPARequestMemorystring

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

512Mi
OPALimitCPUstring

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

2
OPALimitMemorystring

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

1024Mi
EnableAuditboolean

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

  • true:启用网格审计。

  • false:不启用网格审计。

默认值:false

false
AuditProjectstring

网格审计对应的日志项目名称。

默认值:mesh-log-{meshId}

mesh-log-c08ba3fd1e64xxb0f8cc1ad8****
CustomizedZipkinboolean

是否启用自建 Zipkin,取值:

  • true:启用自建 Zipkin。

  • false:不启用自建 Zipkin。

默认值:false

false
OutboundTrafficPolicystring

对外部服务的访问策略,取值:

  • ALLOW_ANY:允许访问所有外部服务。

  • REGISTRY_ONLY:只能访问注册到网格内的服务。

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

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

  • true:为所有命名空间开启自动注入功能。

  • false:不为所有命名空间开启自动注入功能。

默认值:false

false
AutoInjectionPolicyEnabledboolean

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

  • true:开启通过 Pod Annotations 实现自动注入 Sidecar。

  • false:不开启通过 Pod Annotations 实现自动注入 Sidecar。

默认值:false

false
SidecarInjectorRequestCPUstring

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

1000m
SidecarInjectorRequestMemorystring

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

512Mi
SidecarInjectorLimitCPUstring

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

4000m
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,取值:

  • true:启用 CNI。

  • false:不启用 CNI。

默认值:false

false
CniExcludeNamespacesstring

CNI 排除的命名空间。

kube-system
OpaEnabledboolean

是否启用 OPA,取值:

  • true:启用 OPA。

  • false:不启用 OPA。

默认值:false

false
Http10Enabledboolean

是否支持 HTTP1.0,取值:

  • true:支持 HTTP1.0。

  • false:不支持 HTTP1.0。

默认值:false

false
KialiEnabledboolean

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

  • true:启用网格拓扑。

  • false:不启用网格拓扑。

默认值:false

false
CustomizedPrometheusboolean

是否自定义 Prometheus,取值:

  • true:自定义 Prometheus。

  • false:不自定义 Prometheus。

默认值:false

false
PrometheusUrlstring

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

http://prometheus:9090
AccessLogEnabledboolean

是否启用访问日志采集,取值:

  • true:启用访问日志采集。

  • false:不启用访问日志采集。

默认值:false

false
MSEEnableddeprecatedboolean

是否启用 MSE 微服务引擎,取值:

  • true:启用 MSE 微服务引擎。

  • false:不启用 MSE 微服务引擎。

默认值:false

false
RedisFilterEnabledboolean

是否启用 RedisFilter,取值:

  • true:启用 RedisFilter。

  • false:不启用 RedisFilter。 默认值:false

false
MysqlFilterEnabledboolean

是否启用 MysqlFilter,取值:

  • true:启用 MysqlFilter。

  • false:不启用 MysqlFilter。

默认值:false

false
ThriftFilterEnabledboolean

是否启用 ThriftFilter,取值:

  • true:启用 ThriftFilter。

  • false:不启用 ThriftFilter。

默认值:false

false
WebAssemblyFilterEnabledboolean

是否启用 WebAssemblyFilter,取值:

  • true:启用 WebAssemblyFilter。

  • false:不启用 WebAssemblyFilter。

默认值:false

false
DNSProxyingEnabledboolean

是否启用 DNS Proxying,取值:

  • true:启用 DNS Proxying。

  • false:不启用 DNS Proxying。

默认值:false

false
DubboFilterEnabledboolean

是否启用 DubboFilter,取值:

  • true:启用 DubboFilter。

  • false:不启用 DubboFilter。

默认值:false

false
FilterGatewayClusterConfigboolean

是否启用 Gateway 配置过滤,取值:

  • true:启用 Gateway 配置过滤。

  • false:不启用 Gateway 配置过滤。

默认值:false

false
EnableSDSServerboolean

是否启用 SDS 服务,取值:

  • true:启用 SDS 服务。

  • false:不启用 SDS 服务。

默认值:false

false
AccessLogServiceEnabledboolean

是否启用 Envoy 的 gRPC 日志服务,取值:

  • true:启用 Envoy 的 gRPC 日志服务(ALS)。

  • false:不启用 Envoy 的 gRPC 日志服务(ALS)。

默认值:false

false
AccessLogServiceHoststring

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

0.0.0.0
AccessLogServicePortinteger

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

9999
GatewayAPIEnabledboolean

是否启用 Gateway API,取值:

  • true:启用 Gateway API。

  • false:不启用 Gateway API。

默认值:false

false
ConfigSourceEnabledboolean

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

  • true:启用外部服务注册中心。

  • false:不启用外部服务注册中心。

默认值:false

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

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

  • “”:关闭访问日志。

  • /dev/stdout:开启访问日志。

“”
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:标准版。

  • enterprise:企业版。

  • ultimate:旗舰版。

standard
OPAScopeInjectedboolean

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

  • true:启用 OPA 注入范围控制能力。

  • false:不启用 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

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

此字段仅在禁用节点特征自动获取能力时(即设置NFDEnabledfalse时)需要设置。

false
TracingOnExtZipkinRequestCPUstring

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

200m
TracingOnExtZipkinRequestMemorystring

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

200Mi
TracingOnExtZipkinLimitCPUstring

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

1000Mi
TracingOnExtZipkinLimitMemorystring

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

1024Mi
AccessLogGatewayLifecycleinteger

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

30
AccessLogSidecarLifecycleinteger

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

30
EnableAutoDiagnosisboolean

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

true
IncludeOutboundPortsstring

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

8000,8001
LogLevelstring

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

info
Concurrencyinteger

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

2
HoldApplicationUntilProxyStartsboolean

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

true
ProxyStatsMatcherstring

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

{"inclusionRegexps":".*adaptive_concurrency.*"}
InterceptionModestring

Sidecar 对入向流量的拦截策略。取值:

  • REDIRECT:默认的拦截策略,Sidecar 将使用重定向方式拦截入向流量。
  • TPROXY:透明代理拦截策略,Sidecar 将以透明代理的方式拦截入向流量。
TPROXY
EnableBootstrapXdsAgentboolean

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

true
KialiArmsAuthTokensstring

当启用网格拓扑功能且集成 ARMS Prometheus 采集监控指标时,若 ARMS Prometheus 实例配置了鉴权 token,通过此参数设定 ARMS Prometheus 的鉴权 Token,以授权网格拓扑访问 ARMS Prometheus 实例。 参数格式为 JSON 编码的字符串,JSON 对象中的键为数据面集群的集群 ID,值为数据面集群内安装的 ARMS Prometheus 实例设定的鉴权 Token。

{"c31e3b******5634b":"token_example"}
DefaultComponentsScheduleConfigstring

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

说明
  • 该参数的修改属于高危操作。该操作会导致 ASM 所有的数据面组件重启,请谨慎操作。
  • 此处配置不包括 ASM 网关,网关调度请在网关中配置。
  • {"tolerations":[{"key":"test-taints", "operator":"Exists", "effect":"NoSchedule"}], "nodeSelector":{"kubernetes.io/hostname":"test-nodes"}}
    KialiServiceAnnotationsstring

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

    参数格式为 JSON 编码的字符串,JSON 对象中的键为数据面集群的集群 ID,值为数据面集群中网格拓扑服务的 Annotation 内容。

    有关如何通过注解配置 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证书链。

    返回参数

    名称类型描述示例值
    object
    RequestIdstring

    请求 ID。

    BD65C0AD-D3C6-48D3-8D93-38D2015C****

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****"
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-02-04OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ExistingRootCaCert
      新增入参:ExistingCaCert
      新增入参:ExistingCaKey
      新增入参:CertChain
    2024-01-27OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:LabelsForOffloadedWorkloads
    2023-08-31OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:AccessLogGatewayEnabled
      新增入参:AccessLogSidecarEnabled
    2023-06-02OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:KialiServiceAnnotations
    2023-04-13OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      删除入参:GlobalRateLimitEnabled
    2023-03-17OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:DefaultComponentsScheduleConfig
    2022-08-17OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:EnableAutoDiagnosis
    2021-10-28OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:EnableCRHistory
      新增入参:ASMAPIServiceEnabled
    2021-09-06OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:AccessLogFile
    2021-05-25OpenAPI 入参发生变更看变更集
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参:ConfigSourceEnabled
      新增入参:ConfigSourceNacosID
    • 本页导读 (1)
    文档反馈