API standards and multilingual preset SDKs
The OpenAPI of this product (servicemesh/2020-01-11) uses the RPC signature style. We have encapsulated SDKs for common programming languages for developers. Developers can download the SDK to directly call this product's OpenAPI without worrying about technical details. If the existing SDK does not meet your needs, you can use the signature mechanism for self-signing integration. Since the details of self-signing are very complex, it may take around 5 business days. Therefore, we recommend joining our DingTalk service group (147535001692) and conducting signature integration under expert guidance.
Before using the API, you need to prepare your identity account and access key (AccessKey) to effectively access the API through client tools (such as SDK and CLI). For details, see Obtain an AccessKey.
Custom signature scenarios
If your business scenario has special requirements and you need to integrate the API through self-signing, we recommend consulting our technical support team first (DingTalk service group: 147535001692) to obtain professional guidance and ensure efficient integration.
Account and security preparation
Alibaba Cloud accounts have full administrative permissions over all resources. Once an AccessKey is compromised, all associated resources will be at risk of unauthorized access. To ensure security, it is recommended to create a RAM user with only API access permissions and configure its AccessKey, while configuring RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where Alibaba Cloud account permissions are explicitly required.
Product information
|
API |
Title |
Description |
| DescribeMetadata | DescribeMetadata | Retrieves the basic information about a Service Mesh (ASM) instance. |
Mesh instances
|
API |
Title |
Description |
| CreateServiceMesh | CreateServiceMesh | Creates a Service Mesh instance. |
| DeleteServiceMesh | DeleteServiceMesh | Deletes a Service Mesh instance. |
| ModifyServiceMeshName | ModifyServiceMeshName | Changes the name of a Service Mesh instance. |
| UpdateMeshFeature | UpdateMeshFeature | Updates the features of a service mesh. |
| RevokeKubeconfig | RevokeKubeconfig | Revokes the Kubeconfig for an ASM instance and generates a new Kubeconfig. |
| DescribeServiceMeshes | DescribeServiceMeshes | Queries a list of service meshes. |
| DescribeServiceMeshDetail | DescribeServiceMeshDetail | Call DescribeServiceMeshDetail to retrieve the details of a service mesh. |
| DescribeServiceMeshKubeconfig | DescribeServiceMeshKubeconfig | Retrieves the KubeConfig configuration for a Service Mesh instance. |
| DescribeServiceMeshAdditionalStatus | DescribeServiceMeshAdditionalStatus | Call DescribeServiceMeshAdditionalStatus to query information about additional checks for an ASM instance. |
| DescribeVersions | DescribeVersions | Call DescribeVersions to retrieve the available ASM versions for creating a service mesh. |
Mesh management
|
API |
Title |
Description |
| ReActivateAudit | ReActivateAudit | Recreates a mesh audit log. If you accidentally delete the SLS project that stores audit logs after enabling mesh audit, you can call this operation to recreate an empty mesh audit log. |
| DescribeNodesInstanceType | DescribeNodesInstanceType | You can call the DescribeNodesInstanceType operation to query the types of data plane nodes and determine whether MultiBuffer performance acceleration is supported. |
| DescribeCCMVersion | DescribeCCMVersion | You can call DescribeCCMVersion to query the version of the cloud-controller-manager (CCM) component. |
| GetCaCert | GetCaCert | Obtains the CA certificate. |
Permission management
|
API |
Title |
Description |
| GrantUserPermissions | GrantUserPermissions | Updates the permissions of a RAM user. |
| DescribeUserPermissions | DescribeUserPermissions | Obtains the authorizations for a RAM user. |
| DescribeUsersWithPermissions | DescribeUsersWithPermissions | Call DescribeUsersWithPermissions to retrieve the IDs of all Resource Access Management (RAM) users or RAM roles that have Role-Based Access Control (RBAC) permissions. |
Mesh resources
|
API |
Title |
Description |
| UpdateMeshCRAggregation | UpdateMeshCRAggregation | Updates the status of the feature that allows the data plane to access Istio resources using the KubeAPI. |
| ModifyApiServerEipResource | ModifyApiServerEipResource | Attach or detach an EIP from an API server. |
| DescribeVSwitches | DescribeVSwitches | Retrieves a list of vSwitches in a specified region and VPC. |
| DescribeVpcs | DescribeVpcs | Call DescribeVpcs to retrieve available VPCs in a specified region. |
| DescribeCens | DescribeCens | DescribeCens retrieves the results of a network connectivity test for multiple clusters across different VPCs in the same service mesh. |
| DescribeCrTemplates | DescribeCrTemplates | Call the DescribeCrTemplates operation to query YAML templates for Istio resources that are used in common scenarios in a service mesh. |
| DescribeEipResources | DescribeEipResources | Queries a list of Elastic IP Address (EIP) resources. |
Data plane component management
|
API |
Title |
Description |
| UpdateNamespaceScopeSidecarConfig | UpdateNamespaceScopeSidecarConfig | You can call the UpdateNamespaceScopeSidecarConfig operation to update the sidecar configurations for a namespace. |
| UpdateIstioInjectionConfig | UpdateIstioInjectionConfig | Modifies the injection settings for a service mesh. |
| DescribeServiceMeshProxyStatus | DescribeServiceMeshProxyStatus | Queries the status of an Istio proxy. |
| DescribeNamespaceScopeSidecarConfig | DescribeNamespaceScopeSidecarConfig | Call `DescribeNamespaceScopeSidecarConfig` to query the namespace-level sidecar configuration. |
Clusters
|
API |
Title |
Description |
| AddClusterIntoServiceMesh | AddClusterIntoServiceMesh | Adds a cluster to a service mesh. |
| RemoveClusterFromServiceMesh | RemoveClusterFromServiceMesh | Deletes a cluster from a service mesh. |
| UpdateASMNamespaceFromGuestCluster | UpdateASMNamespaceFromGuestCluster | Synchronizes namespace information from a Kubernetes cluster that is added to a service mesh. |
| DescribeServiceMeshClusters | DescribeServiceMeshClusters | Queries the available clusters in a service mesh. |
| DescribeClustersInServiceMesh | DescribeClustersInServiceMesh | The `DescribeClustersInServiceMesh` operation retrieves information about one or more clusters in a service mesh. |
| DescribeGuestClusterPods | DescribeGuestClusterPods | Retrieves the pods in a specified namespace of a Kubernetes cluster. |
| DescribeGuestClusterNamespaces | DescribeGuestClusterNamespaces | Call DescribeGuestClusterNamespaces to retrieve a list of namespaces from a Kubernetes cluster that is added to a service mesh. |
| DescribeReusableSlb | DescribeReusableSlb | Retrieves reusable Classic Load Balancer (CLB) instances. |
| GetRegisteredServiceEndpoints | GetRegisteredServiceEndpoints | You can call GetRegisteredServiceEndpoints to retrieve information about registered service endpoints. |
| GetRegisteredServiceNamespaces | GetRegisteredServiceNamespaces | Call GetRegisteredServiceNamespaces to retrieve a list of namespaces for registered services. |
ASM gateways
|
API |
Title |
Description |
| CreateASMGateway | CreateASMGateway | Creates an ASM gateway. |
| CreateIstioGatewayRoutes | CreateIstioGatewayRoutes | Creates routes for an ASM gateway. |
| CreateGatewaySecret | CreateGatewaySecret | Creates a gateway secret. |
| CreateIstioGatewayDomains | CreateIstioGatewayDomains | Creates a domain name certificate for a gateway. |
| DeleteGatewayRoute | DeleteGatewayRoute | Deletes a gateway route. |
| DeleteGatewaySecret | DeleteGatewaySecret | Deletes a gateway key. |
| DeleteIstioGatewayDomains | DeleteIstioGatewayDomains | Deletes domains from an Istio gateway. |
| UpdateASMGateway | UpdateASMGateway | Updates an ASM gateway. |
| UpdateASMGatewayImportedServices | UpdateASMGatewayImportedServices | Call UpdateASMGatewayImportedServices to update the services imported into an ASM gateway. You can import or delete upstream services that are associated with the gateway. |
| UpdateIstioGatewayRoutes | UpdateIstioGatewayRoutes | The UpdateIstioGatewayRoutes operation updates a gateway route. |
| UpdateIstioRouteAdditionalStatus | UpdateIstioRouteAdditionalStatus | Updates the additional information for a route. |
| DescribeImportedServicesDetail | DescribeImportedServicesDetail | Queries the details of services imported into an ASM gateway. |
| DescribeASMGatewayImportedServices | DescribeASMGatewayImportedServices | Retrieves information about services imported into an ASM gateway. |
| DescribeIstioGatewayRouteDetail | DescribeIstioGatewayRouteDetail | Queries the details of a gateway routing rule. |
| DescribeGatewaySecretDetails | DescribeGatewaySecretDetails | Queries the details of the certificate and key for a gateway. |
| DescribeIstioGatewayDomains | DescribeIstioGatewayDomains | Returns a list of gateway domain names. |
| DescribeIstioGatewayRoutes | DescribeIstioGatewayRoutes | Queries the routes of a gateway in a Service Mesh (ASM) instance. |
Observability
|
API |
Title |
Description |
| DescribeClusterGrafana | DescribeClusterGrafana | Retrieves information about Grafana reports for a cluster in a service mesh. |
| DescribeClusterPrometheus | DescribeClusterPrometheus | You can call the DescribeClusterPrometheus operation to retrieve the public endpoint of Prometheus for a cluster in a Service Mesh instance. |
| DescribeServiceMeshLogs | DescribeServiceMeshLogs | Retrieves service mesh logs. |
| DescribeGuestClusterAccessLogDashboards | DescribeGuestClusterAccessLogDashboards | Retrieves the access log reports of a data plane cluster. |
| GetGrafanaDashboardUrl | GetGrafanaDashboardUrl | Retrieves a Grafana dashboard URL from ARMS. |
Upgrades
|
API |
Title |
Description |
| UpgradeMeshVersion | UpgradeMeshVersion | Upgrades a Service Mesh instance. |
| UpgradeMeshEditionPartially | UpgradeMeshEditionPartially | Upgrade an ASM instance or switch it to the Professional Edition. |
| DescribeUpgradeVersion | DescribeUpgradeVersion | Call DescribeUpgradeVersion to retrieve the available upgrade versions for a Service Mesh instance. |
| DescribeServiceMeshUpgradeStatus | DescribeServiceMeshUpgradeStatus | Queries the upgrade status of an ASM instance and its ASM gateways. |
Traffic lanes
|
API |
Title |
Description |
| CreateSwimLane | CreateSwimLane | Creates a swimlane. |
| CreateSwimLaneGroup | CreateSwimLaneGroup | Creates a traffic lane group. |
| DeleteSwimLane | DeleteSwimLane | Deletes a specified swim lane. |
| DeleteSwimLaneGroup | DeleteSwimLaneGroup | Deletes a specific swim lane group. This operation also deletes the swim lanes and traffic routing rules within that group. |
| UpdateSwimLane | UpdateSwimLane | Updates the information for a specified swim lane. |
| UpdateSwimLaneGroup | UpdateSwimLaneGroup | Updates a swim lane group. |
| GetSwimLaneDetail | GetSwimLaneDetail | You can call GetSwimLaneDetail to retrieve the details of a specific swimlane. |
| GetSwimLaneGroupList | GetSwimLaneGroupList | Lists all traffic lane groups in a Service Mesh (ASM) instance. |
| GetSwimLaneList | GetSwimLaneList | Call GetSwimLaneList to retrieve a list of all swimlanes in a swimlane group. |
Others
|
API |
Title |
Description |
| GetDeploymentBySelector | GetDeploymentBySelector | Retrieves a list of workloads that are specified by a selector. |
| UpdateControlPlaneLogConfig | UpdateControlPlaneLogConfig | Updates the log collection configuration for the control plane. |
| UntagResources | UntagResources | Deletes user tags from an instance. |
| ListTagResources | ListTagResources | Queries user tags for one or more instances. |
| TagResources | TagResources | Adds or modifies tags for one or more resources. |
| UpdateWaypoint | UpdateWaypoint | Updates a specified waypoint. |
| CreateWaypoint | CreateWaypoint | Creates a waypoint. |
| DeleteWaypoint | DeleteWaypoint | Deletes a Waypoint resource. |
| ListWaypoints | ListWaypoints | Retrieves all Waypoint configurations in a namespace of a data plane cluster. |
| ListServiceAccounts | ListServiceAccounts | This operation retrieves a list of all service accounts. |
| UpdateMeshMultiClusterNetwork | UpdateMeshMultiClusterNetwork | Updates the network partition configuration for multiple Kubernetes clusters in a service mesh. |
| DescribeMeshMultiClusterNetwork | DescribeMeshMultiClusterNetwork | Describes the network partition configurations for multiple Kubernetes clusters in a Service Mesh instance. |
| ModifyPilotEipResource | ModifyPilotEipResource | Modifies the elastic IP address (EIP) of a pilot instance. |
| UpdateGuestClusterConfig | UpdateGuestClusterConfig | Updates the configuration of a guest cluster. |
| DescribeVMsInServiceMesh | Get virtual machines in a service mesh | Retrieves the virtual machines that have been added to a service mesh. |
Virtual machines
|
API |
Title |
Description |