本产品（
服务网格/2020-01-11）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（78410016550），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
产品信息
| API | 标题 | API概述 |
|---|---|---|
| DescribeMetadata | 获取服务网格ASM的基本信息 | 获取服务网格ASM的基本信息。 |
网格实例
| API | 标题 | API概述 |
|---|---|---|
| CreateServiceMesh | 创建一个服务网格实例 | 调用CreateServiceMesh创建一个服务网格实例。 |
| DeleteServiceMesh | 删除一个服务网格实例 | 调用DeleteServiceMesh删除一个服务网格实例。 |
| ModifyServiceMeshName | 修改服务网格实例名称 | 调用ModifyServiceMeshName修改服务网格实例名称。 |
| UpdateMeshFeature | 更新服务网格的功能配置 | 调用UpdateMeshFeature更新服务网格的功能配置。 |
| RevokeKubeconfig | 重新生成Kubeconfig | 调用RevokeKubeconfig吊销ASM实例的Kubeconfig，并重新生成新的Kubeconfig。 |
| DescribeServiceMeshes | 获取服务网格列表 | 获取服务网格列表。 |
| DescribeServiceMeshDetail | 获取服务网格详情 | 调用DescribeServiceMeshDetail获取服务网格详情。 |
| DescribeServiceMeshKubeconfig | 获取KubeConfig配置 | 调用DescribeServiceMeshKubeconfig获取连接服务网格的KubeConfig配置。 |
| DescribeServiceMeshAdditionalStatus | 查询ASM实例的附加检查信息 | 调用DescribeServiceMeshAdditionalStatus查询ASM实例的附加检查信息。 |
| DescribeVersions | 获取可用的ASM版本 | 调用DescribeVersions获取创建网格时可用的ASM版本。 |
网格管理
| API | 标题 | API概述 |
|---|---|---|
| ReActivateAudit | 重建新的网格审计日志 | 调用ReActivateAudit重建新的网格审计日志。在开启网格审计后，如果误删了存储审计日志的logproject，可以重新创建一个空白的网格审计日志。 |
| DescribeNodesInstanceType | 查询数据面节点类型 | 调用DescribeNodesInstanceType查询数据面节点类型，判断是否支持MultiBuffer性能加速。 |
| DescribeCCMVersion | 查询CCM组件版本 | 调用DescribeCCMVersion查询CCM组件版本。 |
| GetCaCert | 获取CA证书 | 调用GetCaCert获取CA证书。 |
权限管理
| API | 标题 | API概述 |
|---|---|---|
| GrantUserPermissions | 更新子账号授权信息 | 调用GrantUserPermissions更新子账号授权信息。 |
| DescribeUserPermissions | 获取子账号授权信息 | 调用DescribeUserPermissions获取子账号授权信息。 |
| DescribeUsersWithPermissions | 获取RBAC权限的RAM用户 | 调用DescribeUsersWithPermissions获取所有具有RBAC权限的RAM用户或RAM角色ID。 |
网格资源
| API | 标题 | API概述 |
|---|---|---|
| UpdateMeshCRAggregation | 更新数据面KubeAPI访问Istio资源功能的启用状态 | 调用UpdateMeshCRAggregation更新数据面KubeAPI访问Istio资源功能的启用状态。 |
| ModifyApiServerEipResource | 解绑或绑定API Server的EIP | 调用ModifyApiServerEipResource解绑或绑定API Server的EIP。 |
| DescribeVSwitches | 获取指定VPC内的虚拟交换机列表 | 调用DescribeVSwitches获取指定地域，指定VPC内的虚拟交换机列表。 |
| DescribeVpcs | 获取指定地域内可用的VPC | 调用DescribeVpcs获取指定地域内可用的VPC。 |
| DescribeCens | 获取网络连通性检测结果 | 调用DescribeCens获取同一服务网格下多集群跨VPC的网络连通性检测结果。 |
| DescribeCrTemplates | 查询Istio资源YAML模板 | 调用DescribeCrTemplates查询服务网格中常见使用场景下的Istio资源YAML模板。 |
| DescribeEipResources | 查询EIP资源列表 | 调用DescribeEipResources查询EIP资源列表。 |
数据面组件管理
| API | 标题 | API概述 |
|---|---|---|
| UpdateNamespaceScopeSidecarConfig | 更新Sidecar配置 | 调用UpdateNamespaceScopeSidecarConfig更新命名空间级别的Sidecar配置。 |
| UpdateIstioInjectionConfig | 更新Sidecar注入配置 | 调用UpdateIstioInjectionConfig修改网格注入设置。 |
| DescribeServiceMeshProxyStatus | 查询IstioProxy状态 | 调用DescribeServiceMeshProxyStatus查询IstioProxy状态。 |
| DescribeNamespaceScopeSidecarConfig | 查询Sidecar配置 | 调用DescribeNamespaceScopeSidecarConfig查询命名空间级别的Sidecar配置设置。 |
集群
| API | 标题 | API概述 |
|---|---|---|
| AddClusterIntoServiceMesh | 添加一个集群到服务网格 | 添加一个集群到服务网格。 |
| RemoveClusterFromServiceMesh | 从服务网格中删除集群 | 调用RemoveClusterFromServiceMesh接口从服务网格中删除一个集群。 |
| UpdateASMNamespaceFromGuestCluster | 将数据平面集群Namespace同步到ASM实例 | 调用UpdateASMNamespaceFromGuestCluster从加入服务网格的Kubernetes集群中同步命名空间信息。 |
| DescribeServiceMeshClusters | 获取服务网格的可用集群 | 调用DescribeServiceMeshClusters获取服务网格的可用集群。 |
| DescribeClustersInServiceMesh | 获取服务网格所在集群的信息列表 | 调用DescribeClustersInServiceMesh获取服务网格所在集群的信息列表。 |
| DescribeGuestClusterPods | 获取集群的Pod列表 | 调用DescribeGuestClusterPods获取指定K8s集群指定命名空间内的Pod。 |
| DescribeGuestClusterNamespaces | 获取集群内的命名空间列表 | 调用DescribeGuestClusterNamespaces获取加入服务网格的Kubernetes集群的命名空间列表。 |
| DescribeReusableSlb | 获取可复用的CLB（原SLB） | 调用DescribeReusableSlb获取可复用的CLB（原SLB）。 |
| GetRegisteredServiceEndpoints | 获取注册到网格内的服务端点信息 | 调用GetRegisteredServiceEndpoints获取注册服务端点信息。 |
| GetRegisteredServiceNamespaces | 获取注册服务所在的命名空间 | 调用GetRegisteredServiceNamespaces获取注册服务的命名空间列表。 |
ASM网关
| API | 标题 | API概述 |
|---|---|---|
| CreateASMGateway | 创建ASM网关 | 调用CreateASMGateway创建ASM网关。 |
| CreateIstioGatewayRoutes | 创建ASM网关对应的路由 | 调用CreateIstioGatewayRoutes创建ASM网关对应的路由。 |
| CreateGatewaySecret | 创建网关密钥 | 调用CreateGatewaySecret创建网关密钥。 |
| CreateIstioGatewayDomains | 创建网关域名证书 | 调用CreateIstioGatewayDomains创建网关域名证书。 |
| DeleteGatewayRoute | 删除路由条目 | 调用DeleteGatewayRoute删除网关路由。 |
| DeleteGatewaySecret | 删除网关密钥 | 调用DeleteGatewaySecret删除网关密钥。 |
| DeleteIstioGatewayDomains | 删除网关路由 | 调用DeleteIstioGatewayDomains删除网关路由。 |
| UpdateASMGateway | 修改ASM网关 | 调用UpdateASMGateway修改ASM网关。 |
| UpdateASMGatewayImportedServices | 更新ASM网关导入的服务信息 | 调用UpdateASMGatewayImportedServices更新ASM网关导入的服务信息，导入或删除网关关联的上游服务。 |
| UpdateIstioGatewayRoutes | 更新网关路由 | 调用UpdateIstioGatewayRoutes更新网关路由。 |
| UpdateIstioRouteAdditionalStatus | 更新路由额外信息 | 调用UpdateIstioRouteAdditionalStatus更新路由额外信息。 |
| DescribeImportedServicesDetail | 获取ASM网关已导入服务的详细信息 | 调用DescribeImportedServicesDetail获取ASM网关已导入服务的详细信息。 |
| DescribeASMGatewayImportedServices | 获取ASM网关已导入的服务信息 | 调用DescribeASMGatewayImportedServices获取ASM网关已导入的服务信息。 |
| DescribeIstioGatewayRouteDetail | 查看网关路由详情 | 调用DescribeIstioGatewayRouteDetail查看网关路由详情。 |
| DescribeGatewaySecretDetails | 查询网关证书密钥详细信息 | 调用DescribeGatewaySecretDetails查询网关证书密钥详细信息。 |
| DescribeIstioGatewayDomains | 查询网关域名列表 | 调用DescribeIstioGatewayDomains查询网关域名列表。 |
| DescribeIstioGatewayRoutes | 查询ASM网关的路由列表 | 调用DescribeIstioGatewayRoutes查询ASM网关的路由列表。 |
可观测性
| API | 标题 | API概述 |
|---|---|---|
| DescribeClusterGrafana | 获取集群的Grafana报表信息 | 调用DescribeClusterGrafana获取服务网格内集群的Grafana报表信息。 |
| DescribeClusterPrometheus | 获取集群的Prometheus公网地址 | 调用DescribeClusterPrometheus获取服务网格内集群的Prometheus公网地址。 |
| DescribeServiceMeshLogs | 获取网格日志 | 调用DescribeServiceMeshLogs获取网格日志。 |
| DescribeGuestClusterAccessLogDashboards | 获取数据面集群的访问日志报表 | 调用DescribeGuestClusterAccessLogDashboards获取数据面集群的访问日志报表。 |
| GetGrafanaDashboardUrl | 从ARMS获取Grafana仪表盘URL | 调用GetGrafanaDashboardUrl从ARMS获取Grafana仪表盘URL。 |
升级
| API | 标题 | API概述 |
|---|---|---|
| UpgradeMeshVersion | 升级服务网格的版本 | 调用UpgradeMeshVersion升级服务网格的版本。 |
| UpgradeMeshEditionPartially | 升级或切换ASM实例版本 | 调用UpgradeMeshEditionPartially升级ASM实例或者将ASM实例切换为专业版。 |
| DescribeUpgradeVersion | 获取服务网格的可更新版本信息 | 调用DescribeUpgradeVersion获取服务网格的可更新版本信息。 |
| DescribeServiceMeshUpgradeStatus | 查询ASM的升级状态 | 调用DescribeServiceMeshUpgradeStatus查询ASM实例和ASM网关的升级状态。 |
流量泳道
| API | 标题 | API概述 |
|---|---|---|
| CreateSwimLane | 创建泳道 | 调用CreateSwimLane创建泳道。 |
| CreateSwimLaneGroup | 创建泳道组 | 调用CreateSwimLaneGroup创建泳道组。 |
| DeleteSwimLane | 删除指定泳道 | 调用DeleteSwimLane删除指定泳道。 |
| DeleteSwimLaneGroup | 删除指定泳道组 | 调用DeleteSwimLaneGroup删除指定泳道组。删除泳道组对应也会删除泳道组下的泳道和相关引流规则。 |
| UpdateSwimLane | 更新指定泳道信息 | 调用UpdateSwimLane更新指定泳道信息。 |
| UpdateSwimLaneGroup | 更新对应泳道组 | 调用UpdateSwimLaneGroup更新对应泳道组。 |
| GetSwimLaneDetail | 获取指定泳道详细信息 | 调用GetSwimLaneDetail获取指定泳道详细信息。 |
| GetSwimLaneGroupList | 获取网格实例下所有泳道组列表 | 调用GetSwimLaneGroupList获取网格实例下所有泳道组列表。 |
| GetSwimLaneList | 获取某个泳道组下所有泳道列表 | 调用GetSwimLaneList获取某个泳道组下所有泳道列表。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| GetDeploymentBySelector | 获取Selector指定的工作负载列表 | 调用GetDeploymentBySelector获取Selector指定的工作负载列表。 |
| UpdateControlPlaneLogConfig | 修改控制面日志采集配置 | 修改控制面日志采集配置。 |
| UntagResources | 删除标签接口 | 调用UntagResources删除实例上的用户标签。 |
| ListTagResources | 标签查询接口 | 调用ListTagResources查询实例上的用户标签。 |
| TagResources | 编辑标签接口 | 调用TagResources添加或修改资源的用户标签。 |
| UpdateWaypoint | 更新一个数据面集群中某个Waypoint配置 | |
| CreateWaypoint | 在数据面集群中创建一个Waypoint | |
| DeleteWaypoint | 删除一个Waypoint | |
| ListWaypoints | 获取数据面集群的Waypoint配置 | 调用ListWaypoints获取数据面集群某个命名空间下所有Waypoint配置。 |
| ListServiceAccounts | 获取数据面集群的ServiceAccount | |
| UpdateMeshMultiClusterNetwork | 更新多集群网络分区配置 | 更新服务网格中多个Kubernetes集群的网络分区配置。 |
| DescribeMeshMultiClusterNetwork | 获取多集群网络分区配置描述 | 获取服务网格中多个Kubernetes集群的网络分区配置描述。 |
| ModifyPilotEipResource | 解绑或绑定Pilot的EIP | ModifyPilotEipResource |
| UpdateGuestClusterConfig | 修改GuestCluster配置 | 更新Guest Cluster配置 |