All Products
Search
Document Center

Alibaba Cloud Service Mesh:List of operations by function

Last Updated:Mar 29, 2024
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

APITitleDescription
DescribeMetadataDescribeMetadataQueries basic information about a Service Mesh (ASM) instance.

ASM instance

APITitleDescription
CreateServiceMeshCreateServiceMeshCreates a Service Mesh (ASM) instance.
DeleteServiceMeshDeleteServiceMeshDeletes a Service Mesh (ASM) instance.
ModifyServiceMeshNameModifyServiceMeshNameModifies the name of a Service Mesh (ASM) instance.
UpdateMeshFeatureUpdateMeshFeatureUpdates the configuration of a Service Mesh (ASM) instance.
RevokeKubeconfigRevokeKubeconfigRevokes the kubeconfig file of a Service Mesh (ASM) instance and generates a new kubeconfig file.
DescribeServiceMeshesDescribeServiceMeshesQueries a list of Service Mesh (ASM) instances.
DescribeServiceMeshDetailDescribeServiceMeshDetailQueries the details of a Service Mesh (ASM) instance.
DescribeServiceMeshKubeconfigDescribeServiceMeshKubeconfigQueries the content of the kubeconfig file of a Service Mesh (ASM) instance.
DescribeServiceMeshAdditionalStatusDescribeServiceMeshAdditionalStatusQueries the check results of a Service Mesh (ASM) instance.
DescribeVersionsDescribeVersionsQueries available Service Mesh (ASM) versions when you create an ASM instance.

Mesh management

APITitleDescription
ReActivateAuditReActivateAuditRecreates a project that is used to store audit logs. After mesh audit is enabled, if you delete the log project that stores audit logs by mistake, you can recreate a project for storing audit logs.
DescribeNodesInstanceTypeDescribeNodesInstanceTypeQueries the instance types of nodes on the data plane and whether the instance types support Multi-Buffer acceleration.
DescribeCCMVersionDescribeCCMVersionQueries the versions of the Cloud Controller Manager (CCM) component.
GetCaCertGetCaCertObtains a certificate issued by a certificate authority (CA).

Permission management

APITitleDescription
GrantUserPermissionsGrantUserPermissionsGrants permissions to a Resource Access Management (RAM) user.
DescribeUserPermissionsDescribeUserPermissionsObtains role-based access control (RBAC) permissions.
DescribeUsersWithPermissionsDescribeUsersWithPermissionsQueries the IDs of all RAM users or RAM roles to which a Role-based Access Control (RBAC) role is assigned.

Mesh resources

APITitleDescription
UpdateMeshCRAggregationUpdateMeshCRAggregationUpdates the settings of whether to enable the Kubernetes API on the data plane to access Istio resources.
ModifyApiServerEipResourceModifyApiServerEipResourceDisassociates an elastic IP address (EIP) from an API server or associates an EIP with an API server.
DescribeVSwitchesDescribeVSwitchesQueries a list of vSwitches that are deployed in a specified virtual private cloud (VPC) in a region.
DescribeVpcsDescribeVpcsQueries the virtual private clouds (VPCs) that are available in a specified region.
DescribeCensDescribeCensQueries the network connectivity between clusters that are deployed across virtual private clouds (VPCs) in a Service Mesh (ASM) instance.
DescribeCrTemplatesDescribeCrTemplatesQueries the common YAML templates of Istio resources used by Service Mesh (ASM) instances.
DescribeEipResourcesDescribeEipResourcesQueries elastic IP addresses (EIPs).

Dataplane component management

APITitleDescription
UpdateNamespaceScopeSidecarConfigUpdateNamespaceScopeSidecarConfigUpdates the configurations of sidecar proxies at the namespace level.
UpdateIstioInjectionConfigUpdateIstioInjectionConfigModifies the sidecar proxy injection settings of a Service Mesh (ASM) instance.
DescribeServiceMeshProxyStatusDescribeServiceMeshProxyStatusQueries the status of proxies on the data plane of a Service Mesh (ASM) instance.
DescribeNamespaceScopeSidecarConfigDescribeNamespaceScopeSidecarConfigQueries the configurations of sidecar proxies at the namespace level.

Cluster

APITitleDescription
AddClusterIntoServiceMeshAddClusterIntoServiceMeshAdds a cluster to a Service Mesh (ASM) instance.
RemoveClusterFromServiceMeshRemoveClusterFromServiceMeshRemoves a cluster from a Service Mesh (ASM) instance.
UpdateASMNamespaceFromGuestClusterUpdateASMNamespaceFromGuestClusterSynchronizes namespaces of a Kubernetes cluster that is added to a Service Mesh (ASM) instance.
DescribeServiceMeshClustersDescribeServiceMeshClustersQueries the clusters that can be added to a Service Mesh (ASM) instance.
DescribeClustersInServiceMeshDescribeClustersInServiceMeshQueries the information about clusters in a Service Mesh (ASM) instance.
DescribeGuestClusterPodsDescribeGuestClusterPodsQueries a list of the pods in a specified namespace of a Kubernetes cluster that is added to a Service Mesh (ASM) instance.
DescribeGuestClusterNamespacesDescribeGuestClusterNamespacesQueries a list of the namespaces of a Kubernetes cluster that is added to a Service Mesh (ASM) instance.
DescribeReusableSlbDescribeReusableSlbQueries the Server Load Balancer (SLB) instances that can be reused.
GetRegisteredServiceEndpointsGetRegisteredServiceEndpointsQueries the endpoints of a registered service in an Alibaba Cloud Service Mesh (ASM) instance.
GetRegisteredServiceNamespacesGetRegisteredServiceNamespacesQueries the namespaces of a registered service in an Alibaba Cloud Service Mesh (ASM) instance.

ASM gateway

APITitleDescription
CreateASMGatewayCreateASMGatewayCreates a Service Mesh (ASM) gateway.
CreateIstioGatewayRoutesCreateIstioGatewayRoutesCreates a routing rule for a Service Mesh (ASM) gateway.
CreateGatewaySecretCreateGatewaySecretCreates a secret for a Service Mesh (ASM) gateway.
CreateIstioGatewayDomainsCreateIstioGatewayDomainsAdds domain names for a Service Mesh (ASM) gateway.
DeleteGatewayRouteDeleteGatewayRouteDeletes a routing rule for a Service Mesh (ASM) gateway.
DeleteGatewaySecretDeleteGatewaySecretDeletes a secret for a Service Mesh (ASM) gateway.
DeleteIstioGatewayDomainsDeleteIstioGatewayDomainsDeletes one or more domain names for a Service Mesh (ASM) gateway.
UpdateASMGatewayUpdateASMGatewayUpdates a Service Mesh (ASM) gateway.
UpdateASMGatewayImportedServicesUpdateASMGatewayImportedServicesUpdates imported services on a Service Mesh (ASM) gateway to import or delete upstream services associated with the gateway.
UpdateIstioGatewayRoutesUpdateIstioGatewayRoutesUpdates a routing rule for a Service Mesh (ASM) gateway.
UpdateIstioRouteAdditionalStatusUpdateIstioRouteAdditionalStatusUpdates the information about a routing rule for a Service Mesh (ASM) gateway.
DescribeImportedServicesDetailDescribeImportedServicesDetailQueries the details of the imported services on a Service Mesh (ASM) gateway.
DescribeASMGatewayImportedServicesDescribeASMGatewayImportedServicesQueries the information about imported services on a Service Mesh (ASM) gateway.
DescribeIstioGatewayRouteDetailDescribeIstioGatewayRouteDetailQueries the detailed information about a routing rule of an Alibaba Cloud Service Mesh (ASM) gateway.
DescribeGatewaySecretDetailsDescribeGatewaySecretDetailsQueries the detailed information about a secret of a Service Mesh (ASM) gateway.
DescribeIstioGatewayDomainsDescribeIstioGatewayDomainsQueries a list of the domain names that are exposed by a Service Mesh (ASM) gateway.
DescribeIstioGatewayRoutesDescribeIstioGatewayRoutesQueries the routing rules for a Service Mesh (ASM) gateway.

Observability

APITitleDescription
DescribeClusterGrafanaDescribeClusterGrafanaQueries the information about Grafana dashboards of a cluster in a Service Mesh (ASM) instance.
DescribeClusterPrometheusDescribeClusterPrometheusQueries the public endpoint of the Prometheus service that is used to monitor a cluster in a Service Mesh (ASM) instance.
DescribeServiceMeshLogsDescribeServiceMeshLogsQueries the logs of a Service Mesh (ASM) instance.
DescribeGuestClusterAccessLogDashboardsDescribeGuestClusterAccessLogDashboardsQueries the access log dashboards of a cluster on the data plane.
GetGrafanaDashboardUrlGetGrafanaDashboardUrlQueries the Grafana dashboard URL from Application Real-Time Monitoring Service (ARMS).

Update

APITitleDescription
UpgradeMeshVersionUpgradeMeshVersionUpdates the version of a Service Mesh (ASM) instance.
UpgradeMeshEditionPartiallyUpgradeMeshEditionPartiallyUpgrades a Service Mesh (ASM) instance to Professional Edition that is commercially released.
DescribeUpgradeVersionDescribeUpgradeVersionQueries the update status of a Service Mesh (ASM) instance.
DescribeServiceMeshUpgradeStatusDescribeServiceMeshUpgradeStatusQueries the upgrade details of a Service Mesh (ASM) instance and its ingress gateways.

Traffic swimlane

APITitleDescription
CreateSwimLaneCreateSwimLaneCreates a lane.
CreateSwimLaneGroupCreateSwimLaneGroupCreates a lane group.
DeleteSwimLaneDeleteSwimLaneDeletes a lane.
DeleteSwimLaneGroupDeleteSwimLaneGroupDeletes 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.
UpdateSwimLaneUpdateSwimLaneUpdates the information about a lane.
UpdateSwimLaneGroupUpdateSwimLaneGroupUpdates the information of a lane group.
GetSwimLaneDetailGetSwimLaneDetailQueries detailed information about a lane.
GetSwimLaneGroupListGetSwimLaneGroupListQueries a list of all lane groups in an Alibaba Cloud Service Mesh (ASM) instance.
GetSwimLaneListGetSwimLaneListQueries a list of all the lanes in a lane group.

Others

APITitleDescription
GetDeploymentBySelectorGetDeploymentBySelectorQueries a list of workloads specified by a label selector.
UpdateControlPlaneLogConfigUpdateControlPlaneLogConfigModifies the configuration for collecting control plane logs.
UntagResourcesUntagResourcesDeletes user tags on a Service Mesh (ASM) instance.
ListTagResourcesListTagResourcesQueries user tags on a Service Mesh (ASM) instance.
TagResourcesTagResourcesAdds or modifies user tags on a resource.
UpdateWaypointUpdateWaypoint
CreateWaypointCreateWaypoint
DeleteWaypointDeleteWaypoint
ListWaypointsListWaypointsQueries the configurations of all waypoint proxies in a namespace of a cluster on the data plane.
ListServiceAccountsListServiceAccounts