API標準及多語言預置SDK
本產品（servicemesh/2020-01-11）的OpenAPI採用RPC簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
產品資訊
|
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配置 | 更新Waypoint |
| CreateWaypoint | 在資料面叢集中建立一個Waypoint | 建立Waypoint |
| DeleteWaypoint | 刪除一個Waypoint | 刪除Waypoint資源 |
| ListWaypoints | 擷取資料面叢集的Waypoint配置 | 調用ListWaypoints擷取資料面叢集某個命名空間下所有Waypoint配置。 |
| ListServiceAccounts | 擷取資料面叢集的ServiceAccount | 列舉所有服務帳號 |
| UpdateMeshMultiClusterNetwork | 更新多叢集網路磁碟分割配置 | 更新服務網格中多個Kubernetes叢集的網路磁碟分割配置。 |
| DescribeMeshMultiClusterNetwork | 擷取多叢集網路磁碟分割配置描述 | 擷取服務網格中多個Kubernetes叢集的網路磁碟分割配置描述。 |
| ModifyPilotEipResource | 解除綁定或綁定Pilot的EIP | ModifyPilotEipResource |
| UpdateGuestClusterConfig | 修改GuestCluster配置 | 更新Guest Cluster配置 |
虛擬機器
|
API |
標題 |
API概述 |
| DescribeVMsInServiceMesh | 取得服務網格中的虛擬機列表。 | 呼叫 DescribeVMsInServiceMesh 取得已經加入到服務網格的虛擬機。 |