本产品中所有开放的API,按照功能目录分类,罗列了API链接和API描述。

网格实例

API 描述

CreateServiceMesh

创建一个服务网格实例。

DeleteServiceMesh

删除服务网格实例。
ModifyServiceMeshName 修改服务网格实例名称。
UpdateMeshFeature 更新服务网格的功能配置。
DescribeServiceMeshes 获取服务网格列表。

DescribeServiceMeshDetail

获取服务网格详情。

DescribeServiceMeshKubeconfig

获取连接服务网格的kubeconfig配置。
RevokeKubeconfig 吊销ASM实例的Kubeconfig,并重新生成新的Kubeconfig。
DescribeServiceMeshAdditionalStatus 查询ASM实例的附加检查信息。
DescribeVersions 获取创建网格时可用的ASM版本。

网格管理

API 描述
DescribeNodesInstanceType 查询数据面节点类型,判断是否支持multibuffer性能加速。
DescribeCCMVersion 查询CCM组件版本。
ReActivateAudit 重建新的网格审计日志。
RunDiagnosis 运行网格诊断。
GetCaCert 获取CA证书。

权限管理

API 描述
GrantUserPermissions 修改RBAC权限。
DescribeUserPermissions 获取RBAC权限。
DescribeUsersWithPermissions 列出所有具有RBAC权限的RAM用户或RAM角色ID。

网格资源

API 描述
UpdateMeshCRAggregation 更新数据面KubeAPI访问Istio资源功能的启用状态。
DescribeVSwitches 获取指定地域,指定VPC内的虚拟交换机列表。
DescribeVpcs 获取指定地域内可用的VPC。
DescribeCens 在添加到服务网格的Kubernetes集群中,获取哪些集群的VPC不同且没有通过云企业网连通网络。
DescribeCrTemplates 返回在服务网格常见使用场景下使用的Istio资源YAML模板。
DescribeEipResources 查询EIP资源列表。
ModifyApiServerEipResource 解绑或绑定API Server的EIP。

Sidecar管理

API 描述
DescribeServiceMeshProxyStatus 查询IstioProxy状态。
DescribeNamespaceScopeSidecarConfig 查询命名空间级别的Sidecar配置。
UpdateNamespaceScopeSidecarConfig 设置命名空间级别的Sidecar配置。

集群

API 描述

AddClusterIntoServiceMesh

添加一个集群到服务网格。
RemoveClusterFromServiceMesh 从服务网格中删除集群。

DescribeClustersInServiceMesh

获取服务网格所在集群的信息列表。
DescribeServiceMeshClusters 获取服务网格的可用集群。
DescribeGuestClusterPods 获取指定K8s集群指定命名空间内的Pod。
DescribeGuestClusterNamespaces 列出K8s集群内的命名空间列表。
DescribeReusableSlb 获取可复用的SLB。
GetRegisteredServiceEndpoints 获取注册服务端点信息。
GetRegisteredServiceNamespaces 获取注册服务的命名空间列表。

ASM网关

API 描述
CreateASMGateway 创建ASM网关。
CreateIstioGatewayRoutes 创建ASM网关对应的路由。
CreateGatewaySecret 创建ASM网关密钥。
CreateIstioGatewayDomains 创建ASM网关域名证书。
DeleteGatewayRoute 删除ASM网关路由。
DeleteGatewaySecret 删除ASM网关密钥。
DeleteIstioGatewayDomains 删除ASM网关域名。
UpdateASMGateway 修改ASM网关。
UpdateASMGatewayImportedServices 更新ASM网关导入的服务信息,导入或删除网关关联的上游服务。
UpdateIstioGatewayRoutes 更新ASM网关路由。
UpdateIstioRouteAdditionalStatus 更新ASM网关路由额外信息。
DescribeIngressGateways 查询ASM网关信息。
DescribeImportedServicesDetail 获取ASM网关已导入服务的详细信息。
DescribeASMGatewayImportedServices 获取ASM网关已导入的服务信息。
DescribeIstioGatewayRouteDetail 查看ASM网关路由详情。
DescribeGatewaySecretDetails 查询ASM网关证书密钥详细信息。
DescribeIstioGatewayDomains 查询ASM网关域名列表。
DescribeIstioGatewayRoutes 查询ASM网关的路由列表。

可观测性

API 描述

DescribeClusterGrafana

获取服务网格内集群的Grafana报表信息。

DescribeClusterPrometheus

获取服务网格内集群的Prometheus公网地址。
DescribeServiceMeshLogs 获取网格日志。

DescribeGuestClusterAccessLogDashboards

获取数据面集群的访问日志报表。

升级

API 描述

UpgradeMeshVersion

升级服务网格的版本。
UpgradeMeshEditionPartially 升级ASM实例或者将ASM实例切换为专业版。

DescribeUpgradeVersion

获取服务网格的可更新版本信息。
DescribeServiceMeshUpgradeStatus 询ASM实例和ASM网关的升级状态。