Creates an Alibaba Cloud Service Mesh (ASM) instance.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
RegionId | String | Yes | cn-hangzhou |
The ID of the region where the ASM instance resides. |
VpcId | String | Yes | vpc-xzelac2tw4ic7wz31**** |
The ID of the virtual private cloud (VPC). |
VSwitches | String | Yes | ["vsw-xzegf5dndkbf4m6eg****"] |
The ID of the vSwitch. |
IstioVersion | String | No | v1.5.4.1-g5960ec40-aliyun |
The Istio version of the ASM instance. |
Name | String | No | mesh1 |
The name of the ASM instance. |
ApiServerPublicEip | Boolean | No | false |
Specifies whether to expose the API server to the Internet. Valid values:
Default value: If you do not expose the API server to the Internet, the API server of the clusters cannot be accessed from the Internet. |
PilotPublicEip | Boolean | No | false |
Specifies whether to expose Istio Pilot to the Internet. Valid values:
Default value: If you do not expose Istio Pilot to the Internet, only the clusters in the same VPC as the ASM instance can access Istio Pilot of the ASM instance. |
Tracing | Boolean | No | false |
Specifies whether to enable the tracing feature. To enable this feature, make sure that you have activated Tracing Analysis. Valid values:
Default value: |
TraceSampling | Float | No | 100 |
The sampling percentage of tracing. |
LocalityLoadBalancing | Boolean | No | false |
Specifies whether to route traffic to the nearest instance. Valid values:
Default value: |
Telemetry | Boolean | No | false |
Specifies whether to enable Prometheus monitoring. We recommend that you use Prometheus Service of Application Real-Time Monitoring Service (ARMS). Valid values:
Default value: |
EnableAudit | Boolean | No | false |
Specifies whether to enable the mesh audit feature. To enable this feature, make sure that you have activated Log Service. Valid values:
Default value: |
AuditProject | String | No | mesh-log-xxxx |
The name of the Log Service project that is used for mesh audit. Default value: mesh-log-{ASM instance ID}. |
OpenAgentPolicy | Boolean | No | false |
Specifies whether to install the Open Policy Agent (OPA) plug-in. Valid values:
Default value: |
OPARequestCPU | String | No | 1 |
The number of CPU cores that are requested by OPA. |
OPARequestMemory | String | No | 512Mi |
The size of the memory that is requested by OPA. |
OPALimitCPU | String | No | 2 |
The maximum number of CPU cores that are available to OPA. |
OPALimitMemory | String | No | 1024Mi |
The maximum size of the memory that is available to OPA. |
OPALogLevel | String | No | info |
The log level of OPA.
|
CustomizedZipkin | Boolean | No | false |
Specifies whether to enable a custom Zipkin system. Valid values:
Default value: |
LocalityLBConf | String | No | null |
The configurations for the access to the nearest instance. |
ProxyRequestCPU | String | No | 100m |
The number of CPU cores that are requested by the proxy container. |
ProxyRequestMemory | String | No | 128Mi |
The size of the memory that is requested by the proxy container. |
ProxyLimitCPU | String | No | 2000m |
The maximum number of CPU cores that are available to the proxy container. |
ProxyLimitMemory | String | No | 1024Mi |
The maximum size of the memory that is available to the proxy container. |
IncludeIPRanges | String | No | * |
The IP addresses that are denied to access external services. |
ExcludeIPRanges | String | No | 100.100.100.100 |
The IP addresses that are allowed to access external services. |
ExcludeOutboundPorts | String | No | 80,81 |
The outbound ports. Separate multiple port numbers with commas (,). |
ExcludeInboundPorts | String | No | 80,81 |
The inbound ports. Separate multiple port numbers with commas (,). |
OpaEnabled | Boolean | No | false |
Specifies whether to enable the OPA plug-in. Valid values:
Default value: |
KialiEnabled | Boolean | No | false |
Specifies whether to enable Kiali. To enable Kiali, make sure that Prometheus monitoring is enabled. If Prometheus monitoring is disabled, the value of this parameter must be false. Valid values:
Default value: |
AccessLogEnabled | Boolean | No | false |
Specifies whether to enable access log collection. Valid values:
Default value: |
CustomizedPrometheus | Boolean | No | false |
Specifies whether to use a custom Prometheus instance. Valid values:
Default value: |
PrometheusUrl | String | No | http://prometheus:9090 |
The endpoint of the custom Prometheus instance. |
RedisFilterEnabled | Boolean | No | false |
Specifies whether to enable Redis Filter. Valid values:
Default value: |
MysqlFilterEnabled | Boolean | No | false |
Specifies whether to enable MySQL Filter. Valid values:
Default value: |
ThriftFilterEnabled | Boolean | No | false |
Specifies whether to enable Thrift Filter. Valid values:
Default value: |
WebAssemblyFilterEnabled | Boolean | No | false |
Specifies whether to enable WebAssembly Filter. Valid values:
Default value: |
MSEEnabled | Boolean | No | false |
Specifies whether to enable Microservice Engine (MSE). Valid values:
Default value: |
DNSProxyingEnabled | Boolean | No | false |
Specifies whether to enable DNS Proxying. Valid values:
Default value: |
Edition | String | No | Pro |
The edition of the ASM instance. Valid values:
Default value: |
ConfigSourceEnabled | Boolean | No | false |
Specifies whether to enable a service registry. Valid values:
Default value: |
ConfigSourceNacosID | String | No | mse-cn-tl326****** |
The instance ID of the Nacos registry. |
DubboFilterEnabled | Boolean | No | false |
Specifies whether to enable Dubbo Filter. Valid values:
Default value: |
FilterGatewayClusterConfig | Boolean | No | false |
Specifies whether to enable gateway configuration filtering. Valid values:
Default value: |
EnableSDSServer | Boolean | No | false |
Specifies whether to enable Secret Discovery Service (SDS). Valid values:
Default value: |
AccessLogServiceEnabled | Boolean | No | false |
Specifies whether to enable gRPC Access Log Service (ALS). Valid values:
Default value: |
AccessLogServiceHost | String | No | 0.0.0.0 |
The endpoint of gRPC ALS. |
AccessLogServicePort | Integer | No | 9999 |
The port of gRPC ALS. |
GatewayAPIEnabled | Boolean | No | false |
Specifies whether to enable Gateway API. Valid values:
Default value: |
ControlPlaneLogEnabled | Boolean | No | false |
Specifies whether to collect the logs of the control plane. Valid values:
Default value: |
ControlPlaneLogProject | String | No | mesh-log-c78d60f98fa43403ab6e0701b26****** |
The name of the log project for the control plane. |
AccessLogFormat | String | No | null |
The custom format of access logs. To set this parameter, you must enable access log collection. Otherwise, you cannot set this parameter. The value must be a JSON string and contain the following key values: 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, and x_forwarded_for. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | BD65C0AD-D3C6-48D3-8D93-38D2015C**** |
The ID of the request. |
ServiceMeshId | String | c08ba3fd1e6484b0f8cc1ad8fe10d**** |
The ID of the ASM instance. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=CreateServiceMesh
&RegionId=cn-hangzhou
&VpcId=vpc-xzelac2tw4ic7wz31****
&VSwitches=["vsw-xzegf5dndkbf4m6eg****"]
&<Common request parameters>
Sample success responses
XML
format
<RequestId>BD65C0AD-D3C6-48D3-8D93-38D2015C****</RequestId>
<ServiceMeshId>c08ba3fd1e6484b0f8cc1ad8fe10d****</ServiceMeshId>
JSON
format
{
"RequestId": "BD65C0AD-D3C6-48D3-8D93-38D2015C****",
"ServiceMeshId": "c08ba3fd1e6484b0f8cc1ad8fe10d****"
}
Error codes
HttpCode | Error code | Error message | Description |
---|---|---|---|
404 | ERR404 | Not found | The requested resource does not exist. |
For a list of error codes, visit the API Error Center.