本文為您介紹使用阿里雲CDNOpenAPI的基本資料。
OpenAPI介紹
為了能夠讓開發人員快速高效地學習和使用雲產品OpenAPI,阿里雲為使用者提供OpenAPI網站。它是一款集OpenAPI智能搜尋、文檔、線上調試、SDK擷取、CodeSample、調用出錯診斷、調用統計為一體的產品。您可以在OpenAPI門戶中調用阿里雲各雲產品開放的OpenAPI,查看OpenAPI請求和返回結果。此外,OpenAPI門戶會自動產生相應的SDK調用樣本,協助您快速使用阿里雲產品。更多資訊,請參見什麼是OpenAPI。
版本說明
|
版本號碼 |
說明 |
|
推薦使用。 |
線上調試
CDN在OpenAPI門戶提供API調試等功能。在調用前,您需要瞭解CDN提供的版本、存取點說明、整合方式等資訊。
以 AddCdnDomain(添加網域名稱)介面為例,在 OpenAPI 門戶左側導覽列選擇網域名稱管理 > 添加/刪除網域名稱 > 添加網域名稱 AddCdnDomain,在中間參數配置地區填寫必填參數 CdnType(加速網域名稱的業務類型)、DomainName(需要接入CDN的加速網域名稱)、Sources(回源地址清單),以及選擇性參數 ResourceGroupId、CheckUrl、Scope、TopLevelDomain 等,然後單擊發起調用。調用前需注意:需先開通 CDN 服務;加速網域名稱必須完成備案;每次只能添加一個網域名稱;每個使用者最多添加 50 個網域名稱;單個使用者調用頻率限制為 30 次/秒。
調試入口
調試API入口為:CDN API調試中心。
存取點說明
根據相關資源所在地區,選擇對應的服務存取點地址,以獲得最低延遲。例如華東2(上海)的CDN公網接入地址為cn-shanghai.aliyuncs.com。
更多資訊,請參見CDN服務存取點。
使用者身份
您阿里雲帳號登入OpenAPI網站後,預設使用您的阿里雲帳號進行線上OpenAPI調試。由於阿里雲帳號擁有所有API的存取權限,存在較高的風險。強烈建議您建立並使用RAM使用者進行API訪問或日常營運。請根據業務的實際情況按需分配許可權後進行介面調用。RAM使用者需具備操作CDN資源的許可權。具體操作,請參見使用RAM進行存取控制。
|
使用者身份 |
支援情況 |
|
支援 |
|
|
RAM 使用者(推薦) |
支援 |
|
RAM角色(推薦) |
支援 |
更多資訊
整合方式
CDN產品提供SDK、CLI等多種整合方式,您可以根據業務的實際需要進行選擇。
|
調用方式 |
支援情況 |
|
阿里雲SDK(推薦) |
支援 |
|
支援 |
|
|
支援 |
|
|
支援 |
|
|
支援 |
阿里雲SDK
-
阿里雲為開發人員提供了多種程式設計語言(Java、C#、Go、Py thon、Node.js/TypeScript、PHP、C++ 等)的SDK。開發人員只需要整合SDK,通過SDK暴露的方法直接調用OpenAPI 。SDK統一封裝了簽名邏輯、逾時機制、重試機制,並根據文檔返回結構化Response對象,易於開發。更多關於阿里雲SDK的介紹,請參見阿里雲SDK。
-
支援在OpenAPI通過阿里雲SDK調用CDN。支援語言及依賴安裝方法請參見CDN_SDK中心。
阿里雲CLI
-
支援使用阿里雲CLI調用CDN。更多資訊,請參見使用阿里雲CLI。
-
阿里雲命令列工具可以幫您在使用命令列終端時,使用
aliyun命令與阿里雲服務進行互動,管理雲端服務資源。有關阿里雲CLI的更多詳細資料,請參見什麼是阿里雲 CLI。
Terraform
-
Terraform 是一種開源工具,用於安全高效地預覽,配置和管理雲基礎架構和資源。它與阿里雲的Resource Orchestration Service服務的運行機制類似,通過將模板轉化為內部資料後完成 OpenAPI 呼叫。更多詳情,請參見瞭解阿里雲Terraform。
-
快速使用Terraform編排CDN,請參見Terraform整合樣本。
-
支援使用Terraform管理CDN的資源,支援一般資源和資料資源清單的部分如下。
資源類型
資源
說明
Resources
提供CDN網域設定資源。
提供CDN與資源及網域名稱。
提供了CDN FC的觸發器資源。
提供了CDN即時日誌傳遞資源。
Date Sources
提供CDN阻塞地區。
提供了驗證IP是否為CDN節點的功能。
提供當前阿里雲使用者的CDN即時日誌交付功能。
提供自動啟用CDN服務。
Resource Orchestration Service
-
Resource Orchestration Service服務ROS(Resource Orchestration Service)是阿里雲提供的一項簡化雲端運算資源管理的服務。開發人員和管理員可以編寫模板,在模板中定義所需的阿里雲資源(例如:ECS 執行個體、RDS 資料庫執行個體)、資源間的依賴關係等。ROS 的編排引擎將根據模板自動完成所有資源的建立和配置,實現自動化部署及營運。更多詳情,請參見什麼是Resource Orchestration Service服務。
-
快速使用Resource Orchestration Service編排CDN,請參見Resource Orchestration Service整合樣本。
-
支援使用Resource Orchestration Service服務ROS調用CDN。編排的部分資源套件括普通資源和資料資源。
-
普通資源:
-
ALIYUN::CDN::Domain:用於添加加速網域名稱。
-
ALIYUN::CDN::DomainConfig:用於大量設定網域名稱。
-
-
資料資源:
-
DATASOURCE::CDN::Domains:用於查詢已建立加速網域名稱的基礎資訊。
-
-
自訂封裝API調用
-
原生HTTP調用需要您自己實現簽名演算法,並構建自訂請求,發起HTTP調用。有關簽名機制的更多詳細資料,請參見文檔API概覽和V3版本請求體&簽名機制。
注意事項
如果調用API後返回錯誤,您需要根據返回的錯誤碼提示檢查傳入的請求參數及其取值是否正確,更多資訊請參見錯誤碼中心。
您也可以記錄下調用返回的RequestID或SDK報錯資訊,通過阿里雲OpenAPI診斷平台進行自助診斷。