阿里雲 OpenAPI 是阿里雲提供的強大工具集，允許開發人員通過編程方式管理和調用阿里雲的各項服務，如 ECS（彈性計算服務）、OSS（Object Storage Service服務）、SMS（簡訊服務）等。本文旨在引導您從零開始，掌握如何線上調試阿里雲 OpenAPI。
註冊阿里雲帳號
調用OpenAPI，您需要擁有一個阿里雲帳號。如果您還沒有帳號，請訪問阿里雲官網註冊。
開通雲產品服務
您可以通過以下兩種方式開通您所需要的雲產品服務，例如開通簡訊服務：
只有開通了雲產品服務，才能調用該雲產品的OpenAPI。
線上調試 API
登入阿里雲OpenAPI門戶，選擇您已開通服務的雲產品（例如Elastic Compute Service），點擊去調試。
在調試頁面，選擇您想要調試的API，例如調試雲端服務器的DescribeInstanceTypeFamilies介面，可參閱API文檔後，在參數配置地區填寫符合要求的參數，單擊發起調用。更多詳細內容請參閱OpenAPI線上調試。
調用結果
發起調用之後，可在右側查看調用結果。調用結果頁簽中可以查看介面返回的狀態代碼和介面返回的資料。
調用成功
API 呼叫結果的狀態代碼一般為200。返回的資料結構一般是 JSON 格式，其中各業務響應欄位的含義可通過 API 文檔查看，例如雲端服務器的 DescribeInstanceTypeFamilies API 的響應參數文檔如下。
調用報錯
API 響應結果的狀態代碼一般為4xx。阿里雲 OpenAPI 報錯有統一的錯誤響應結構（除個別非統一網關產品），例如調用Elastic Compute Service 的 RunInstances 介面，報錯格式如下：
{
"RequestId": "7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"Message": "The specified endpoint cant operate this region. Please use API DescribeRegions to get the appropriate endpoint, or upgrade your SDK to latest version.(from POP)",
"Recommend": "https://api.aliyun.com/troubleshoot?q=InvalidOperation.NotSupportedEndpoint&product=Ecs&requestId=7DC0013A-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"HostId": "ecs-cn-hangzhou.aliyuncs.com",
"Code": "InvalidOperation.NotSupportedEndpoint"
}參數名 | 參數說明 |
RequestId | 全域唯一的請求標識符，用於追蹤和識別特定的API調用。當你需要聯絡阿里雲客服解決問題時，提供這個RequestId可以協助他們更快地定位問題發生的上下文。 |
HostId | 服務端主機標識。表示產生錯誤的主機標識或服務端點地址。在這個例子中，錯誤來源於阿里雲ECS（ Elastic Compute Service）服務的杭州地區終端節點。 |
Code | 錯誤碼。是對錯誤類型的簡短、精確描述，開發人員可以通過這個錯誤碼在阿里雲的文檔中尋找具體的錯誤含義和解決方案。在這個案例中，錯誤碼錶明了所嘗試的操作因為使用的終端節點不支援目的地區域而無效。 |
Message | 詳細錯誤資訊。在這個例子中，錯誤是因為使用的終端節點（endpoint）不支援操作指定的地區。阿里雲建議使用 |
Recommend | 錯誤診斷連結，可直接複製該連結跳轉到錯誤診斷頁面，可以擷取更多的解決方案。 |
關於異常排查更多資訊，請參閱OpenAPI報錯診斷。
SDK 樣本
支援在SDK 樣本頁簽，選擇SDK 版本，選擇SDK 語言，單擊運行樣本調試。
CLI 樣本
支援在CLI 樣本頁簽，單擊右側運行命令按鈕進行線上調試。
調用歷史
您可以在調用歷史頁簽查看線上試用 OpenAPI 的調用歷史，支援查看歷史調用參數、重新調試。如果歷史調用狀態為失敗，還可以使用診斷功能，診斷調用失敗原因。
錯誤碼
錯誤碼頁簽整理了在調用OpenAPI過程中可能會出現的錯誤以及與之相關的錯誤資訊描述，還提供診斷功能，一鍵跳轉到問題診斷頁面，以便進一步擷取解決該特定錯誤的協助文檔、論壇討論或是支援人員。
