调用CreateServiceMesh接口创建一个服务网格实例。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String cn-hangzhou

服务网格所在地域ID

VpcId String vpc-xzelac2tw4ic7wz31****

专有网络ID

VSwitches String ["vsw-xzegf5dndkbf4m6eg****"]

虚拟交换机ID

IstioVersion String v1.5.4.1-g5960ec40-aliyun

Istio版本号

Name String mesh1

服务网格名称

ApiServerPublicEip Boolean false

是否使用公网地址暴露API Server,取值:

  • true:使用公网地址暴露API Server
  • false:不使用公网地址暴露API Server

默认值:false

若不使用公网地址暴露API Server,则无法通过外网访问集群API Server

PilotPublicEip Boolean false

是否使用公网地址暴露Istio Pilot,取值:

  • true:使用公网地址暴露Istio Pilot
  • false:不使用公网地址暴露Istio Pilot

默认值:false

若没有使用公网地址暴露Istio Pilot,则只有同VPC下的集群可访问Istio Pilot

Tracing Boolean false

启用链路追踪(需要开通 阿里云链路追踪服务),取值:

  • true:启用链路追踪
  • false:不启用链路追踪

默认值:false

TraceSampling Float 100

链路追踪采样百分比

LocalityLoadBalancing Boolean false

是否启用服务就近访问,取值:

  • true:启用服务就近访问
  • false:不启用服务就近访问

默认值:false

Telemetry Boolean false

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

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

默认值:false

EnableAudit Boolean false

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

  • true:启用网格审计
  • false:不启用网格审计

默认值:false

AuditProject String mesh-log-xxxx

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

默认值:mesh-log-{meshId}

OpenAgentPolicy Boolean false

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

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

默认值:false

OPARequestCPU String 1

OPA代理容器的CPU资源请求

OPARequestMemory String 512Mi

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

OPALimitCPU String 2

OPA代理容器的CPU资源限制

OPALimitMemory String 1024Mi

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

OPALogLevel String info

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

  • info:输出所有信息
  • debug:输出调试信息和错误信息
  • error:仅输出错误信息
CustomizedZipkin Boolean false

是否启用自定义Zipkin,取值:

  • true:启用自定义Zipkin
  • false:不启用自定义Zipkin

默认值:false

LocalityLBConf String {"failover":[{"from":"cn-hangzhou","to":"cn-shanghai"}]}

服务就近访问配置

ProxyRequestCPU String 100m

代理容器的CPU请求资源

ProxyRequestMemory String 128Mi

代理容器的内存请求资源

ProxyLimitCPU String 2000m

代理容器的CPU限制资源

ProxyLimitMemory String 1024Mi

代理容器的内存限制资源

IncludeIPRanges String *

拦截对外访问的地址范围

ExcludeIPRanges String 100.100.100.100

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

ExcludeOutboundPorts String 80,81

以逗号分隔的出站端口列表

ExcludeInboundPorts String 80,81

以逗号分隔的入站端口列表

OpaEnabled Boolean false

是否启用OPA,取值:

  • true:启用OPA
  • false:不启用OPA

默认值:false

KialiEnabled Boolean false

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

  • true:启用Kiali
  • false:不启用Kiali

默认值:false

AccessLogEnabled Boolean false

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

  • true:启用访问日志
  • false:不启用访问日志

默认值:false

CustomizedPrometheus Boolean false

是否自定义Prometheus,取值:

  • true:自定义Prometheus
  • false:不自定义Prometheus

默认值:false

PrometheusUrl String http://prometheus:9090

自定义Prometheus服务地址

RedisFilterEnabled Boolean false

是否启用RedisFilter,取值:

  • true:启用RedisFilter
  • false:不启用RedisFilter

默认值:false

MysqlFilterEnabled Boolean false

是否启用MysqlFilter,取值:

  • true:启用MysqlFilter
  • false:不启用MysqlFilter

默认值:false

ThriftFilterEnabled Boolean false

是否启用ThriftFilter,取值:

  • true:启用ThriftFilter
  • false:不启用ThriftFilter

默认值:false

WebAssemblyFilterEnabled Boolean false

是否启用WebAssemblyFilter,取值:

  • true:启用WebAssemblyFilter
  • false:不启用WebAssemblyFilter

默认值:false

MSEEnabled Boolean false

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

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

默认值:false

DNSProxyingEnabled Boolean false

是否启用DNS Proxying,取值:

  • true:启用DNS Proxying
  • false:不启用DNS Proxying

默认值:false

Edition String Pro

实例规格,取值:

  • Default:标准版
  • Pro:Pro版

默认值:Default

ConfigSourceEnabled Boolean false

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

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

默认值:false

ConfigSourceNacosID String mse-cn-tl326******

Nacos注册中心实例ID

DubboFilterEnabled Boolean false

是否启用DubboFilter,取值:

  • true:启用DubboFilter
  • false:不启用DubboFilter

默认值:false

FilterGatewayClusterConfig Boolean false

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

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

默认值:false

EnableSDSServer Boolean false

是否启用SDS服务,取值:

  • true:启用SDS服务
  • false:不启用SDS服务

默认值:false

AccessLogServiceEnabled Boolean false

是否启用日志访问服务,取值:

  • true:启用日志访问服务
  • false:不启用日志访问服务

默认值:false

AccessLogServiceHost String 0.0.0.0

启用的日志访问服务地址

AccessLogServicePort Integer 9999

启用的日志访问服务端口

GatewayAPIEnabled Boolean false

是否启用Gateway API,取值:

  • true:启用Gateway API
  • false:不启用Gateway API

默认值:false

ControlPlaneLogEnabled Boolean false

是否输出控制面日志,取值:

  • true:输出控制面日志
  • false:不输出控制面日志

默认值:false

ControlPlaneLogProject String mesh-log-c78d60f98fa43403ab6e0701b26******

控制面日志项目名称

AccessLogFormat String {"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)%"}

自定义访问日志的格式(需先启用访问日志,否则自动忽略本项)。本项字符串为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

返回数据

名称 类型 示例值 描述
RequestId String BD65C0AD-D3C6-48D3-8D93-38D2015C****

请求ID

ServiceMeshId String c08ba3fd1e6484b0f8cc1ad8fe10d****

服务网格ID

示例

请求示例

http(s)://[Endpoint]/?Action=CreateServiceMesh
&RegionId=cn-hangzhou
&VpcId=vpc-xzelac2tw4ic7wz31****
&VSwitches=["vsw-xzegf5dndkbf4m6eg****"]
&<公共请求参数>

正常返回示例

XML格式

<RequestId>BD65C0AD-D3C6-48D3-8D93-38D2015C****</RequestId>
<ServiceMeshId>c08ba3fd1e6484b0f8cc1ad8fe10d****</ServiceMeshId>

JSON格式

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

错误码

HttpCode 错误码 错误信息 描述
404 ERR404 Not found 不存在

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