# Alibaba Cloud Service Mesh API

> Alibaba Cloud Service Mesh API on Apizie: 91 endpoints (Adds a cluster to a service mesh, AddVmAppToMesh, Creates an ASM gateway, Creates a gateway secret, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:aliyun-servicemesh`
- Category: Cloud
- Status: byok
- Source: https://api.alibabacloud.com/product/servicemesh
- Page: https://zieapi.vercel.app/api/cloud/aliyun-servicemesh
- OpenAPI: https://zieapi.vercel.app/api/cloud/aliyun-servicemesh/openapi.json

Alibaba Cloud OpenAPI for Service Mesh (servicemesh, version 2020-01-11). Calls are signed with ACS3-HMAC-SHA256 using your AccessKey ID and secret.

## Endpoints

### Adds a cluster to a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/add-cluster-into-service-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| ClusterId | string | yes | The ID of the cluster to add |
| IgnoreNamespaceCheck | string | no | Specifies whether to skip checking for the \`istio-system\` namespace in the target cluster. This parameter is typically used when you… |
| Kubeconfig | string | no | The cluster certificate |
| DiscoveryOnly | string | no | Specifies whether to add the cluster for service discovery only |

### AddVmAppToMesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/add-vm-app-to-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ServiceMeshId |
| Namespace | string | yes | The Namespace |
| ServiceName | string | yes | The ServiceName |
| Ips | string | yes | The Ips |
| Ports | string | yes | The Ports |
| Labels | string | yes | The Labels |
| Annotations | string | no | The Annotations |
| ServiceAccount | string | no | The ServiceAccount |
| Force | string | no | The Force |

### Creates an ASM gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-asmgateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| Body | string | no | The YAML content for the ASM gateway |

### Creates a gateway secret
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-gateway-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| SecretName | string | no | The name of the secret |
| Cert | string | no | The content of the certificate |
| Key | string | no | The private key of the certificate |

### Creates a domain name certificate for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-istio-gateway-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| IstioGatewayName | string | yes | The name of the ASM gateway |
| Hosts | string | yes | One or more hosts exposed by the gateway. Separate multiple hosts with commas (,) |
| Number | integer | yes | The port number provided by the gateway |
| PortName | string | yes | The name of the port |
| Protocol | string | yes | The protocol. Valid values: `HTTP`, `HTTPS`, `GRPC`, `HTTP2`, `MONGO`, `TCP`, and `TLS` |
| Credential | string | no | The name of the secret that contains the Transport Layer Security (TLS) certificate and the certificate authority (CA) certificate |
| ForceHttps | string | no | Specifies whether to enforce TLS encryption for connections. Valid values: `true`: Enforces TLS encryption for connections. `false`: Does… |
| Namespace | string | no | The namespace |
| Limit | string | no | The maximum number of gateway resources to query |

### Creates routes for an ASM gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-istio-gateway-routes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| GatewayRoute | string | no | The information about the gateway route (JSON-encoded) |
| Priority | integer | no | The priority of the route. A smaller integer indicates a higher priority |
| Status | integer | no | The status of the gateway route. Valid values: `0`: online. `1`: offline. `2`: creation or update error |
| Description | string | no | The description of the route |

### Creates a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-service-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Service Mesh instance resides |
| IstioVersion | string | no | The Istio version |
| VpcId | string | yes | The virtual private cloud (VPC) ID |
| ApiServerPublicEip | string | no | Specifies whether to expose the API server to the Internet. Valid values: `true`: Exposes the API server to the Internet. `false`: Does… |
| Tracing | string | no | Specifies whether to enable Tracing Analysis. Valid values: `true`: Enables Tracing Analysis. `false`: Disables Tracing Analysis. Default… |
| Name | string | no | The name of the Service Mesh instance |
| VSwitches | string | yes | The virtual switch ID |
| TraceSampling | number | no | The tracing sampling percentage |
| CustomizedZipkin | string | no | Specifies whether to use a self-managed Zipkin system. Valid values: `true`: Uses a self-managed Zipkin system. `false`: Uses Alibaba… |
| LocalityLoadBalancing | string | no | Specifies whether to enable locality load balancing. Valid values: `true`: Enables locality load balancing. `false`: Disables locality… |
| LocalityLBConf | string | no | The configurations of locality load balancing |
| Telemetry | string | no | Specifies whether to enable Prometheus monitoring. We recommend that you use Managed Service for Prometheus… |
| OpenAgentPolicy | string | no | Specifies whether to integrate with the Open Policy Agent (OPA) plug-in. Valid values: `true`: Integrates with the OPA plug-in. `false`:… |
| OPALogLevel | string | no | The log level of the OPA proxy container |
| OPARequestCPU | string | no | The CPU resource request of the OPA proxy container. You can use the standard Kubernetes CPU format. For example, 1 indicates one vCPU |
| OPARequestMemory | string | no | The memory resource request of the OPA proxy container. You can use the standard Kubernetes memory format. For example, 1 Mi indicates… |
| OPALimitCPU | string | no | The CPU resource limit of the OPA proxy container |
| OPALimitMemory | string | no | The memory resource limit of the OPA proxy container. You can use the standard Kubernetes memory format. For example, 1 Mi indicates 1024 KB |
| EnableAudit | string | no | Specifies whether to enable mesh audit. To enable this feature, you must first activate Simple Log Service… |
| AuditProject | string | no | The name of the Simple Log Service project that is used for mesh audit. Default value: mesh-log-{meshId} |
| ClusterDomain | string | no | The cluster domain |
| ProxyRequestCPU | string | no | The CPU resource request of the proxy container |
| ProxyRequestMemory | string | no | The memory resource request of the proxy container |
| ProxyLimitCPU | string | no | The CPU resource limit of the proxy container |
| ProxyLimitMemory | string | no | The memory resource limit of the proxy container |
| IncludeIPRanges | string | no | The IP address ranges that are allowed to access the proxy |
| ExcludeIPRanges | string | no | The IP address ranges that are not allowed to access the proxy |
| ExcludeOutboundPorts | string | no | A comma-separated list of outbound ports to be excluded |
| ExcludeInboundPorts | string | no | A comma-separated list of inbound ports to be excluded |
| OpaEnabled | string | no | Specifies whether to enable OPA. Valid values: `true`: Enables OPA. `false`: Disables OPA. Default value: `false` |
| KialiEnabled | string | no | Specifies whether to enable the mesh topology feature. To enable this feature, you must first enable Prometheus monitoring. If Prometheus… |
| AccessLogEnabled | string | no | Specifies whether to enable access log. Valid values: `true`: Enables access log. `false`: Disables access log. Default value: `false` |
| CustomizedPrometheus | string | no | Specifies whether to use a self-managed Prometheus system. Valid values: `true`: Uses a self-managed Prometheus system. `false`: Does not… |
| PrometheusUrl | string | no | The endpoint of the self-managed Prometheus system |
| RedisFilterEnabled | string | no | Specifies whether to enable the Redis filter. Valid values: `true`: Enables the Redis filter. `false`: Disables the Redis filter. Default… |
| MysqlFilterEnabled | string | no | Specifies whether to enable the MySQL filter. Valid values: `true`: Enables the MySQL filter. `false`: Disables the MySQL filter. Default… |
| ThriftFilterEnabled | string | no | Specifies whether to enable the Thrift filter. Valid values: `true`: Enables the Thrift filter. `false`: Disables the Thrift filter.… |
| WebAssemblyFilterEnabled | string | no | Specifies whether to enable the WebAssembly filter. Valid values: `true`: Enables the WebAssembly filter. `false`: Disables the… |
| MSEEnabled | string | no | Specifies whether to enable Microservices Engine (MSE). Valid values: `true`: Enables MSE. `false`: Disables MSE. Default value: `false` |
| DNSProxyingEnabled | string | no | Specifies whether to enable DNS proxy. Valid values: `true`: Enables DNS proxy. `false`: Disables DNS proxy. Default value: `false` |
| Edition | string | no | The edition of the ASM instance |
| ConfigSourceEnabled | string | no | Specifies whether to enable an external service registry. Valid values: `true`: Enables an external service registry. `false`: Disables an… |
| ConfigSourceNacosID | string | no | The ID of the Nacos instance |
| DubboFilterEnabled | string | no | Specifies whether to enable the Dubbo filter. Valid values: `true`: Enables the Dubbo filter. `false`: Disables the Dubbo filter. Default… |
| FilterGatewayClusterConfig | string | no | Specifies whether to enable gateway configuration filtering. Valid values: `true`: Enables gateway configuration filtering. `false`:… |
| EnableSDSServer | string | no | Specifies whether to enable the Secret Discovery Service (SDS). Valid values: `true`: Enables SDS. `false`: Disables SDS. Default value:… |
| AccessLogServiceEnabled | string | no | Specifies whether to enable the gRPC Access Log Service (ALS) for Envoy. Valid values: `true`: Enables the gRPC ALS for Envoy. `false`:… |
| AccessLogServiceHost | string | no | The endpoint of the gRPC ALS for Envoy |
| AccessLogServicePort | integer | no | The port of the gRPC ALS for Envoy |
| GatewayAPIEnabled | string | no | Specifies whether to enable the Gateway API. Valid values: `true`: Enables the Gateway API. `false`: Disables the Gateway API. Default… |
| ControlPlaneLogEnabled | string | no | Specifies whether to enable control plane log collection. Valid values: `true`: Enables control plane log collection. `false`: Disables… |
| ControlPlaneLogProject | string | no | The Simple Log Service project for control plane log collection |
| AccessLogFormat | string | no | The custom format of access logs. This parameter is available only if you enable access log. The value must be a JSON string that contains… |
| AccessLogFile | string | no | Specifies whether to enable or disable access log. Valid values: "": Disables access log. `/dev/stdout`: Enables access log |
| AccessLogProject | string | no | The Simple Log Service project for access log collection |
| EnableCRHistory | string | no | Specifies whether to enable the history version management feature for Istio resources in ASM. Valid values: `true`: Enables the history… |
| CRAggregationEnabled | string | no | Specifies whether to enable data plane clusters to access Istio resources using the Kubernetes API. This feature is available only for ASM… |
| ApiServerLoadBalancerSpec | string | no | The specification of the Server Load Balancer (SLB) instance that is bound to the API server. Valid values: `slb.s1.small`,… |
| PilotLoadBalancerSpec | string | no | The specification of the SLB instance that is bound to Istio Pilot of the control plane. Valid values: `slb.s1.small`, `slb.s2.small`,… |
| ChargeType | string | no | The billing method of the SLB instance. Valid values: `PayOnDemand`: Pay-as-you-go. `PrePay`: Subscription |
| Period | integer | no | This parameter is valid only if you set `ChargeType` to `PrePay`. The subscription duration of the SLB instance. Unit: months. If you want… |
| AutoRenew | string | no | Specifies whether to enable auto-renewal for the subscription SLB instance. Valid values: `true`: Enables auto-renewal. `false`: Disables… |
| AutoRenewPeriod | integer | no | This parameter is valid only if you set `ChargeType` to `PrePay`. The auto-renewal period. If the subscription duration is less than one… |
| ClusterSpec | string | no | The specification of the Service Mesh instance. Valid values: `standard`: Standard Edition. `enterprise`: Enterprise Edition. `ultimate`:… |
| MultiBufferEnabled | string | no | Specifies whether to enable TLS performance optimization that is based on MultiBuffer. Valid values: `true`: Enables the feature. `false`:… |
| MultiBufferPollDelay | string | no | The synchronization period of the MultiBuffer enabling status. Default value: `30s` |
| UseExistingCA | string | no | Specifies whether to use an existing certificate authority (CA) certificate and private key |
| ExistingCaCert | string | no | The CA certificate in Base64-encoded format. This parameter is typically used to migrate a self-managed Istio cluster to ASM. The value… |
| ExistingCaKey | string | no | The CA private key in Base64-encoded format. This parameter is typically used to migrate a self-managed Istio cluster to ASM. The value… |
| ExistingCaType | string | no | The type of the existing certificate: 1: A self-signed certificate of Istiod. This corresponds to the istio-ca-secret secret in the… |
| ExistingRootCaCert | string | no | The existing root certificate |
| ExistingRootCaKey | string | no | The private key that corresponds to the existing root certificate |
| CertChain | string | no | The certificate chain from the CA certificate to the root certificate. The chain must contain at least two certificates |
| GuestCluster | string | no | When you create a Service Mesh instance, you can add a cluster to the instance. If you do not specify this parameter, no cluster is added.… |
| Tag | string | no | The tags to add to the Service Mesh instance. The following information is included: key: The tag key. value: The tag value (JSON-encoded) |
| EnableAmbient | string | no | Specifies whether to enable the Ambient Mesh mode for the Service Mesh instance |
| PlaygroundScene | string | no | The playground scenario. If you specify this parameter, an ASM playground instance is created. Valid value: ewmaLb: the exponentially… |
| EnableACMG | string | no | Specifies whether to enable the ACMG mode |

### Creates a swimlane
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-swim-lane` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh (ASM) instance ID |
| SwimLaneName | string | no | The name of the swimlane |
| LabelSelectorKey | string | no | The label of the workload. The value is fixed to `ASM_TRAFFIC_TAG` |
| ServicesList | string | no | The list of services to associate with the swimlane. The value is a JSON array. The format for a single service is… |
| LabelSelectorValue | string | no | The value of the `ASM_TRAFFIC_TAG` label for the service workload |
| GroupName | string | no | The name of the swimlane group |

### Creates a traffic lane group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-swim-lane-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| ServicesList | string | yes | The services to associate with the swimlane group. The value must be a JSON array. The format for a single service is… |
| GroupName | string | yes | The name of the swimlane group |
| IngressType | string | yes | The type of Ingress traffic. Only ASM gateways are supported |
| IngressGatewayName | string | yes | The name of the ASM gateway used for traffic routing. A gateway rule that has the same name as the ASM gateway is required. For ASM… |
| IsPermissive | string | no | Specifies whether to create the swimlane in loose mode |
| TraceHeader | string | no | The request header for passing through requests in a loose-mode swimlane group. This parameter is required if IsPermissive is set to true |
| RouteHeader | string | no | The request header for routing traffic in a loose-mode swimlane group. This parameter is required if IsPermissive is set to true |
| IngressGatewayNamespace | string | no | The namespace of the gateway rule used to route traffic for the swimlane group. This parameter is available for ASM instances of… |

### Creates a waypoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/create-waypoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| ClusterId | string | yes | The ID of the data plane cluster |
| Namespace | string | yes | The namespace |
| ServiceAccount | string | no | The service account for the waypoint. If this parameter is empty, the waypoint applies to the entire namespace |
| RequestCPU | string | no | The CPU resources requested for the waypoint pod |
| RequestMemory | string | no | The memory resources requested for the waypoint pod |
| LimitCPU | string | no | The CPU limit for the waypoint pod |
| LimitMemory | string | no | The memory limit for the waypoint pod |
| Replicas | integer | no | The number of replicas for the waypoint pod |
| HPAEnabled | string | no | Specifies whether to enable Horizontal Pod Autoscaling (HPA) |
| HPATargetCPU | integer | no | The target CPU utilization for HPA |
| HPATargetMemory | integer | no | The target memory usage for HPA |
| HPAMinReplicas | integer | no | The minimum number of replicas for HPA |
| HPAMaxReplicas | integer | no | The maximum number of replicas for HPA |
| PreferECI | string | no | Specifies whether to preferentially schedule the waypoint to Elastic Container Instance (ECI) nodes |

### Deletes a gateway route
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-gateway-route` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh instance ID |
| IstioGatewayName | string | no | The name of the ASM gateway |
| RouteName | string | no | The name of the route |

### Deletes a gateway key
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-gateway-secret` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| SecretName | string | no | The name of the key |

### Deletes domains from an Istio gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-istio-gateway-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| Hosts | string | no | One or more hosts exposed by the gateway. Separate multiple hosts with commas (,) |
| PortName | string | no | The port name |
| Namespace | string | no | The namespace |
| Limit | string | no | The maximum number of gateway resources to query |

### Deletes a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-service-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh instance ID |
| Force | string | no | Specifies whether to force delete the ASM instance. Valid values: `true`: Force deletes the ASM instance. `false`: Does not force delete… |
| RetainResources | string | no | A JSON string that can be parsed into an array of strings. The array contains the instance IDs of the resources to retain when you delete… |

### Deletes a specified swim lane
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-swim-lane` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh ID |
| SwimLaneName | string | no | The name of the swim lane |
| GroupName | string | no | The name of the swim lane group |

### Deletes a specific swim lane group. This operation also deletes the swim lanes and traffic routing rules…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-swim-lane-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| GroupName | string | no | The name of the swim lane group |

### Deletes a Waypoint resource
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/delete-waypoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| ClusterId | string | yes | The ID of the data plane cluster |
| Namespace | string | yes | The namespace |
| Name | string | yes | The name of the Waypoint |

### Retrieves information about services imported into an ASM gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-asmgateway-imported-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| ASMGatewayName | string | no | The name of the ASM gateway |
| ServiceNamespace | string | no | The namespace where the service resides |

### You can call DescribeCCMVersion to query the version of the cloud-controller-manager (CCM) component
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-ccmversion` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |

### DescribeCens retrieves the results of a network connectivity test for multiple clusters across different…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-cens` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | no | The ID of the Service Mesh (ASM) instance |

### Retrieves information about Grafana reports for a cluster in a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-cluster-grafana` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (SM) instance |
| K8sClusterId | string | yes | The ID of the data plane cluster |
| ReAddPrometheusIntegration | string | no | Specifies whether to reintegrate Prometheus for the data plane cluster |

### You can call the DescribeClusterPrometheus operation to retrieve the public endpoint of Prometheus for a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-cluster-prometheus` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | no | The ID of the Service Mesh instance |
| K8sClusterId | string | no | The ID of the data plane cluster |
| K8sClusterRegionId | string | no | The region ID of the data plane cluster |

### The `DescribeClustersInServiceMesh` operation retrieves information about one or more clusters in a service…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-clusters-in-service-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |

### Call the DescribeCrTemplates operation to query YAML templates for Istio resources that are used in common…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-cr-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| IstioVersion | string | yes | The Istio version that the service mesh uses |
| Kind | string | yes | The type of Istio resource for which you want to obtain common templates. Valid values: AuthorizationPolicy RequestAuthentication… |

### Queries a list of Elastic IP Address (EIP) resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-eip-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | no | The ID of the ASM instance |
| PageNum | integer | no | The page number for paged queries. The first page is returned by default |
| PageSize | integer | no | The number of entries to return on each page |

### Queries the details of the certificate and key for a gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-gateway-secret-details` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| IstioGatewayName | string | no | The name of the ASM gateway |

### Retrieves the access log reports of a data plane cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-guest-cluster-access-log-dashboards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| K8sClusterId | string | yes | The ID of the data plane cluster |

### Call DescribeGuestClusterNamespaces to retrieve a list of namespaces from a Kubernetes cluster that is added…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-guest-cluster-namespaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| GuestClusterID | string | yes | The ID of the Kubernetes cluster that is added to the service mesh |
| ShowNsLabels | string | no | Specifies whether to return the labels of the namespaces |

### Retrieves the pods in a specified namespace of a Kubernetes cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-guest-cluster-pods` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The service mesh ID |
| GuestClusterID | string | yes | The ID of the Kubernetes cluster that is added to the service mesh |
| Namespace | string | yes | The namespace |

### Queries the details of services imported into an ASM gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-imported-services-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh instance ID |
| ASMGatewayName | string | no | The name of the gateway |
| ServiceNamespace | string | no | The namespace where the service resides |

### Returns a list of gateway domain names
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-istio-gateway-domains` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| Namespace | string | no | The namespace |
| Limit | string | no | The maximum number of entries to return |

### Queries the details of a gateway routing rule
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-istio-gateway-route-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| RouteName | string | no | The name of the routing rule |

### Queries the routes of a gateway in a Service Mesh (ASM) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-istio-gateway-routes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| IstioGatewayName | string | no | The name of the ASM gateway |

### Describes the network partition configurations for multiple Kubernetes clusters in a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-mesh-multi-cluster-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |

### Retrieves the basic information about a Service Mesh (ASM) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |

### Call `DescribeNamespaceScopeSidecarConfig` to query the namespace-level sidecar configuration
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-namespace-scope-sidecar-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh (ASM) instance ID |
| Namespace | string | no | The namespace |

### You can call the DescribeNodesInstanceType operation to query the types of data plane nodes and determine…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-nodes-instance-type` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |

### Retrieves reusable Classic Load Balancer (CLB) instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-reusable-slb` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| K8sClusterId | string | no | The ID of the data plane cluster. You must specify either this parameter or ServiceMeshId, but not both |
| NetworkType | string | yes | The network type. Valid values: `intranet`: virtual private cloud (VPC) `internet`: Internet |
| LbType | string | no | The type of the load balancer. Valid values: `clb`: Classic Load Balancer `nlb`: Network Load Balancer (NLB) The default value is `clb` |
| ServiceMeshId | string | no | The ID of the ASM instance. You must specify either this parameter or K8sClusterId, but not both |

### Call DescribeServiceMeshAdditionalStatus to query information about additional checks for an ASM instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-additional-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| CheckMode | string | no | The check mode of the service mesh. Valid values: `normal`: Checks the status of only the API Server load balancing, Pilot load balancing,… |

### Queries the available clusters in a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-clusters` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | no | The service mesh ID |
| Offset | integer | no | The start position of the query |
| Limit | integer | no | The maximum number of clusters to return |

### Call DescribeServiceMeshDetail to retrieve the details of a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |

### Retrieves the KubeConfig configuration for a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-kubeconfig` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| PrivateIpAddress | string | no | Specifies whether to access the instance over an internal network |

### Retrieves service mesh logs
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-logs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |

### Queries the status of an Istio proxy
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-proxy-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |

### Queries the upgrade status of an ASM instance and its ASM gateways
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-mesh-upgrade-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| GuestClusterIds | string | no | The IDs of the data plane clusters that are added to the ASM instance. Separate multiple IDs with commas |
| AllIstioGatewayFullNames | string | no | The fully qualified names of the ASM gateways. Separate multiple names with commas |

### Queries a list of service meshes
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-service-meshes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| Tag | string | no | The list of tags (JSON-encoded) |

### Call DescribeUpgradeVersion to retrieve the available upgrade versions for a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-upgrade-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |

### Obtains the authorizations for a RAM user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-user-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| SubAccountUserId | string | yes | The ID of the RAM user or RAM role |

### Call DescribeUsersWithPermissions to retrieve the IDs of all Resource Access Management (RAM) users or RAM…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-users-with-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| UserType | string | yes | Specifies whether to list the IDs of RAM users or RAM roles. Valid values: `SubUser`: Lists the IDs of RAM users. `RamRole`: Lists the IDs… |

### Retrieves a list of vSwitches in a specified region and VPC
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-vswitches` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| RegionId | string | yes | The region ID |
| VpcId | string | yes | The VPC ID |

### Call DescribeVersions to retrieve the available ASM versions for creating a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |

### Call DescribeVpcs to retrieve available VPCs in a specified region
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/describe-vpcs` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| RegionId | string | yes | Region ID |

### Obtains the CA certificate
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-ca-cert` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh ID |

### Retrieves a list of workloads that are specified by a selector
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-deployment-by-selector` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| GuestCluster | string | no | The name of the cluster |
| NameSpace | string | no | The namespace |
| Limit | integer | no | The maximum number of entries to return |
| Mark | string | no | The pagination token that is returned from the previous query |
| LabelSelector | string | no | The label selector (JSON-encoded) |

### Retrieves a Grafana dashboard URL from ARMS
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-grafana-dashboard-url` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The service mesh ID |
| K8sClusterId | string | yes | The ID of the ACK or ASK cluster |
| Title | string | yes | The name of the dashboard |

### You can call GetRegisteredServiceEndpoints to retrieve information about registered service endpoints
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-registered-service-endpoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| Namespace | string | no | The namespace |
| ClusterIds | string | no | A list of cluster IDs, separated by commas |
| Name | string | no | The service name |
| ServiceType | string | no | The type of the service. Valid values: `ServiceEntry`: a service registered in the Service Mesh by a service entry. `Kubernetes`: a… |

### Call GetRegisteredServiceNamespaces to retrieve a list of namespaces for registered services
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-registered-service-namespaces` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |

### You can call GetSwimLaneDetail to retrieve the details of a specific swimlane
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-swim-lane-detail` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The service mesh ID |
| SwimLaneName | string | no | The name of the swimlane |
| GroupName | string | no | The name of the swimlane group |

### Lists all traffic lane groups in a Service Mesh (ASM) instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-swim-lane-group-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |

### Call GetSwimLaneList to retrieve a list of all swimlanes in a swimlane group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/get-swim-lane-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh instance ID |
| GroupName | string | no | The name of the swimlane group |

### Updates the permissions of a RAM user
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/grant-user-permissions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| SubAccountUserId | string | no | The ID of the RAM user or RAM role |
| Permissions | string | no | The list of permissions. The value is a JSON array string. You must pass all permissions. To add a permission, add an item to the list. To… |
| SubAccountUserIds | string | no | A list of RAM user or RAM role IDs. You can grant permissions to multiple users at a time (JSON-encoded) |

### This operation retrieves a list of all service accounts
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/list-service-accounts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the service mesh |
| ClusterId | string | yes | The ID of the data plane cluster |
| Namespace | string | no | The namespace |

### Queries user tags for one or more instances
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/list-tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Service Mesh (ASM) instance is located |
| ResourceType | string | yes | A required parameter. The value must be `servicemesh` |
| ResourceId | string | no | A list of Service Mesh instance IDs (JSON-encoded) |
| Tag | string | no | A list of tags. It can contain up to 20 items (JSON-encoded) |
| NextToken | string | no | The token that is used to retrieve the next page of results. If this parameter is empty, all results have been returned |

### Retrieves all Waypoint configurations in a namespace of a data plane cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/list-waypoints` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| ClusterId | string | yes | The ID of the data plane cluster |
| Namespace | string | no | The namespace |
| Name | string | no | The name of the waypoint. If this parameter is left empty, all waypoints are returned. Otherwise, only the waypoint with the specified… |
| Limit | integer | no | The maximum number of waypoints to return |
| Continue | string | no | A pagination token used to retrieve the next page of results. For the first call, leave this parameter empty. If the response includes a… |

### Attach or detach an EIP from an API server
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/modify-api-server-eip-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | no | The ID of the ASM instance |
| Operation | string | no | The type of the operation. Valid values: `UnBindEip`: Detaches an EIP. `BindEip`: Attaches an EIP |
| ApiServerEipId | string | no | The ID of the EIP instance |

### Modifies the elastic IP address (EIP) of a pilot instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/modify-pilot-eip-resource` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | no | The Service Mesh instance ID |
| Operation | string | no | The operation to perform. Valid values: `UnBindEip`: Detach an EIP. `BindEip`: Attach an EIP |
| EipId | string | no | The ID of the Elastic IP Address (EIP) instance |
| IsCanary | string | no | The type of pilot to which the EIP is attached. Valid values: `true`: The EIP is attached to a canary pilot. This value is valid only… |

### Changes the name of a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/modify-service-mesh-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| Name | string | yes | The new name of the Service Mesh instance |

### Recreates a mesh audit log. If you accidentally delete the SLS project that stores audit logs after enabling…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/re-activate-audit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| EnableAudit | string | no | Specifies whether to recreate the ASM audit log. Valid values: true: Recreates the ASM audit log. false: Does not recreate the ASM audit log |

### Deletes a cluster from a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/remove-cluster-from-service-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The service mesh ID |
| ClusterId | string | yes | The ID of the cluster to delete |
| ReserveNamespace | string | no | Specifies whether to retain the istio-system namespace when the cluster is removed |

### RemoveVmAppFromMesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/remove-vm-app-from-mesh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ServiceMeshId |
| Namespace | string | yes | The Namespace |
| ServiceName | string | yes | The ServiceName |

### Revokes the Kubeconfig for an ASM instance and generates a new Kubeconfig
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/revoke-kubeconfig` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| PrivateIpAddress | string | no | Specifies whether to return a Kubeconfig for internal access. Valid values: `true`: Returns the Kubeconfig for internal access. `false`:… |

### Adds or modifies tags for one or more resources
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/tag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Service Mesh instance is located |
| ResourceType | string | yes | A required parameter. Set the value to `servicemesh` |
| ResourceId | string | yes | A list of mesh instance IDs (JSON-encoded) |
| Tag | string | yes | The list of tags (JSON-encoded) |

### Deletes user tags from an instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/untag-resources` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| RegionId | string | yes | The ID of the region where the Service Mesh instance is located |
| ResourceType | string | yes | A required parameter. The value must be `servicemesh` |
| ResourceId | string | yes | The IDs of the Service Mesh instances (JSON-encoded) |
| TagKey | string | no | The tag keys (JSON-encoded) |
| All | string | no | Specifies whether to remove all tags. This parameter is valid only when you leave TagKey.N empty. Valid values: true: Remove all tags.… |

### Updates an ASM gateway
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-asmgateway` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| Body | string | no | The new YAML content of the ASM gateway |

### Call UpdateASMGatewayImportedServices to update the services imported into an ASM gateway. You can import or…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-asmgateway-imported-services` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| ServiceNames | string | no | A list of service names. Separate multiple names with commas (,). For example: reviews,sleep |
| ASMGatewayName | string | no | The name of the ASM gateway |
| ServiceNamespace | string | no | The namespace where the services reside |

### Synchronizes namespace information from a Kubernetes cluster that is added to a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-asmnamespace-from-guest-cluster` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh (ASM) instance ID |
| K8sClusterId | string | yes | The ID of the Kubernetes cluster from which to sync namespaces. The Kubernetes cluster is added to the service mesh that is specified by… |

### Updates the log collection configuration for the control plane
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-control-plane-log-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| Enabled | string | yes | Specifies whether to collect control plane logs and send them to SLS |
| Project | string | no | The name of the custom SLS project where control plane logs are stored |
| LogTTLInDay | integer | no | The retention period of the collected logs, in days |

### Updates the configuration of a guest cluster
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-guest-cluster-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| GuestClusterId | string | no | The ID of the Kubernetes cluster |
| SMCEnabled | string | no | Specifies whether to enable SMC-R optimization. This feature improves cross-node communication performance and requires Alibaba Cloud… |

### The UpdateIstioGatewayRoutes operation updates a gateway route
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-istio-gateway-routes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| GatewayRoute | string | no | The information about the gateway route (JSON-encoded) |
| Priority | integer | no | The route priority. The value is an integer. A smaller value indicates a higher priority |
| Status | integer | no | The status of the gateway route. Valid values: `0`: The gateway route is in service. `1`: The gateway route is unpublished. `2`: An error… |
| Description | string | no | The description of the route |

### Modifies the injection settings for a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-istio-injection-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The service mesh ID |
| Namespace | string | yes | The namespace |
| EnableIstioInjection | string | no | Specifies whether to enable automatic injection |
| EnableSidecarSetInjection | string | no | Specifies whether to enable SidecarSet injection |
| IstioRev | string | no | The injection version for the namespace. This parameter is valid only during a canary upgrade of the service mesh. If you specify… |
| DataPlaneMode | string | no | The data plane mode of the namespace. This parameter is valid only if Ambient Mesh mode is enabled for the Service Mesh instance. Valid… |

### Updates the additional information for a route
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-istio-route-additional-status` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh (ASM) instance |
| IstioGatewayName | string | no | The name of the ASM gateway |
| RouteName | string | no | The name of the route |
| Priority | integer | no | The route priority. This is an integer. A smaller value indicates a higher priority |
| Status | integer | no | The status of the route. A value of 0 indicates that the route is published. A value of 1 indicates that the route is unpublished. A value… |
| Description | string | no | The description of the route |

### Updates the status of the feature that allows the data plane to access Istio resources using the KubeAPI
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-mesh-craggregation` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| Enabled | string | no | Specifies whether the data plane can access Istio resources in ASM using the KubeAPI. Valid values: `true`: Enable the feature. `false`:… |
| CPURequirement | string | no | When KubeAPI-based access to Istio resources is enabled, a component is installed in the data plane cluster. This parameter specifies the… |
| MemoryRequirement | string | no | When KubeAPI-based access to Istio resources is enabled, a component is installed in the data plane cluster. This parameter specifies the… |
| CPULimit | string | no | When KubeAPI-based access to Istio resources is enabled, a component is installed in the data plane cluster. This parameter specifies the… |
| MemoryLimit | string | no | When KubeAPI-based access to Istio resources is enabled, a component is installed in the data plane cluster. This parameter specifies the… |
| UsePublicApiServer | string | no | Specifies whether the data plane uses the public endpoint of the ASM API server to access Istio resources. This parameter applies only… |

### Updates the features of a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-mesh-feature` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the service mesh |
| Tracing | string | no | Specifies whether to enable Tracing Analysis. To enable this feature, you must activate Managed Service for OpenTelemetry… |
| TraceSampling | number | no | The sampling percentage for Tracing Analysis |
| TraceCustomTags | string | no | The custom tags for Tracing Analysis. The value must be a JSON string. The structure is as follows: ``` { "name1": CustomTag, "name2":… |
| TraceMaxPathTagLength | string | no | The maximum length of the URI of the request that is contained in the \`HttpUrl\` span tag. Default value: `256` |
| LocalityLoadBalancing | string | no | Specifies whether to enable locality-based load balancing. Valid values: `true`: enables locality-based load balancing. `false`: disables… |
| LocalityLBConf | string | no | The configurations of locality-based load balancing. Valid values: `failover`: the configurations of cross-region failover. Example: ```… |
| Telemetry | string | no | Specifies whether to enable Prometheus to collect metrics. We recommend that you use Managed Service for Prometheus… |
| OpenAgentPolicy | string | no | Specifies whether to integrate with the Open Policy Agent (OPA) plug-in. Valid values: `true`: integrates with the OPA plug-in. `false`:… |
| OPALogLevel | string | no | The log level of the OPA proxy container. Valid values: `info`: outputs all information. `debug`: outputs debugging information and error… |
| OPARequestCPU | string | no | The CPU resource request of the OPA proxy container |
| OPARequestMemory | string | no | The memory resource request of the OPA proxy container |
| OPALimitCPU | string | no | The CPU resource limit of the OPA proxy container |
| OPALimitMemory | string | no | The memory resource limit of the OPA proxy container |
| EnableAudit | string | no | Specifies whether to enable mesh audit. To enable this feature, you must activate Simple Log Service (https://sls.console.aliyun.com/).… |
| AuditProject | string | no | The SLS project that is used for mesh audit. Default value: `mesh-log-{meshId}` |
| CustomizedZipkin | string | no | Specifies whether to use a self-managed Zipkin system. Valid values: `true`: uses a self-managed Zipkin system. `false`: does not use a… |
| OutboundTrafficPolicy | string | no | The policy for accessing external services. Valid values: `ALLOW_ANY`: allows access to all external services. `REGISTRY_ONLY`: allows… |
| ProxyRequestCPU | string | no | The CPU resources required by the proxy |
| ProxyRequestMemory | string | no | The memory resources required by the proxy |
| ProxyLimitCPU | string | no | The CPU resource limit |
| ProxyLimitMemory | string | no | The memory resource limit |
| IncludeIPRanges | string | no | The IP address ranges for which outbound traffic is intercepted |
| ExcludeIPRanges | string | no | The IP address ranges for which outbound traffic is not intercepted |
| ExcludeOutboundPorts | string | no | A comma-separated list of outbound ports that are excluded from redirection |
| IncludeInboundPorts | string | no | The inbound ports for which traffic is redirected to the sidecar proxy |
| ExcludeInboundPorts | string | no | A comma-separated list of inbound ports that are excluded from redirection |
| EnableNamespacesByDefault | string | no | Specifies whether to enable automatic sidecar proxy injection for all namespaces. Valid values: `true`: enables automatic sidecar proxy… |
| AutoInjectionPolicyEnabled | string | no | Specifies whether to enable automatic sidecar proxy injection using pod annotations. Valid values: `true`: enables automatic sidecar proxy… |
| SidecarInjectorRequestCPU | string | no | The CPU resource request of the sidecar injector pod |
| SidecarInjectorRequestMemory | string | no | The memory resource request of the sidecar injector pod |
| SidecarInjectorLimitCPU | string | no | The CPU resource limit of the sidecar injector pod |
| SidecarInjectorLimitMemory | string | no | The memory resource limit of the sidecar injector pod |
| SidecarInjectorWebhookAsYaml | string | no | Other configurations for automatic sidecar proxy injection. The value must be in the YAML format |
| CniEnabled | string | no | Specifies whether to enable Container Network Interface (CNI). Valid values: `true`: enables CNI. `false`: disables CNI. Default value:… |
| CniExcludeNamespaces | string | no | The namespaces that are excluded from CNI |
| OpaEnabled | string | no | Specifies whether to enable OPA. Valid values: `true`: enables OPA. `false`: disables OPA. Default value: `false` |
| Http10Enabled | string | no | Specifies whether to enable support for HTTP 1.0. Valid values: `true`: enables support for HTTP 1.0. `false`: disables support for HTTP… |
| KialiEnabled | string | no | Specifies whether to enable the mesh topology feature. To enable this feature, you must first enable Prometheus to collect metrics. If you… |
| CustomizedPrometheus | string | no | Specifies whether to use a self-managed Prometheus instance. Valid values: `true`: uses a self-managed Prometheus instance. `false`: does… |
| PrometheusUrl | string | no | The endpoint of the Prometheus service. If you do not use a self-managed Prometheus instance, use the endpoint of an ARMS Prometheus… |
| AccessLogEnabled | string | no | Specifies whether to enable access log collection. Valid values: `true`: enables access log collection. `false`: disables access log… |
| MSEEnabled | string | no | Specifies whether to enable Microservices Engine (MSE). Valid values: `true`: enables MSE. `false`: disables MSE. Default value: `false` |
| RedisFilterEnabled | string | no | Specifies whether to enable the Redis filter. Valid values: `true`: enables the Redis filter. `false`: disables the Redis filter. Default… |
| MysqlFilterEnabled | string | no | Specifies whether to enable the MySQL filter. Valid values: `true`: enables the MySQL filter. `false`: disables the MySQL filter. Default… |
| ThriftFilterEnabled | string | no | Specifies whether to enable the Thrift filter. Valid values: `true`: enables the Thrift filter. `false`: disables the Thrift filter.… |
| WebAssemblyFilterEnabled | string | no | Specifies whether to enable the WebAssembly filter. Valid values: `true`: enables the WebAssembly filter. `false`: disables the… |
| DNSProxyingEnabled | string | no | Specifies whether to enable DNS proxying. Valid values: `true`: enables DNS proxying. `false`: disables DNS proxying. Default value: `false` |
| DubboFilterEnabled | string | no | Specifies whether to enable the Dubbo filter. Valid values: `true`: enables the Dubbo filter. `false`: disables the Dubbo filter. Default… |
| FilterGatewayClusterConfig | string | no | Specifies whether to enable gateway configuration filtering. Valid values: `true`: enables gateway configuration filtering. `false`:… |
| EnableSDSServer | string | no | Specifies whether to enable the Secret Discovery Service (SDS). Valid values: `true`: enables the SDS. `false`: disables the SDS. Default… |
| AccessLogServiceEnabled | string | no | Specifies whether to enable the gRPC Access Log Service (ALS) of Envoy. Valid values: `true`: enables the gRPC ALS of Envoy. `false`:… |
| AccessLogServiceHost | string | no | The endpoint of the gRPC ALS of Envoy |
| AccessLogServicePort | integer | no | The port of the gRPC ALS of Envoy |
| GatewayAPIEnabled | string | no | Specifies whether to enable Gateway API. Valid values: `true`: enables Gateway API. `false`: disables Gateway API. Default value: `false` |
| ConfigSourceEnabled | string | no | Specifies whether to use an external service registry. Valid values: `true`: uses an external service registry. `false`: does not use an… |
| ConfigSourceNacosID | string | no | The ID of the Nacos instance |
| AccessLogFormat | string | no | The custom format of access logs. This parameter is ignored if access log collection is disabled. The value must be a JSON string. The… |
| AccessLogFile | string | no | Specifies whether to enable access logs. Valid values: `""`: disables access logs. `/dev/stdout`: enables access logs |
| AccessLogProject | string | no | The custom SLS project to which access logs are collected |
| EnableCRHistory | string | no | Specifies whether to enable the history revision management feature for Istio resources in Service Mesh (ASM) |
| CRAggregationEnabled | string | no | Specifies whether to enable data plane clusters to access Istio resources using the Kubernetes API. This feature is available only for ASM… |
| TerminationDrainDuration | string | no | The duration for which the istio-proxy container waits for connections to drain before termination. For example, a value of 5s indicates 5… |
| ProxyInitCPUResourceLimit | string | no | The CPU resource limit of the istio-init container |
| ProxyInitMemoryResourceLimit | string | no | The memory resource limit of the istio-init container |
| ProxyInitCPUResourceRequest | string | no | The CPU resource request of the istio-init container |
| ProxyInitMemoryResourceRequest | string | no | The memory resource request of the istio-init container |
| Lifecycle | string | no | The lifecycle of the istio-proxy container |
| MultiBufferEnabled | string | no | Specifies whether to enable the MultiBuffer-based acceleration feature |
| MultiBufferPollDelay | string | no | The polling delay for the MultiBuffer feature. The default value is empty |
| DiscoverySelectors | string | no | The label selectors for the namespaces of the data plane. The selectors are used for selective service discovery |
| ClusterSpec | string | no | The instance type of the service mesh. Valid values: `standard`: Standard Edition. `enterprise`: Enterprise Edition. `ultimate`: Ultimate… |
| OPAScopeInjected | string | no | Specifies whether to enable OPA injection scope control. Valid values: `true`: enables OPA injection scope control. `false`: disables OPA… |
| OPAInjectorCPURequirement | string | no | The minimum number of CPU cores that are requested by the pod responsible for OPA proxy injection. For example, `1000m` indicates one CPU… |
| OPAInjectorMemoryRequirement | string | no | The minimum memory that is requested by the pod responsible for OPA proxy injection. For example, `50Mi` indicates 50 MB |
| OPAInjectorCPULimit | string | no | The maximum number of CPU cores that are allowed for the pod responsible for OPA proxy injection. For example, `1000m` indicates one CPU… |
| OPAInjectorMemoryLimit | string | no | The maximum memory that is allowed for the pod responsible for OPA proxy injection. For example, `1024Mi` indicates 1024 MB |
| IntegrateKiali | string | no | Specifies whether to create a Classic Load Balancer (CLB) instance for accessing the ASM mesh topology |
| NFDEnabled | string | no | Specifies whether to enable automatic node feature discovery |
| NFDLabelPruned | string | no | Specifies whether to remove the feature labels from nodes when you disable automatic node feature discovery. This parameter is required… |
| TracingOnExtZipkinRequestCPU | string | no | The minimum number of CPU cores that are requested by the proxy service for exporting Tracing Analysis data. For example, `1000m`… |
| TracingOnExtZipkinRequestMemory | string | no | The minimum memory that is requested by the proxy service for exporting Tracing Analysis data. For example, `1Mi` indicates 1 MB |
| TracingOnExtZipkinLimitCPU | string | no | The maximum number of CPU cores that are allowed for the proxy service for exporting Tracing Analysis data. For example, `1000m` indicates… |
| TracingOnExtZipkinLimitMemory | string | no | The maximum memory that is allowed for the proxy service for exporting Tracing Analysis data. For example, `1Mi` indicates 1 MB |
| TracingOnExtZipkinReplicaCount | string | no | The number of replicas for the proxy service that exports Tracing Analysis data |
| AccessLogGatewayLifecycle | integer | no | The retention period of the access logs of the ingress gateway that are collected in SLS. Unit: days. For example, `30` indicates 30 days |
| AccessLogSidecarLifecycle | integer | no | The retention period of the access logs of the sidecar proxy that are collected in SLS. Unit: days. For example, `30` indicates 30 days |
| EnableAutoDiagnosis | string | no | Specifies whether to enable automatic diagnostics for the service mesh. If you enable this feature, the service mesh is automatically… |
| IncludeOutboundPorts | string | no | The outbound ports for which traffic is redirected to the sidecar proxy |
| LogLevel | string | no | The log level of the sidecar proxy on the data plane. The log levels are sorted in ascending order of the log verbosity: `none`, `error`,… |
| Concurrency | integer | no | The degree of parallelism for the sidecar proxy on the data plane |
| HoldApplicationUntilProxyStarts | string | no | Specifies whether to wait for the sidecar proxy container to start before the application container starts when a pod is being started |
| ProxyStatsMatcher | string | no | The additional metrics that are reported by the sidecar proxy on the data plane |
| InterceptionMode | string | no | The mode of inbound traffic interception by the sidecar proxy. Valid values: `REDIRECT`: the default interception mode. The sidecar proxy… |
| EnableBootstrapXdsAgent | string | no | Specifies whether to load the bootstrap configurations before the sidecar proxy starts |
| KialiArmsAuthTokens | string | no | If you enable the mesh topology feature and use ARMS Prometheus to collect metrics, and the ARMS Prometheus instance has a token-based… |
| DefaultComponentsScheduleConfig | string | no | The default scheduling configurations that ASM delivers to the data plane components. You can configure `nodeSelector` and `tolerations`… |
| KialiServiceAnnotations | string | no | If you enable the mesh topology feature and create a CLB instance to access the mesh topology, you can use this parameter to configure the… |
| AccessLogGatewayEnabled | string | no | Specifies whether to collect the access logs of the ASM gateway to Simple Log Service |
| AccessLogSidecarEnabled | string | no | Specifies whether to collect the access logs of the sidecar proxy to Simple Log Service |
| LabelsForOffloadedWorkloads | string | no | The labels of the workloads that are offloaded |
| ExistingRootCaCert | string | no | The new root certificate. You can modify this parameter only if you used a custom certificate when you created the service mesh |
| ExistingCaCert | string | no | The new CA certificate. You can modify this parameter only if you used a custom certificate when you created the service mesh |
| ExistingCaKey | string | no | The new CA key. You can modify this parameter only if you used a custom certificate when you created the service mesh |
| CertChain | string | no | The certificate chain from the CA certificate to the root certificate. The certificate chain must contain at least two certificates |
| SMCEnabled | string | no | Specifies whether to install SMC acceleration |
| PilotEnableQuicListeners | string | no | Specifies whether to enable HTTP/3 support |

### Updates the network partition configuration for multiple Kubernetes clusters in a service mesh
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-mesh-multi-cluster-network` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| MultiClusterNetworks | string | no | A map that contains the network partition configurations for multiple Kubernetes clusters. The key is the cluster ID and the value is the… |

### You can call the UpdateNamespaceScopeSidecarConfig operation to update the sidecar configurations for a…
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-namespace-scope-sidecar-config` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ASM instance ID |
| Namespace | string | no | The namespace |
| IncludeIPRanges | string | no | The IP address ranges for outbound traffic that is intercepted by the sidecar proxy. This corresponds to the… |
| ExcludeIPRanges | string | no | The IP address ranges for outbound traffic that is not intercepted by the sidecar proxy. This corresponds to the… |
| IncludeInboundPorts | string | no | The inbound ports for which traffic is intercepted by the sidecar proxy |
| ExcludeOutboundPorts | string | no | The outbound ports for which traffic is not intercepted by the sidecar proxy |
| ExcludeInboundPorts | string | no | The inbound ports for which traffic is not intercepted by the sidecar proxy |
| IncludeOutboundPorts | string | no | The outbound ports for which traffic is intercepted by the sidecar proxy |
| TerminationDrainDuration | string | no | The duration for which the sidecar proxy waits for active connections to terminate |
| ProxyInitCPUResourceLimit | string | no | The CPU limit for the sidecar proxy init container |
| ProxyInitMemoryResourceLimit | string | no | The memory limit for the sidecar proxy init container |
| ProxyInitCPUResourceRequest | string | no | The CPU resource request for the sidecar proxy init container |
| ProxyInitMemoryResourceRequest | string | no | The memory resource request for the sidecar proxy init container |
| SidecarProxyCPUResourceLimit | string | no | The CPU limit for the sidecar proxy container |
| SidecarProxyMemoryResourceLimit | string | no | The memory limit for the sidecar proxy container |
| SidecarProxyCPUResourceRequest | string | no | The CPU resource request for the sidecar proxy container |
| SidecarProxyMemoryResourceRequest | string | no | The memory resource request for the sidecar proxy container |
| Lifecycle | string | no | The lifecycle of the sidecar proxy |
| IstioDNSProxyEnabled | string | no | Specifies whether to enable the DNS proxy feature. Valid values: `true`: enables the DNS proxy feature. `false`: disables the DNS proxy… |
| PostStart | string | no | The parameters that are executed after the istio-proxy container starts |
| PreStop | string | no | The parameters that are executed before the istio-proxy container stops |
| Concurrency | integer | no | The number of concurrent threads for the istio-proxy |
| ProxyStatsMatcher | string | no | The metrics that are used for Envoy monitoring and statistics. The value is in the JSON format |
| HoldApplicationUntilProxyStarts | string | no | Specifies whether to wait for the istio-proxy container to start before the application starts. Valid values: `true`: waits for the… |
| LogLevel | string | no | The log level. Valid values: `info`, `debug`, `tracing`, and `error` |
| Tracing | string | no | The custom configurations for Tracing Analysis. The configurations must be serialized into a JSON string. The Tracing Analysis… |
| InterceptionMode | string | no | The policy used by the sidecar proxy to intercept inbound traffic. Valid values: `REDIRECT`: The default policy. The sidecar proxy… |
| ProxyMetadata | string | no | The environment variables that are added to the sidecar proxy. The value is a JSON object. The keys and values in the JSON object… |
| ProxyInitAckSloCPUResourceLimit | string | no | The CPU limit for the sidecar proxy init container, which is specified in the ACK dynamic overcommitment resource format. This parameter… |
| ProxyInitAckSloMemoryResourceLimit | string | no | The memory limit for the sidecar proxy init container, which is specified in the ACK dynamic overcommitment resource format. This… |
| ProxyInitAckSloCPUResourceRequest | string | no | The CPU resource request for the sidecar proxy init container, which is specified in the ACK dynamic overcommitment resource format. This… |
| ProxyInitAckSloMemoryResourceRequest | string | no | The memory resource request for the sidecar proxy init container, which is specified in the ACK dynamic overcommitment resource format.… |
| SidecarProxyAckSloCPUResourceLimit | string | no | The CPU limit for the sidecar proxy container, which is specified in the ACK dynamic overcommitment resource format. This parameter is… |
| SidecarProxyAckSloMemoryResourceLimit | string | no | The memory limit for the sidecar proxy container, which is specified in the ACK dynamic overcommitment resource format. This parameter is… |
| SidecarProxyAckSloCPUResourceRequest | string | no | The CPU resource request for the sidecar proxy container, which is specified in the ACK dynamic overcommitment resource format. This… |
| SidecarProxyAckSloMemoryResourceRequest | string | no | The memory resource request for the sidecar proxy container, which is specified in the ACK dynamic overcommitment resource format. This… |
| Privileged | string | no | Specifies whether to enable the privileged mode for the sidecar proxy container in the security context. Valid values: `true`: The sidecar… |
| EnableCoreDump | string | no | Specifies whether to enable core dump for the sidecar proxy container. A core dump file is generated when a program crashes. Valid values:… |
| ReadinessInitialDelaySeconds | integer | no | The amount of time to wait before the readiness probe is initiated for the sidecar proxy container. Unit: seconds |
| ReadinessPeriodSeconds | integer | no | The interval at which the readiness probe is performed for the sidecar proxy container. Unit: seconds |
| ReadinessFailureThreshold | integer | no | The failure threshold for the readiness probe of the sidecar proxy container |
| SMCEnabled | string | no | Specifies whether to enable Shared Memory Communications over Remote Direct Memory Access (SMC-R) optimization. SMC-R optimization… |
| RuntimeValues | string | no | The runtime parameters for Envoy in the sidecar proxy. The value is a JSON-serialized string. The keys in the object are the Envoy runtime… |
| ScaledSidecarResource | string | no | The ScaledSidecarResource (JSON-encoded) |

### Updates the information for a specified swim lane
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-swim-lane` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The Service Mesh instance ID |
| ServicesList | string | no | A list of services to associate with the swim lane |
| SwimLaneName | string | no | The name of the swim lane |
| LabelSelectorKey | string | no | The value is fixed to `ASM_TRAFFIC_TAG` |
| LabelSelectorValue | string | no | The value of the `ASM_TRAFFIC_TAG` label |
| GroupName | string | no | The name of the swim lane group |

### Updates a swim lane group
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-swim-lane-group` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| ServicesList | string | no | The list of services associated with the swim lane group |
| GroupName | string | no | The name of the swim lane group |
| FallbackTarget | string | no | The name of the baseline swim lane for the group. This parameter is used only if the group operates in loose mode |
| IngressRoutingStrategy | string | no | The policy for routing requests to the swim lanes in the group. Valid values: `weighted`: Specifies a weight-based routing policy.… |
| WeightedIngressRule | string | no | The routing rule for the entire swim lane group. This parameter is used when the group's routing policy is `weighted` |
| ServiceLevelFallbackTarget | string | no | This parameter is not in use |

### Updates a specified waypoint
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/update-waypoint` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the Service Mesh instance |
| ClusterId | string | yes | The ID of the data plane cluster |
| Namespace | string | yes | The namespace |
| Name | string | yes | The name of the Waypoint |
| RequestCPU | string | no | The CPU resources requested by the Waypoint pod |
| RequestMemory | string | no | The memory resources requested by the Waypoint pod |
| LimitCPU | string | no | The CPU resource limit for the Waypoint pod |
| LimitMemory | string | no | The memory resource limit for the Waypoint pod |
| Replicas | integer | no | The number of replicas for the Waypoint pod |
| HPAEnabled | string | no | Specifies whether to enable Horizontal Pod Autoscaling (HPA) |
| HPATargetCPU | integer | no | The target CPU utilization for HPA |
| HPATargetMemory | integer | no | The target memory usage for HPA |
| HPAMinReplicas | integer | no | The minimum number of replicas for HPA |
| HPAMaxReplicas | integer | no | The maximum number of replicas for HPA |
| PreferECI | string | no | Specifies whether to preferentially schedule pods to Elastic Container Instance (ECI) nodes |

### Upgrade an ASM instance or switch it to the Professional Edition
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/upgrade-mesh-edition-partially` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| SwitchToPro | string | no | Specifies whether to switch the instance to the Professional Edition. Valid values: `true`: Switches the instance to the Professional… |
| ASMGatewayContinue | string | no | Specifies whether to continue upgrading the ASM gateway. Valid values: `true`: Upgrades the ASM gateway. `false`: Does not upgrade the ASM… |
| UpgradeGatewayRecords | string | no | The list of ASM gateways to upgrade. Separate multiple gateway names with commas |
| ExpectedVersion | string | no | The version to which you want to upgrade the instance. If you set this parameter, the backend checks if the target version matches this… |
| PreCheck | string | no | Specifies whether to perform only a precheck. If set to true, the system performs a precheck but does not start the upgrade |

### Upgrades a Service Mesh instance
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/upgrade-mesh-version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |
| ServiceMeshId | string | yes | The ID of the ASM instance |
| PreCheck | string | no | Specifies whether to perform a precheck. The default value is false. If this parameter is set to true, this operation checks whether the… |

### version
`POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/version` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | no | Regional endpoint, for example https://servicemesh.aliyuncs.com |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/add-cluster-into-service-mesh" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Alibaba Cloud Service Mesh API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:aliyun-servicemesh/add-cluster-into-service-mesh with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Alibaba Cloud Service Mesh API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Alibaba Cloud Service Mesh itself also needs your own key from aliyuncs.com.

### Can AI agents use the Alibaba Cloud Service Mesh API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:aliyun-servicemesh.

### What is the status of the Alibaba Cloud Service Mesh API?
Needs your own provider key (bring your own key)