调用UpdateMeshFeature更新服务网格的功能配置。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
ServiceMeshId | string | 是 | 服务网格ID。 | cb8963379255149cb98c8686f274x**** |
Tracing | boolean | 否 | false | |
TraceSampling | float | 否 | 链路追踪采样百分比。 | 100 |
TraceCustomTags | string | 否 | 自定义链路追踪标签设置,格式为JSON,结构为:
CustomTag结构为:literal、header或environment,请任选其一。
| {"mytag": {"literal":{"value":"test"}}} |
TraceMaxPathTagLength | string | 否 | HttpUrl Span标签中包含的请求路径的最大长度,默认值为 | 256 |
LocalityLoadBalancing | boolean | 否 | 是否启用跨地域负载均衡,取值:
默认值: | true |
LocalityLBConf | string | 否 | 跨地域负载均衡配置,取值:
| {"failover":[{"from":"cn-hangzhou","to":"cn-shanghai"}]} |
Telemetry | boolean | 否 | 是否开启采集Prometheus监控指标(建议使用阿里云Prometheus监控),取值:
默认值: | false |
OpenAgentPolicy | boolean | 否 | 是否集成开放策略代理(OPA)插件,取值:
默认值: | false |
OPALogLevel | string | 否 | OPA代理容器日志级别,取值:
| info |
OPARequestCPU | string | 否 | OPA代理容器的CPU资源请求。 | 1 |
OPARequestMemory | string | 否 | OPA代理容器的内存资源请求。 | 512Mi |
OPALimitCPU | string | 否 | OPA代理容器的CPU资源限制。 | 2 |
OPALimitMemory | string | 否 | OPA代理容器的内存资源限制。 | 1024Mi |
EnableAudit | boolean | 否 | false | |
AuditProject | string | 否 | 网格审计对应的日志项目名称。 默认值: | mesh-log-c08ba3fd1e64xxb0f8cc1ad8**** |
CustomizedZipkin | boolean | 否 | 是否启用自建Zipkin,取值:
默认值: | false |
OutboundTrafficPolicy | string | 否 | 对外部服务的访问策略,取值:
| ALLOW_ANY |
ProxyRequestCPU | string | 否 | CPU所需资源。 | 100m |
ProxyRequestMemory | string | 否 | 内存所需资源。 | 128Mi |
ProxyLimitCPU | string | 否 | CPU资源限制。 | 2000m |
ProxyLimitMemory | string | 否 | 内存资源限制。 | 1024Mi |
IncludeIPRanges | string | 否 | 拦截对外访问的地址范围。 | * |
ExcludeIPRanges | string | 否 | 排除拦截对外访问的地址范围。 | 100.100.XXX.XXX |
ExcludeOutboundPorts | string | 否 | 以英文半角逗号(,)分隔的出站端口列表。 | 80,81 |
IncludeInboundPorts | string | 否 | 设置端口使Inbound流量经过Sidecar。 | 80,81 |
ExcludeInboundPorts | string | 否 | 以英文半角逗号(,)分隔的入站端口列表。 | 80,81 |
EnableNamespacesByDefault | boolean | 否 | 是否为所有命名空间开启自动注入功能,取值:
默认值: | false |
AutoInjectionPolicyEnabled | boolean | 否 | 是否开启通过Pod Annotations实现自动注入Sidecar,取值:
默认值: | false |
SidecarInjectorRequestCPU | string | 否 | Sidecar注入器Pod的CPU请求资源。 | 1000m |
SidecarInjectorRequestMemory | string | 否 | Sidecar注入器Pod的内存请求资源。 | 512Mi |
SidecarInjectorLimitCPU | string | 否 | Sidecar注入器Pod的CPU限制资源。 | 4000m |
SidecarInjectorLimitMemory | string | 否 | Sidecar注入器Pod的内存限制资源。 | 2048Mi |
SidecarInjectorWebhookAsYaml | string | 否 | 其他自动注入Sidecar的配置(YAML格式)。 | {"injectedAnnotations":{"test/istio-init":"runtime/default2","test/istio-proxy":"runtime/default"},"replicaCount":2,"nodeSelector":{"beta.kubernetes.io/os":"linux"}} |
CniEnabled | boolean | 否 | 是否启用CNI,取值:
默认值: | false |
CniExcludeNamespaces | string | 否 | CNI排除的命名空间。 | kube-system |
OpaEnabled | boolean | 否 | 是否启用OPA,取值:
默认值: | false |
Http10Enabled | boolean | 否 | 是否支持HTTP1.0,取值:
默认值: | false |
KialiEnabled | boolean | 否 | 是否启用网格拓扑(需先开启采集Prometheus监控指标,当该项更新为
默认值: | false |
CustomizedPrometheus | boolean | 否 | 是否自定义Prometheus,取值:
默认值: | false |
PrometheusUrl | string | 否 | Prometheus服务地址(非自定义情况下,使用ARMS地址格式)。 | http://prometheus:9090 |
AccessLogEnabled | boolean | 否 | 是否启用访问日志采集,取值:
默认值: | false |
MSEEnabled | boolean | 是 | 是否启用MSE微服务引擎,取值:
默认值: | false |
RedisFilterEnabled | boolean | 否 | 是否启用RedisFilter,取值:
默认值: | false |
MysqlFilterEnabled | boolean | 否 | 是否启用MysqlFilter,取值:
默认值: | false |
ThriftFilterEnabled | boolean | 否 | 是否启用ThriftFilter,取值:
默认值: | false |
WebAssemblyFilterEnabled | boolean | 否 | 是否启用WebAssemblyFilter,取值:
默认值: | false |
DNSProxyingEnabled | boolean | 否 | 是否启用DNS Proxying,取值:
默认值: | false |
DubboFilterEnabled | boolean | 否 | 是否启用DubboFilter,取值:
默认值: | false |
FilterGatewayClusterConfig | boolean | 否 | 是否启用Gateway配置过滤,取值:
默认值: | false |
EnableSDSServer | boolean | 否 | 是否启用SDS服务,取值:
默认值: | false |
AccessLogServiceEnabled | boolean | 否 | 是否启用Envoy的gRPC日志服务,取值:
默认值: | false |
AccessLogServiceHost | string | 否 | 启用Envoy的gRPC日志服务(ALS)的地址。 | 0.0.0.0 |
AccessLogServicePort | integer | 否 | 启用Envoy的gRPC日志服务(ALS)的端口。 | 9999 |
GatewayAPIEnabled | boolean | 否 | 是否启用Gateway API,取值:
默认值: | false |
ConfigSourceEnabled | boolean | 否 | 是否启用外部服务注册中心,取值:
默认值: | false |
ConfigSourceNacosID | string | 否 | Nacos注册中心实例ID。 | mse-cn-tl326****** |
AccessLogFormat | string | 否 | 自定义访问日志的格式(需先启用访问日志,否则自动忽略本项)。本项字符串为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)%"} |
AccessLogFile | string | 否 | 开启和关闭访问日志,取值:
| “” |
AccessLogProject | string | 否 | 自定义日志服务SLS采集的Project。 | mesh-log-cf245a429b6ff4b6e97f20797758e**** |
EnableCRHistory | boolean | 否 | 设置是否启用ASM的Istio资源历史版本管理功能。 | false |
CRAggregationEnabled | boolean | 否 | 设置是否启用数据面集群Kubernetes API访问Istio资源(需ASM实例v1.9.7.93版本以上)。 | false |
TerminationDrainDuration | string | 否 | istio-proxy终止等待时长,例如5秒,输入为5s。 | 5s |
ProxyInitCPUResourceLimit | string | 否 | istio-init初始化容器CPU资源限制。 | 2000m |
ProxyInitMemoryResourceLimit | string | 否 | istio-init初始化容器内存资源限制。 | 1024Mi |
ProxyInitCPUResourceRequest | string | 否 | istio-init初始化容器CPU资源所需。 | 10m |
ProxyInitMemoryResourceRequest | string | 否 | istio-init初始化容器内存资源所需。 | 10Mi |
Lifecycle | string | 否 | istio-proxy生命周期。 | {"postStart":{"exec":{"command":["pilot-agent","wait"]}},"preStop":{"exec":{"command":["/bin/sh","-c","sleep 15"]}}} |
MultiBufferEnabled | boolean | 否 | 开启MultiBuffer加速功能。 | false |
MultiBufferPollDelay | string | 否 | MultiBuffer的策略拉取延迟,默认为空 。 | 0.02s |
DiscoverySelectors | string | 否 | 用于选择性服务发现的数据平面命名空间标签选择器列表。 | [{"matchExpressions":[{"key":"asm-discovery","operator":"Exists"}]}] |
ClusterSpec | string | 否 | 服务网格实例规格,取值:
| standard |
OPAScopeInjected | boolean | 否 | 是否启用OPA注入范围控制能力,取值:
| false |
OPAInjectorCPURequirement | string | 否 | 负责注入OPA代理的Pod所申请的最少CPU核数。例如 | 80m |
OPAInjectorMemoryRequirement | string | 否 | 负责注入OPA代理的Pod所申请的最少内存。例如 | 50Mi |
OPAInjectorCPULimit | string | 否 | 负责注入OPA代理的Pod所限制的最大CPU核数。例如 | 1000m |
OPAInjectorMemoryLimit | string | 否 | 负责注入OPA代理的Pod所限制的最大内存。例如 | 1024Mi |
IntegrateKiali | boolean | 否 | 是否为访问ASM网格拓扑创建SLB。 | false |
NFDEnabled | boolean | 否 | 是否启用节点特征自动获取能力。 | false |
NFDLabelPruned | boolean | 否 | 是否在禁用节点特征自动获取能力时,清除节点上的特征相关标签。 此字段仅在禁用节点特征自动获取能力时(即设置 | false |
TracingOnExtZipkinRequestCPU | string | 否 | 负载链路追踪导出的代理服务所申请的最少CPU核数。例如 | 200m |
TracingOnExtZipkinRequestMemory | string | 否 | 负载链路追踪导出的代理服务所申请的最少内存。例如 | 200Mi |
TracingOnExtZipkinLimitCPU | string | 否 | 负载链路追踪导出的代理服务所限制的最大CPU核数。例如 | 1000Mi |
TracingOnExtZipkinLimitMemory | string | 否 | 负载链路追踪导出的代理服务所限制的最大内存。例如 | 1024Mi |
AccessLogGatewayLifecycle | integer | 否 | 采集到SLS的入口网关访问日志的存储周期(天)。例如 | 30 |
AccessLogSidecarLifecycle | integer | 否 | 采集到SLS的Sidecar访问日志的存储周期(天)。例如 | 30 |
EnableAutoDiagnosis | boolean | 否 | 是否启用网格自动诊断功能(开启后,当修改网格内Istio资源时,将会自动对网格进行诊断)。 | true |
IncludeOutboundPorts | string | 否 | 设置端口使outbound流量经过Sidecar。 | 8000,8001 |
LogLevel | string | 否 | 设置数据面Sidecar代理的日志级别。日志级别按输出日志信息量从低到高排序依次为 | info |
Concurrency | integer | 否 | 设置数据面Sidecar代理的并行度。 | 2 |
HoldApplicationUntilProxyStarts | boolean | 否 | 设置在Pod启动时是否先等待Sidecar代理容器启动再启动业务容器。 | true |
ProxyStatsMatcher | string | 否 | 设定数据面Sidecar代理额外上报的指标。 | {"inclusionRegexps":".*adaptive_concurrency.*"} |
InterceptionMode | string | 否 | Sidecar对入向流量的拦截策略。取值:
| TPROXY |
EnableBootstrapXdsAgent | boolean | 否 | 设定是否令Sidecar代理在启动前加载bootstrap配置 | true |
KialiArmsAuthTokens | string | 否 | 当启用网格拓扑功能且集成ARMS Prometheus采集监控指标时,若ARMS Prometheus实例配置了鉴权token,通过此参数设定ARMS Prometheus的鉴权Token,以授权网格拓扑访问ARMS Prometheus实例。 参数格式为JSON编码的字符串,JSON对象中的键为数据面集群的集群ID,值为数据面集群内安装的ARMS Prometheus实例设定的鉴权Token。 | {"c31e3b******5634b":"token_example"} |
DefaultComponentsScheduleConfig | string | 否 | ASM下发到数据面组件的默认调度配置。支持以JSON的形式配置 说明
| {"tolerations":[{"key":"test-taints", "operator":"Exists", "effect":"NoSchedule"}], "nodeSelector":{"kubernetes.io/hostname":"test-nodes"}} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||||
---|---|---|---|---|---|---|---|---|
2023-04-13 | OpenAPI 入参发生变更 | |||||||
| ||||||||
2023-03-17 | OpenAPI 入参发生变更 | |||||||
| ||||||||
2022-08-17 | OpenAPI 入参发生变更 | |||||||
| ||||||||
2021-10-28 | OpenAPI 入参发生变更 | |||||||
| ||||||||
2021-09-06 | OpenAPI 入参发生变更 | |||||||
| ||||||||
2021-05-25 | OpenAPI 入参发生变更 | |||||||
|