文档

CreateServiceMesh - 创建一个服务网格实例

更新时间:

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

调试

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

授权信息

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

请求参数

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

服务网格所在地域 ID。

cn-hangzhou
IstioVersionstring

Istio 版本号。

v1.5.4.1-g5960ec40-aliyun
VpcIdstring

专有网络 ID。

vpc-xzelac2tw4ic7wz31****
ApiServerPublicEipboolean

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

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

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

默认值:false

说明 若配置为false则无法通过外网访问集群 API Server。
false
Tracingboolean

是否启用链路追踪。取值:

  • true:启用链路追踪。

  • false:不启用链路追踪。

默认值:false

false
Namestring

服务网格名称。

mesh1
VSwitchesstring

虚拟交换机 ID。

["vsw-xzegf5dndkbf4m6eg****"]
TraceSamplingfloat

链路追踪采样百分比。

100
CustomizedZipkinboolean

是否使用自建 Zipkin。取值:

  • true:使用自建 Zipkin。

  • false:使用阿里云链路追踪。

默认值:false

false
LocalityLoadBalancingboolean

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

  • true:启用服务就近访问。

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

默认值:false

false
LocalityLBConfstring

服务就近访问配置。

{"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
OPARequestCPUstring

OPA 代理容器的 CPU 资源请求,可以使用 Kubernetes 标准 CPU 表示形式。例如 1 为 1 核 CPU。

1
OPARequestMemorystring

OPA 代理容器的内存资源请求,可以使用 Kubernetes 标准内存表示形式。例如 1 Mi 为 1024 KB。

512Mi
OPALimitCPUstring

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

2
OPALimitMemorystring

OPA 代理容器的内存资源限制,可以使用 Kubernetes 标准内存表示形式。例如 1 Mi 为 1024 KB。

1024Mi
EnableAuditboolean

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

  • true:启用网格审计。

  • false:不启用网格审计。

默认值:false

false
AuditProjectstring

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

默认值:mesh-log-{meshId}。

mesh-log-xxxx
ClusterDomainstring

集群本地域名。

cluster.local
ProxyRequestCPUstring

代理容器的 CPU 请求资源。

100m
ProxyRequestMemorystring

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

128Mi
ProxyLimitCPUstring

代理容器的 CPU 限制资源。

2000m
ProxyLimitMemorystring

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

1024Mi
IncludeIPRangesstring

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

*
ExcludeIPRangesstring

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

100.100.10*.***
ExcludeOutboundPortsstring

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

80,81
ExcludeInboundPortsstring

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

80,81
OpaEnabledboolean

是否启用 OPA。取值:

  • true:启用 OPA。

  • false:不启用 OPA。

默认值:false

false
KialiEnabledboolean

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

  • true:启用网格拓扑。

  • false:不启用网格拓扑。

默认值:false

false
AccessLogEnabledboolean

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

  • true:启用访问日志。

  • false:不启用访问日志。

默认值:false

false
CustomizedPrometheusboolean

是否自定义 Prometheus。取值:

  • true:自定义 Prometheus。

  • false:不自定义 Prometheus。

默认值:false

false
PrometheusUrlstring

自定义 Prometheus 服务地址。

http://prometheus:9090
RedisFilterEnabledboolean

是否启用 Redis Filter 能力,取值:

  • true:启用 Redis Filter 能力。

  • false:不启用 Redis Filter 能力。

默认值:false

true
MysqlFilterEnabledboolean

是否启用 MysqlFilter,取值:

  • true:启用 MysqlFilter。

  • false:不启用 MysqlFilter。

默认值:false

false
ThriftFilterEnabledboolean

是否启用 ThriftFilter。取值:

  • true:启用 ThriftFilter。

  • false:不启用 ThriftFilter。

默认值:false

false
WebAssemblyFilterEnabledboolean

是否启用 WebAssemblyFilter。取值:

  • true:启用 WebAssemblyFilter。

  • false:不启用 WebAssemblyFilter。

默认值:false

false
MSEEnabledboolean

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

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

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

默认值:false

false
DNSProxyingEnabledboolean

是否启用 DNS 代理能力。取值:

  • true:启用 DNS 代理能力。

  • false:不启用 DNS 代理能力。

默认值:false

false
Editionstring

ASM 实例版本。

Pro
ConfigSourceEnabledboolean

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

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

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

默认值:false

false
ConfigSourceNacosIDstring

Nacos 注册中心实例 ID。

mse-cn-tl326******
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 日志服务(ALS)。取值:

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

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

默认值: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
ControlPlaneLogEnabledboolean

是否启用控制面日志采集。取值:

  • true:启用控制面日志采集。

  • false:不启用控制面日志采集。

默认值:false

false
ControlPlaneLogProjectstring

控制面日志采集的 SLS Project。

mesh-log-cf245a429b6ff4b6e97f20797758*****
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:开启访问日志。

/dev/stdout
AccessLogProjectstring

访问日志采集的 SLS Project。

mesh-log-cf245a429b6ff4b6e97f20797758*****
EnableCRHistoryboolean

是否启用 ASM 的 Istio 资源历史版本管理功能。取值:

  • true:启用 ASM 的 Istio 资源历史版本管理功能。

  • false:不启用 ASM 的 Istio 资源历史版本管理功能。

默认值:false

false
CRAggregationEnabledboolean

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

  • true:启用数据面集群 Kubernetes API 访问 Istio 资源。

  • false:不启用数据面集群 Kubernetes API 访问 Istio 资源。

默认值:false

false
ApiServerLoadBalancerSpecstring

APIServer 绑定的 CLB 规格。取值:简约型 I(slb.s1.small)、标准型 I(slb.s2.small)、标准型 II(slb.s2.medium)、高阶型 I(slb.s3.small)、高阶型 II(slb.s3.medium)、超强型 I(slb.s3.large)。

slb.s1.small
PilotLoadBalancerSpecstring

服务网格控制面的 Istio Pilot 绑定的 CLB 规格。取值:简约型 I(slb.s1.small)、标准型 I(slb.s2.small)、标准型 II(slb.s2.medium)、高阶型 I(slb.s3.small) 、高阶型 II(slb.s3.medium)、超强型 I(slb.s3.large)。

slb.s1.small
ChargeTypestring

CLB 付费类型。取值:

  • PayOnDemand:按量付费类型。

  • PrePay:包年包月类型。

PrePay
Periodinteger

ChargeTypePrePay时生效。表示购买包年包月类型的 CLB 时,购买的月份。如果为 1 年,则输入 12。

3
AutoRenewboolean

CLB 为包年包月类型时,是否自动续费。取值:

  • true:自动续费。

  • false:不自动续费。

true
AutoRenewPeriodinteger

ChargeTypePrePay时生效。表示购买包年包月类型的 CLB 时,自动续费的时间。如果为购买时间小于 1 年,此参数表示自动续费多少个月;如果购买时长超过 1 年,此参数表示自动续费多少年。

3
ClusterSpecstring

服务网格实例规格,取值:

  • standard:标准版。

  • enterprise:企业版。

  • ultimate:旗舰版。

standard
MultiBufferEnabledboolean

是否启用基于 MultiBuffer 的 TLS 性能优化。取值:

  • true:开启。

  • false:不开启。

默认值:true

true
MultiBufferPollDelaystring

MultiBuffer 开启状态同步时间。默认30s

30s
UseExistingCAboolean

使用已有的 CA 证书和私钥。

false
ExistingCaCertstring

CA 证书(Base64 Encode 格式),该参数一般用于自建 Istio 迁移 ASM 的场景下,对应自建 Istio 集群的 istio-system 命名空间下名称为 istio-ca-secret 的 secret 的 ca-cert.pem 文件内容。

ca cert内容,base64编码格式
ExistingCaKeystring

CA Key(Base64 Encode 格式)。该参数一般用于自建 Istio 迁移 ASM 的场景下,对应自建 Istio 集群的 istio-system 命名空间下名称为 istio-ca-secret 的 secret 的 ca-key.pem 文件内容。

ca key内容,base64编码格式
ExistingCaTypedeprecatedstring

已有的证书类型:

  • 1:Istiod 自签证书。对应 istio-system 命名空间下名称为 istio-ca-secret 的 secret。若使用该类型,还需要提供ExistingCaCertExsitingCaKey两个参数。

  • 2:Istiod 外部证书。详情请参见plugin ca cert。一般对应为 istio-system 命名空间下名称为 cacerts 的 secret。 若使用该类型,还需要提供ExisingRootCaCertExisingRootCaKey两个参数。

1
ExistingRootCaCertstring

已有的根证书。

根证书内容,base64 编码格式
ExistingRootCaKeydeprecatedstring

已有的根证书对应的私钥。

root key的内容,base64编码格式
CertChainstring

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

base64编码的PEM证书链。
GuestClusterstring

创建网格时可以选择一个集群加入网格,为空时不会添加集群。该集群需要和网格在同一个 VPC 的同一个 VSwitch 中,且集群域名相同。

ACK集群id
Tagobject []

给服务网格实例打 tag 标签。包含以下信息:

  • key:标签名称。

  • value:标签值。

Keystring

标签名称。

env
Valuestring

标签值。

prod
EnableAmbientboolean

是否为服务网格实例启用 Ambient Mesh 模式。

false

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

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

服务网格 ID。

c08ba3fd1e6484b0f8cc1ad8fe10d****

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
404ERR404Not found不存在

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

变更历史

变更时间变更内容概要操作
2024-02-04OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:CertChain
2023-11-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:ClusterDomain
2023-08-15OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:Tag
2023-08-10OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:EnableAmbient
2023-08-09OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:GuestCluster
2023-04-13OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    删除入参:GlobalRateLimitEnabled
2022-11-15OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:UseExistingCA
    新增入参:ExistingCaCert
    新增入参:ExistingCaKey
    新增入参:ExistingCaType
    新增入参:ExistingRootCaCert
    新增入参:ExistingRootCaKey
2021-12-31OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    删除入参:PilotPublicEip
2021-10-28OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:EnableCRHistory
2021-09-06OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:404
入参OpenAPI 入参发生变更
    新增入参:AccessLogFile
  • 本页导读 (1)
文档反馈