API標準及多語言預置SDK
本產品（eas/2021-07-01）的OpenAPI採用ROA簽名風格。我們已經為開發人員封裝了常見程式設計語言的SDK，開發人員可通過下載SDK直接調用本產品OpenAPI而無需關心技術細節。如果現有SDK不能滿足使用需求，可通過簽名機制進行自簽名對接。由於自簽名細節非常複雜，需花費 5個工作日左右。因此建議加入我們的服務DingTalk群（147535001692），在專家指導下進行簽名對接。
在使用API前，您需要準備好身份帳號及存取金鑰（AccessKey），才能有效通過用戶端工具（SDK、CLI等）訪問API。細節請參見擷取AccessKey。
自訂簽名情境
若您的業務情境有特殊需求，需通過自簽名方式對接 API，建議優先諮詢我們的支援人員團隊（服務DingTalk群：147535001692），擷取專業指導以確保高效接入。
帳號與安全準備
阿里雲帳號具備對所有資源的完全系統管理權限。一旦 AccessKey 泄露，所有相關資源都將面臨未經授權訪問的風險。為確保安全，建議建立一個僅具備 API 存取權限的RAM使用者並配置其 AccessKey，同時基於最小許可權原則 (PoLP) 配置 RAM 策略。僅在明確需要阿里雲帳號許可權的特定情境下，才使用阿里雲帳號。
服務
|
API |
標題 |
API概述 |
| CreateService | 建立服務 | 建立PAI-EAS服務。 |
| CreateServiceAutoScaler | 開通服務自動擴縮容 | 開通服務自動擴縮容功能，為服務建立自動擴縮控制器。 |
| CreateServiceCronScaler | 開通服務定時擴縮容 | 開通服務定時擴縮容功能。 |
| CreateServiceMirror | 開通服務流量鏡像 | 開啟服務流量鏡像功能，可以將一個服務接受到的請求鏡像到另一個服務上。 |
| CreateAppService | 建立應用服務 | 介紹如何建立應用服務，擷取大模型推理能力。 |
| CreateServiceInstanceToken | 擷取串連服務執行個體的 URL | 調用本介面可以擷取登入到容器所需的 token 以及 websocket 地址。 |
| DescribeGroupEndpoints | 擷取群組端點列表 | 擷取群組端點列表。 |
| DescribeServiceEndpoints | 擷取服務端點列表 | 擷取服務端點列表。 |
| DescribeServiceSignedUrl | 擷取服務免登入Web連結 | 擷取服務免登入Web訪問連結。 |
| DeleteService | 刪除服務 | 刪除指定的服務。 |
| CloneService | 複製服務 | 複製服務。 |
| ScaleService | 伸縮服務 | 伸縮服務 |
| UpdateServiceVersion | 切換服務版本 | 更新服務的目前的版本，用於服務在歷史版本的切換，可實現復原功能。 |
| DeleteServiceLabel | 刪除服務標籤 | 刪除已有的服務標籤。 |
| DeleteServiceAutoScaler | 關閉服務自動擴縮容 | 刪除服務已有的Auto Scaling控制器，關閉自動Auto Scaling功能。 |
| DeleteServiceCronScaler | 關閉服務定時擴縮容 | 關閉服務定時擴縮容功能。 |
| DeleteServiceInstances | 重啟服務執行個體 | 調用DeleteServiceInstances重啟服務的指定執行個體。 |
| DeleteServiceMirror | 關閉服務流量鏡像 | 關閉服務流量鏡像功能。 |
| UpdateServiceLabel | 更新服務標籤 | 新增服務標籤，或更新已有的服務標籤。 |
| ListServices | 查詢服務列表 | 列舉服務。 |
| UpdateService | 更新服務 | 用於服務的模型或Processor更新。如果只更新metadata.instance欄位，則用於服務擴縮容功能。 |
| StartService | 啟動服務 | 啟動一個已停止狀態的服務。 |
| StopService | 停止服務 | 停止一個運行中的服務。 |
| RestartService | 重啟服務 | 重啟服務。 |
| UpdateServiceAutoScaler | 更新服務自動擴縮容配置 | 修改服務已有的自動擴縮控制器配置。 |
| UpdateServiceCronScaler | 更新服務定時擴縮容配置 | 更新服務定時擴縮容配置資訊。 |
| DevelopService | 開發服務 | 將Container Service轉為開發模式，或退出開發模式。 |
| CommitService | Commit容器並發布 | 將自訂Container Service中Worker0容器提交為新鏡像，並重新部署服務。 |
| UpdateServiceMirror | 更新服務流量鏡像配置 | 更新服務流量鏡像配置。 |
| UpdateServiceSafetyLock | 更新服務安全鎖 | 更新服務安全鎖，可以一定程度上避免對服務的誤操作。 |
| UpdateServiceInstance | 更新服務執行個體屬性 | 更新服務執行個體屬性，目前只支援隔離服務執行個體。 |
| UpdateAppService | 更新應用服務 | 更新應用服務。 |
| UpdateGroup | 更新服務組 | 更新服務組的部分欄位。 |
| ReleaseService | 調整服務流量權重和流量狀態 | 修複服務的流量狀態和權重。 |
| DescribeService | 查詢服務詳情 | 擷取指定服務的詳細資料。 |
| DescribeServiceAutoScaler | 查看服務自動擴縮容資訊 | 查看服務的自動擴縮配置詳情。 |
| DescribeServiceCronScaler | 查看服務定時擴縮容資訊 | 查看服務的定時擴縮容配置詳情。 |
| DescribeServiceDiagnosis | 查看服務診斷詳情 | 查看服務的診斷詳情。 |
| DescribeServiceInstanceDiagnosis | 查看服務執行個體診斷詳情 | 查看服務執行個體的診斷詳情。 |
| DescribeServiceLog | 查看服務日誌 | 擷取指定服務的日誌資訊。 |
| DescribeServiceEvent | 查詢服務事件 | 查詢服務近期部署事件。 |
| DescribeServiceMirror | 查看服務流量鏡像資訊 | 查看指定服務的流量鏡像配置詳情。 |
| DescribeGroup | 查看服務群組詳情 | 查看服務群組資訊。 |
| DescribeSpotDiscountHistory | 查詢搶佔式執行個體歷史價格 | 查詢搶佔式執行個體歷史價格。關於搶佔式執行個體，請參考進階配置：搶佔型執行個體選擇。 |
| ListServiceInstances | 查詢服務執行個體列表 | 擷取指定服務的執行個體列表。 |
| ListServiceVersions | 查詢服務歷史版本 | 查詢服務歷史版本。 |
| ListServiceContainers | 查詢服務的容器列表 | 查詢服務的容器列表。 |
| ListGroups | 查看服務組列表 | 列舉已建立的服務群組。 |
| DescribeMachineSpec | 查詢可用機器規格列表 | 查詢可用機器規格列表 |
| CreateServiceRollout | 建立服務更新計劃 | 建立服務更新計劃 |
| DescribeServiceRollout | 查看服務更新計劃 | 查看服務更新計劃 |
| DeleteServiceRollout | 刪除服務更新計劃 | 刪除服務更新計劃 |
| UpdateServiceRollout | 更新服務更新計劃 | 更新服務發布計劃 |
| CreateFaultInjection | 建立故障注入 | 建立故障注入任務。 |
| DeleteFaultInjection | 刪除注入的故障 | 刪除故障注入任務 |
| ListServiceInstanceFaultInjectionInfo | 列舉已注入故障資訊 | 擷取故障注入資訊 |
資源群組
|
API |
標題 |
API概述 |
| UpdateVirtualResource | 更新虛擬資源群組資訊 | 更新虛擬資源群組資訊。 |
| ListVirtualResource | 查詢虛擬資源群組列表 | 擷取目前使用者的虛擬資源群組列表。 |
| DescribeVirtualResource | 查看虛擬資源群組詳情 | 查看虛擬資源群組詳情。 |
| DeleteVirtualResource | 刪除虛擬資源群組 | 刪除一個已有的虛擬資源群組，僅當虛擬資源群組中無服務任務的情況下才允許刪除。 |
| CreateVirtualResource | 建立虛擬資源群組 | 建立一個新的虛擬資源群組。 |
| CreateResource | 建立資源群組 | 建立一個新的資源群組。 |
| CreateResourceInstances | 建立資源群組機器 | 在專屬資源群組中建立新的機器執行個體。 |
| CreateResourceLog | 開通資源群組日誌投遞 | 開通資源群組SLS日誌投遞功能。 |
| DeleteResource | 刪除資源群組 | 刪除一個已有的資源群組，僅當資源群組中無任務服務和資源執行個體的情況下才允許刪除。 |
| DeleteResourceDLink | 關閉資源群組VPC直連 | 關閉專屬資源群組VPC直連功能。 |
| DeleteResourceInstances | 刪除資源群組機器執行個體 | 刪除專屬資源群組中的機器執行個體，普通使用者僅允許刪除後付費執行個體。 |
| DeleteResourceLog | 關閉資源群組日誌投遞 | 關閉專屬資源群組SLS日誌投遞功能。 |
| DeleteResourceInstanceLabel | 刪除資源群組機器執行個體標籤 | 刪除資源群組執行個體標籤。 |
| MigrateResourceInstance | 資源群組機器執行個體遷移 | 資源群組機器遷移 |
| UpdateResourceInstanceLabel | 更新資源群組機器執行個體標籤 | 更新資源群組執行個體標籤。 |
| UpdateResource | 更新資源群組資訊 | 更新專屬資源群組資訊。 |
| UpdateResourceDLink | 更新資源群組VPC直連配置 | 更新指定專屬資源群組的VPC直連配置。 |
| UpdateResourceInstance | 更新資源群組機器執行個體 | 更新專屬資源群組機器執行個體的調度狀態。 |
| DescribeResource | 查看資源群組詳情 | 查看資源群組詳情。 |
| DescribeResourceDLink | 查看資源群組VPC直連資訊 | 查看專屬資源群組VPC直連配置詳情。 |
| DescribeResourceLog | 查看資源群組日誌投遞資訊 | 查看專屬資源群組SLS日誌投遞配置詳情。 |
| ListResourceInstances | 查詢資源群組機器列表 | 擷取指定專屬資源群組中的機器執行個體列表。 |
| ListResourceInstanceWorker | 查詢資源群組工作執行個體列表 | 列舉資源執行個體的服務Worker列表。 |
| ListResources | 查詢資源群組列表 | 擷取目前使用者的專屬資源群組列表。 |
| ListResourceServices | 查詢資源群組中的服務列表 | 列舉專屬資源群組中已部署的服務列表。 |
壓力測試任務
|
API |
標題 |
API概述 |
| CreateBenchmarkTask | 建立壓測任務 | 調用CreateBenchmarkTask，建立壓測任務。 |
| DeleteBenchmarkTask | 刪除壓測任務 | 刪除指定的壓測任務。 |
| DescribeBenchmarkTask | 查看壓測任務詳情 | 查看指定壓測任務的詳細配置資訊。 |
| DescribeBenchmarkTaskReport | 查看壓測任務測試報告 | 查看指定壓測任務的報告。 |
| ListBenchmarkTask | 查詢壓測工作清單 | 查看目前使用者部署的所有壓測任務。 |
| StartBenchmarkTask | 啟動壓測任務 | 啟動指定的壓測任務。 |
| StopBenchmarkTask | 停止壓測任務 | 停止指定的壓測任務。 |
| UpdateBenchmarkTask | 更新壓測任務 | 更新指定的壓測任務。 |
私有閘道器
|
API |
標題 |
API概述 |
| CreateGateway | 建立私人網關 | 建立網關。 |
| DeleteGateway | 刪除私人網關 | 刪除私人網關。 |
| DeleteGatewayLabel | 刪除網關標籤 | 刪除網關標籤 |
| UpdateGatewayLabel | 更新網關標籤 | 新增網關標籤，或更新已有的網關標籤 |
| DetachGatewayDomain | 解除綁定網關自訂網域名 | 私人網關解除綁定自訂網域名。 |
| AttachGatewayDomain | 綁定網關自訂網域名 | 私人網關綁定自訂網域名。 |
| ListGatewayDomains | 查詢網關自訂網域名列表 | 查詢私人網關自訂網域名列表。 |
| ListGateway | 查詢私人網關列表 | 查詢私人網關列表。 |
| ListAclPolicy | 查詢網關存取權限列表 | 查看網關存取權限的列表。 |
| DeleteAclPolicy | 移除網關存取權限 | 刪除網關的存取權限，刪除的IP段不再具備訪問網關的許可權。 |
| CreateAclPolicy | 建立網關存取權限 | 建立私人網關的存取權限，添加許可權的IP段可以訪問網關。 |
| DescribeGateway | 查看私有閘道詳情 | 查看私有閘道詳情。 |
| UpdateGateway | 更新私人網關 | 更新私人網關。 |
| CreateGatewayIntranetLinkedVpc | 建立私人網關內網訪問端點 | 建立私人網關內網訪問端點。 |
| ListGatewayIntranetLinkedVpc | 查看私人網關內網訪問端點列表 | 查看私人網關內網訪問端點列表。 |
| ListGatewayIntranetSupportedZone | 查詢私人網關內網支援可用性區域 | 擷取網關內網支援的可用性區域 |
| DeleteGatewayIntranetLinkedVpc | 刪除私人網關內網訪問端點 | 刪除私人網關內網訪問端點。 |
| ListGatewayIntranetLinkedVpcPeer | 查詢對等專用網路列表 | 擷取網關內網訪問端點跨VPC串連列表。 |
| CreateGatewayIntranetLinkedVpcPeer | 添加對等專用網路 | 建立網關內網訪問端點跨VPC串連。 |
| DeleteGatewayIntranetLinkedVpcPeer | 刪除對等專用網路 | 刪除網關內網訪問端點跨VPC串連。 |
其他
|
API |
標題 |
API概述 |
| ReinstallTenantAddon | 更新租戶外掛程式資訊 | 重設租戶配置。 |
| ListTenantAddons | 查看租戶外掛程式列表 | 查看租戶外掛程式列表。 |
| CreateConfig | 建立動態參數 | 用於在指定服務中建立單個動態參數。 |
| DeleteConfig | 刪除動態參數 | 用於刪除指定服務下的單個動態參數。 |
| DescribeRegions | 查詢可用地區資訊 | 查詢可用的地區資訊 |
| ListConfigs | 查詢動態參數列表 | 查詢指定服務下的動態參數列表。 |
| UpdateConfig | 更新動態參數 | 用於更新指定叢集、服務下的單個動態參數的值。 |
Others
|
API |
標題 |
API概述 |
| CreateGroup | 建立服務群組 | 建立分組。 |
| DeleteGroup | 刪除服務組 | 刪除服務分組。 |
| DescribeArtifact | 查詢成品詳細資訊。 | 查詢成品詳細資訊。 |