API overview-阿里云帮助中心

Docs ICP Filing Console

This topic lists the public APIs for this product. The APIs are categorized by feature and include descriptions and links to their API reference topics.

Mesh instances

API	Description
Create a Service Mesh instance	Creates a Service Mesh instance.
DeleteServiceMesh	Deletes a Service Mesh instance.
ModifyServiceMeshName	Modifies the name of a Service Mesh instance.
UpdateMeshFeature	Updates the feature configurations of a Service Mesh instance.
DescribeServiceMeshes	Queries a list of Service Mesh instances.
DescribeServiceMeshDetail	Queries the details of a Service Mesh instance.
DescribeServiceMeshKubeconfig	Queries the kubeconfig file that is used to connect to a Service Mesh instance.
RevokeKubeconfig	Revokes the kubeconfig file of an ASM instance and generates a new one.
DescribeServiceMeshAdditionalStatus	Queries the additional check information of an ASM instance.
DescribeVersions	Queries the ASM versions that are available when you create a service mesh.

Mesh management

API	Description
DescribeNodesInstanceType	Queries the type of data plane nodes to check whether the multibuffer performance acceleration feature is supported.
DescribeCCMVersion	Queries the version of the CCM component.
ReActivateAudit	Recreates mesh audit logs.
RunDiagnosis	Runs a mesh diagnosis.
GetCaCert	Obtains the CA certificate.

Permission management

API	Description
GrantUserPermissions	Modifies RBAC permissions.
DescribeUserPermissions	RBAC permissions are required.
DescribeUsersWithPermissions	Lists the IDs of all Resource Access Management (RAM) users or RAM roles that have RBAC permissions.

Mesh resources

API	Description
UpdateMeshCRAggregation	Updates the status of the feature that allows the KubeAPI of the data plane to access Istio resources.
DescribeVSwitches	Queries a list of virtual switches in a specified region and VPC.
DescribeVpcs	Queries the VPCs that are available in a specified region.
DescribeCens	For Kubernetes clusters that are added to a Service Mesh instance, queries the clusters that are in different VPCs and are not connected through Cloud Enterprise Network (CEN).
DescribeCrTemplates	Returns the YAML templates of Istio resources that are used in common scenarios of Service Mesh.
DescribeEipResources	Queries a list of EIP resources.
ModifyApiServerEipResource	Detaches or attaches an EIP for the API server.

Sidecar management

API	Description
DescribeServiceMeshProxyStatus	Queries the status of Istio proxies.
DescribeNamespaceScopeSidecarConfig	Queries the namespace-scoped Sidecar configurations.
UpdateNamespaceScopeSidecarConfig	Configures the namespace-scoped Sidecar configurations.

Clusters

API	Description
AddClusterIntoServiceMesh	Adds a cluster to a Service Mesh instance.
RemoveClusterFromServiceMesh	Removes a cluster from a Service Mesh instance.
DescribeClustersInServiceMesh	Queries a list of clusters in which a Service Mesh instance is deployed.
DescribeServiceMeshClusters	Queries the clusters that are available for a Service Mesh instance.
DescribeGuestClusterPods	Queries the pods in a specified namespace of a specified Kubernetes cluster.
DescribeGuestClusterNamespaces	Lists the namespaces in a Kubernetes cluster.
DescribeReusableSlb	Queries the SLB instances that can be reused.
GetRegisteredServiceEndpoints	Queries the information about registered service endpoints.
GetRegisteredServiceNamespaces	Queries the list of namespaces for registered services.

ASM gateways

API	Description
CreateASMGateway	Creates an ASM gateway.
CreateIstioGatewayRoutes	Creates routes for an ASM gateway.
CreateGatewaySecret	Creates a key for an ASM gateway.
CreateIstioGatewayDomains	Creates a domain name certificate for an ASM gateway.
DeleteGatewayRoute	Deletes the routes of an ASM gateway.
DeleteGatewaySecret	Deletes the key of an ASM gateway.
DeleteIstioGatewayDomains	Deletes the domain names of an ASM gateway.
UpdateASMGateway	Modifies an ASM gateway.
UpdateASMGatewayImportedServices	Updates the services imported by an ASM gateway by importing or deleting associated upstream services.
UpdateIstioGatewayRoutes	Updates the routes of an ASM gateway.
UpdateIstioRouteAdditionalStatus	Updates the additional information about the routes of an ASM gateway.
DescribeIngressGateways	Queries the information about ASM gateways.
DescribeImportedServicesDetail	Queries the details of the services that are imported by an ASM gateway.
DescribeASMGatewayImportedServices	Queries the information about the services that are imported by an ASM gateway.
DescribeIstioGatewayRouteDetail	Queries the details of the routes of an ASM gateway.
DescribeGatewaySecretDetails	Queries the details of the certificate key of an ASM gateway.
DescribeIstioGatewayDomains	Queries a list of domain names for an ASM gateway.
DescribeIstioGatewayRoutes	Queries a list of routes for an ASM gateway.

Observability

API	Description
DescribeClusterGrafana	Queries the information about the Grafana dashboards for a cluster in a Service Mesh instance.
DescribeClusterPrometheus	Queries the public endpoint of Prometheus for a cluster in a Service Mesh instance.
DescribeServiceMeshLogs	Queries mesh logs.
DescribeGuestClusterAccessLogDashboards	Queries the access log reports for a data plane cluster.

Upgrade

API	Description
UpgradeMeshVersion	Upgrades the version of a Service Mesh instance.
UpgradeMeshEditionPartially	Upgrades an ASM instance or switches an ASM instance to the Professional Edition.
DescribeUpgradeVersion	Queries the versions to which a Service Mesh instance can be upgraded.
DescribeServiceMeshUpgradeStatus	Queries the upgrade status of an ASM instance and its ASM gateways.

Is this page helpful?