This product(
servicemesh/2020-01-11) OpenAPI adopts RPC Signature style. See signature details in Description of the signature mechanism. We have packaged SDKs for common programming languages for developers. Developers can directly call the OpenAPI of this product by downloading the SDK without paying attention to the technical details. If the existing SDK cannot meet the usage requirements, you can connect through the signature mechanism. It will take about 5 working days. Therefore, it is recommended to join our DingTalk service group (11370001915) and sign under the guidance of experts. Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (SDK, CLI, etc.). For details see getAccessKey.
Service information
| API | Title | Description |
|---|---|---|
| DescribeMetadata | DescribeMetadata | Lists basic information about Alibaba Cloud Service Mesh (ASM). |
ASM instance
| API | Title | Description |
|---|---|---|
| CreateServiceMesh | CreateServiceMesh | Creates an Alibaba Cloud Service Mesh (ASM) instance. |
| DeleteServiceMesh | DeleteServiceMesh | Deletes an Alibaba Cloud Service Mesh (ASM) instance. |
| ModifyServiceMeshName | ModifyServiceMeshName | Modifies the name of an Alibaba Cloud Service Mesh (ASM) instance. |
| UpdateMeshFeature | UpdateMeshFeature | Updates the configuration of an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeServiceMeshes | DescribeServiceMeshes | Queries the information about Alibaba Cloud Service Mesh (ASM) instances. |
| DescribeServiceMeshDetail | DescribeServiceMeshDetail | Queries the details of an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeServiceMeshKubeconfig | DescribeServiceMeshKubeconfig | Queries the content of the kubeconfig file of an Alibaba Cloud Service Mesh (ASM) instance. |
| RevokeKubeconfig | RevokeKubeconfig | Revokes a kubeconfig file of an Alibaba Cloud Service Mesh (ASM) instance and generates a new kubeconfig file. |
| DescribeServiceMeshAdditionalStatus | DescribeServiceMeshAdditionalStatus | Queries the check results of an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeVersions | DescribeVersions | Queries available Alibaba Cloud Service Mesh (ASM) versions when you create an ASM instance. |
Mesh management
| API | Title | Description |
|---|---|---|
| DescribeNodesInstanceType | DescribeNodesInstanceType | Queries the instance types of nodes on the data plane and whether the instance types support Multi-Buffer acceleration. |
| DescribeCCMVersion | DescribeCCMVersion | Queries the versions of the Cloud Controller Manager (CCM) component. |
| ReActivateAudit | ReActivateAudit | Recreates a project that is used to store audit logs. |
| GetCaCert | GetCaCert | Obtains a certificate issued by a certificate authority (CA). |
Permission management
| API | Title | Description |
|---|---|---|
| GrantUserPermissions | GrantUserPermissions | Modifies role-based access control (RBAC) permissions. |
| DescribeUserPermissions | DescribeUserPermissions | Obtains role-based access control (RBAC) permissions. |
| DescribeUsersWithPermissions | DescribeUsersWithPermissions | Queries the IDs of all RAM users or RAM roles to which a Role-based Access Control (RBAC) role is assigned. |
Mesh resources
| API | Title | Description |
|---|---|---|
| UpdateMeshCRAggregation | UpdateMeshCRAggregation | Specifies whether to enable the Kubernetes API on the data plane to access Istio resources. |
| DescribeVSwitches | DescribeVSwitches | Queries a list of vSwitches that are deployed in a specified virtual private cloud (VPC) in a region. |
| DescribeVpcs | DescribeVpcs | Queries the virtual private clouds (VPCs) that are available in a specified region. |
| DescribeCens | DescribeCens | Queries the Kubernetes clusters that are deployed in different virtual private clouds (VPCs) and are not connected by using a Cloud Enterprise Network (CEN) instance among all the Kubernetes clusters that are added to an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeCrTemplates | DescribeCrTemplates | Queries the common YAML templates for a specified type of Istio resource in Alibaba Cloud Service Mesh (ASM). |
| DescribeEipResources | DescribeEipResources | Queries elastic IP addresses (EIPs). |
| ModifyApiServerEipResource | ModifyApiServerEipResource | Disassociates an elastic IP address (EIP) from an API server or associates an EIP with an API server. |
Sidecar management
| API | Title | Description |
|---|---|---|
| DescribeServiceMeshProxyStatus | DescribeServiceMeshProxyStatus | Queries the status of proxies on the data plane of an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeNamespaceScopeSidecarConfig | DescribeNamespaceScopeSidecarConfig | Queries the configurations of sidecar proxies at the namespace level. |
| UpdateNamespaceScopeSidecarConfig | UpdateNamespaceScopeSidecarConfig | Updates the sidecar proxy configurations of a namespace. |
| UpdateIstioInjectionConfig | UpdateIstioInjectionConfig | Modifies the sidecar injection setting of an Alibaba Cloud Service Mesh (ASM) instance. |
Cluster
| API | Title | Description |
|---|---|---|
| DescribeServiceMeshClusters | DescribeServiceMeshClusters | Queries the clusters that can be added to an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeClustersInServiceMesh | DescribeClustersInServiceMesh | Queries the information about clusters in an Alibaba Cloud Service Mesh (ASM) instance. |
| AddClusterIntoServiceMesh | AddClusterIntoServiceMesh | Adds a cluster to an Alibaba Cloud Service Mesh (ASM) instance. |
| RemoveClusterFromServiceMesh | RemoveClusterFromServiceMesh | Removes a cluster from an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeGuestClusterPods | DescribeGuestClusterPods | Queries the pods in a specified namespace of a Kubernetes cluster that is added to an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeGuestClusterNamespaces | DescribeGuestClusterNamespaces | Queries the namespaces of a Kubernetes cluster that is added to an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeReusableSlb | DescribeReusableSlb | Queries the Server Load Balancer (SLB) instances that can be reused. |
| GetRegisteredServiceEndpoints | GetRegisteredServiceEndpoints | Queries the endpoints of a registered service in an Alibaba Cloud Service Mesh (ASM) instance. |
| GetRegisteredServiceNamespaces | GetRegisteredServiceNamespaces | Queries the namespaces of a registered service in an Alibaba Cloud Service Mesh (ASM) instance. |
| UpdateASMNamespaceFromGuestCluster | UpdateASMNamespaceFromGuestCluster |
ASM Gateway
| API | Title | Description |
|---|---|---|
| CreateASMGateway | CreateASMGateway | Creates an Alibaba Cloud Service Mesh (ASM) gateway. |
| CreateIstioGatewayRoutes | CreateIstioGatewayRoutes | Creates a routing rule for an Alibaba Cloud Service Mesh (ASM) gateway. |
| CreateGatewaySecret | CreateGatewaySecret | Creates a secret for an Alibaba Cloud Service Mesh (ASM) gateway. |
| CreateIstioGatewayDomains | CreateIstioGatewayDomains | Adds one or more domain names for an Alibaba Cloud Service Mesh (ASM) gateway. |
| DeleteGatewayRoute | DeleteGatewayRoute | Deletes a routing rule for an Alibaba Cloud Service Mesh (ASM) gateway. |
| DeleteGatewaySecret | DeleteGatewaySecret | Deletes a secret for an Alibaba Cloud Service Mesh (ASM) gateway. |
| DeleteIstioGatewayDomains | DeleteIstioGatewayDomains | Deletes one or more domain names for an Alibaba Cloud Service Mesh (ASM) gateway. |
| UpdateASMGateway | UpdateASMGateway | Updates an Alibaba Cloud Service Mesh (ASM) gateway. |
| UpdateASMGatewayImportedServices | UpdateASMGatewayImportedServices | Updates imported services on an Alibaba Cloud Service Mesh (ASM) gateway to import or delete upstream services associated with the gateway. |
| UpdateIstioGatewayRoutes | UpdateIstioGatewayRoutes | Updates a routing rule for an Alibaba Cloud Service Mesh (ASM) gateway. |
| UpdateIstioRouteAdditionalStatus | UpdateIstioRouteAdditionalStatus | Updates the information about a routing rule for an Alibaba Cloud Service Mesh (ASM) gateway. |
| DescribeImportedServicesDetail | DescribeImportedServicesDetail | Queries the details of the imported services on an Alibaba Cloud Service Mesh (ASM) gateway. |
| DescribeASMGatewayImportedServices | DescribeASMGatewayImportedServices | Queries imported services on an Alibaba Cloud Service Mesh (ASM) gateway. |
| DescribeIstioGatewayRouteDetail | DescribeIstioGatewayRouteDetail | Queries the detailed information about a routing rule of an Alibaba Cloud Service Mesh (ASM) gateway. |
| DescribeGatewaySecretDetails | DescribeGatewaySecretDetails | Queries the detailed information about a secret of an Alibaba Cloud Service Mesh (ASM) gateway. |
| DescribeIstioGatewayDomains | DescribeIstioGatewayDomains | Queries the domain names that are exposed by an Alibaba Cloud Service Mesh (ASM) gateway. |
| DescribeIstioGatewayRoutes | DescribeIstioGatewayRoutes | Queries the routing rules of an Alibaba Cloud Service Mesh (ASM) gateway. |
Observability
| API | Title | Description |
|---|---|---|
| DescribeClusterGrafana | DescribeClusterGrafana | Queries the information of Grafana dashboards of a cluster in an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeClusterPrometheus | DescribeClusterPrometheus | Queries the public endpoint of the Prometheus service that is used to monitor a cluster in an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeServiceMeshLogs | DescribeServiceMeshLogs | Queries the logs of an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeGuestClusterAccessLogDashboards | DescribeGuestClusterAccessLogDashboards | Queries the access log reports of a cluster on the data plane. |
| GetGrafanaDashboardUrl | GetGrafanaDashboardUrl | Queries the Grafana dashboard URL from ARMS. |
Update
| API | Title | Description |
|---|---|---|
| UpgradeMeshVersion | UpgradeMeshVersion | Updates the version of an Alibaba Cloud Service Mesh (ASM) instance. |
| UpgradeMeshEditionPartially | UpgradeMeshEditionPartially | Upgrades an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeUpgradeVersion | DescribeUpgradeVersion | Queries the update status of an Alibaba Cloud Service Mesh (ASM) instance. |
| DescribeServiceMeshUpgradeStatus | DescribeServiceMeshUpgradeStatus | Queries the upgrade details of an Alibaba Cloud Service Mesh (ASM) instance and its ingress gateways. |
End-to-end canary release
| API | Title | Description |
|---|---|---|
| CreateSwimLane | CreateSwimLane | Creates a lane. |
| CreateSwimLaneGroup | CreateSwimLaneGroup | Creates a lane group. |
| DeleteSwimLane | DeleteSwimLane | Deletes a lane. |
| DeleteSwimLaneGroup | DeleteSwimLaneGroup | Deletes a lane group. If a lane group is deleted, the lanes in the group and the traffic routing rules attached to the lanes are deleted. |
| GetSwimLaneDetail | GetSwimLaneDetail | Queries detailed information about a lane. |
| GetSwimLaneGroupList | GetSwimLaneGroupList | Queries a list of all lane groups in an Alibaba Cloud Service Mesh (ASM) instance. |
| GetSwimLaneList | GetSwimLaneList | Queries a list of all the lanes in a lane group. |
| UpdateSwimLane | UpdateSwimLane | Updates the information of a lane. |
| UpdateSwimLaneGroup | UpdateSwimLaneGroup | Updates the information of a lane group. |
Others
| API | Title | Description |
|---|---|---|
| GetDeploymentBySelector | GetDeploymentBySelector | Queries a list of workloads specified by a label selector. |