CreateServiceMesh_服务网格_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:CreateServiceMesh
Create
全部资源
*

请求参数

字段名称字段详情
RegionIdstring

服务网格所在地域 ID。

示例值:cn-hangzhou
IstioVersionstring

Istio 版本号。

示例值:v1.5.4.1-g5960ec40-aliyun参考取值来源:
    DescribeUpgradeVersion
VpcIdstring

专有网络 ID。

示例值:vpc-xzelac2tw4ic7wz31****
ApiServerPublicEipboolean

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

示例值:false
Tracingboolean

是否启用链路追踪。取值:展开详情

示例值:false
Namestring

服务网格名称。

示例值:mesh1
VSwitchesstring

虚拟交换机 ID。

示例值:["vsw-xzegf5dndkbf4m6eg****"]参考取值来源:
    DescribeVSwitches
TraceSamplingnumber<float>

链路追踪采样百分比。

示例值:100
CustomizedZipkinboolean

是否使用自建 Zipkin。取值:展开详情

示例值:false
LocalityLoadBalancingboolean

是否启用服务就近访问。取值: 展开详情

示例值:false
LocalityLBConfstring

服务就近访问配置。

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

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

示例值:false
OpenAgentPolicyboolean

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

示例值: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

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

示例值:false
AuditProjectstring

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

示例值:mesh-log-xxxx
ClusterDomainstring

集群本地域名。

示例值:cluster.local参考取值来源:
    DescribeClustersInServiceMesh
ProxyRequestCPUstring

代理容器的 CPU 请求资源。

示例值:100m
ProxyRequestMemorystring

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

示例值:128Mi
ProxyLimitCPUstring

代理容器的 CPU 限制资源。

示例值:2000m
ProxyLimitMemorystring

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

示例值:1024Mi
IncludeIPRangesstring

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

示例值:*
ExcludeIPRangesstring

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

示例值:100.100.10*.***
ExcludeOutboundPortsstring

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

示例值:80,81
ExcludeInboundPortsstring

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

示例值:80,81
OpaEnabledboolean

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

示例值:false
KialiEnabledboolean

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

示例值:false
AccessLogEnabledboolean

是否启用访问日志。取值:展开详情

示例值:false
CustomizedPrometheusboolean

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

示例值:false
PrometheusUrlstring

自定义 Prometheus 服务地址。

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

是否启用 Redis Filter 能力,取值:展开详情

示例值:true
MysqlFilterEnabledboolean

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

示例值:false
ThriftFilterEnabledboolean

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

示例值:false
WebAssemblyFilterEnabledboolean

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

示例值:false
MSEEnabledboolean

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

示例值:false
DNSProxyingEnabledboolean

是否启用 DNS 代理能力。取值:展开详情

示例值:false
Editionstring

ASM 实例版本。

示例值:Pro
ConfigSourceEnabledboolean

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

示例值:false
ConfigSourceNacosIDstring

Nacos 注册中心实例 ID。

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

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

示例值:false
FilterGatewayClusterConfigboolean

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

示例值:false
EnableSDSServerboolean

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

示例值:false
AccessLogServiceEnabledboolean

是否启用 Envoy 的 gRPC 日志服务(ALS)。取值:展开详情

示例值:false
AccessLogServiceHoststring

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

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

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

示例值:9999
GatewayAPIEnabledboolean

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

示例值:false
ControlPlaneLogEnabledboolean

是否启用控制面日志采集。取值:展开详情

示例值: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
AccessLogProjectstring

访问日志采集的 SLS Project。

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

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

示例值:false
CRAggregationEnabledboolean

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

示例值: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 付费类型。取值:展开详情

示例值:PrePay
Periodinteger<int32>

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

示例值:3
AutoRenewboolean

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

示例值:true
AutoRenewPeriodinteger<int32>

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

示例值:3
ClusterSpecstring

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

示例值:standard
MultiBufferEnabledboolean

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

示例值: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编码格式
deprecatedExistingCaTypestring

已有的证书类型: 展开详情

示例值:1
ExistingRootCaCertstring

已有的根证书。

示例值:根证书内容,base64 编码格式
deprecatedExistingRootCaKeystring

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

示例值:root key的内容,base64编码格式
CertChainstring

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

示例值:base64编码的PEM证书链。
GuestClusterstring

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

示例值:ACK集群id
Tagarray<object>

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

EnableAmbientboolean

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

示例值:false
PlaygroundScenestring

Playground 场景,指定该值将创建 ASM Playground 实例,可选值:展开详情

示例值:ewmaLb
EnableACMGboolean

是否启用 ACMG 模式。

示例值:false

返回参数

字段名称字段详情
RequestIdstring

请求 ID。

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

服务网格 ID。

示例值:c08ba3fd1e6484b0f8cc1ad8fe10d****

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
404
ERR404
Not found诊断

变更历史

变更时间变更内容概要操作
2024-08-12
新增请求参数EnableACMG
2024-07-12
新增请求参数PlaygroundScene
2024-02-04
变更请求参数ExistingRootCaKey
新增请求参数CertChain
2023-11-13
新增请求参数ClusterDomain
2023-08-15
新增请求参数Tag
2023-08-10
新增请求参数EnableAmbient
2023-08-09
新增请求参数GuestCluster
2023-04-13
删除请求参数GlobalRateLimitEnabled
删除返回参数
2022-11-15
新增请求参数UseExistingCA
新增请求参数ExistingCaCert
新增请求参数ExistingCaKey
新增请求参数ExistingCaType
新增请求参数ExistingRootCaCert
新增请求参数ExistingRootCaKey
  • 1
  • 2
  • 10 条/页

相关示例