本產品（
服務網格/2020-01-11）的OpenAPI采用RPC簽名風格，簽名細節參見簽名機制說明。我們已經為開發者封裝了常見編程語言的SDK，開發者可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由于自簽名細節非常復雜，需花費 5個工作日左右。因此建議加入我們的服務釘釘群（78410016550），在專家指導下進行簽名對接。在使用API前，您需要準備好身份賬號及訪問密鑰（AccessKey），才能有效通過客戶端工具（SDK、CLI等）訪問API。細節請參見獲取AccessKey。
產品信息
| API | 標題 | API概述 |
|---|---|---|
| DescribeMetadata | 獲取服務網格ASM的基本信息 | 調用DescribeMetadata獲取服務網格ASM的基本信息。 |
網格實例
| API | 標題 | API概述 |
|---|---|---|
| CreateServiceMesh | 創建一個服務網格實例 | 調用CreateServiceMesh創建一個服務網格實例。 |
| DeleteServiceMesh | 刪除一個服務網格實例 | 調用DeleteServiceMesh刪除一個服務網格實例。 |
| ModifyServiceMeshName | 修改服務網格實例名稱 | 調用ModifyServiceMeshName修改服務網格實例名稱。 |
| UpdateMeshFeature | 更新服務網格的功能配置 | 調用UpdateMeshFeature更新服務網格的功能配置。 |
| RevokeKubeconfig | 重新生成Kubeconfig | 調用RevokeKubeconfig吊銷ASM實例的Kubeconfig，并重新生成新的Kubeconfig。 |
| DescribeServiceMeshes | 獲取服務網格列表 | 調用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 | 添加一個集群到服務網格 | 調用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 |