跳到主要内容

API概述

概述​

  • 星界雲向用戶開放資源操作相關的API，我們的API是透過 HTTP GET 方式來進行呼叫的。
  • 在呼叫我們的API之前，您需要先在我們的控制檯申請 API金鑰 ， 包括 API金鑰ID ( AccessKeyId ) 和 API金鑰的私鑰 ( AccessKeySecret)。
  • API金鑰ID 將作為引數包含在每一個請求中傳送；而 API金鑰的私鑰 負責生成請求串的簽名，API金鑰的私鑰 需要被妥善保管，請勿外傳。

機房Region​

  • 雲服務以機房區域（Region）為單位部署，一個區域一般代表一個數據中心或者是一組低延時鏈路互聯的資料中心，各個區域之間相互獨立。（注：一個區域代表雲服務的一個獨立部署）。

API請求方式​

  • API 請求可以透過 HTTP 的 GET 請求發起。也可以使用星界雲提供的 SDK。
  • 所有 API 引數都放在 URL 中提供。

API請求限制​

  • 單位時間內請求次數限制，使用者需要合理安排。
  • 返回資料集長度限制，使用者應當分批獲取。

API請求型別​

我們的API請求主要分為 延遲請求 和 實時請求 兩種。

  • 延遲請求 這種操作，在 API 響應中會返回 TaskId，普通使用者可以透過檢視資源狀態來確認操作是否完成、成功還是失敗。例如，在提交 RunInstance 操作之後，使用者可以透過 DescribeInstances 來檢視 Instance的狀態以確認Instance是否建立成功。
  • 實時請求 這種操作會立刻返回操作結果。

API請求地址​

API請求樣例​

  • 新版：

    https://api.yunpanel.com/v2/?Action=RunInstance&Region=cn-wuxi1&AccessKeyId=569f60d78a704c84920550b21577ae1b&Version=1.0&Date=2016-09-02T16%3A59%3A00%20%2B0800&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D&ImageId=i-sdddxxx&Volumes.0.Type=normal&PayType=ONDEMAND&Period=1&InstanceSeries=SERIES_STANDARD

  • 舊版：

    https://api.yunpanel.com/?Action=RunInstance&Region=cn-wuxi1&AccessKeyId=569f60d78a704c84920550b21577ae1b&Version=1.0&Date=2016-09-02T16%3A59%3A00%20%2B0800&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D&ImageId=i-sdddxxx&Volumes.0.Type=normal&PayType=ONDEMAND&Period=1&InstanceSeries=SERIES_STANDARD

為了方便檢視，我們將文件中的請求都進行換行來顯示:

https://api.yunpanel.com/v2/?Action=RunInstance
&Region=cn-wuxi1
&AccessKeyId=569f60d78a704c84920550b21577ae1b
&Version=1.0
&Date=2016-09-02T16%3A59%3A00%20%2B0800
&Signature=JJ16Ph8pnOluwPULqudHGGNUf9IRPgScpiWrCHkvn%2Bw%3D
&ImageId=i-sdddxxx
&Volumes.0.Type=normal
&PayType=ONDEMAND
&Period=1
&InstanceSeries=SERIES_STANDARD

API返回結構​

響應資訊使用 JSON 格式，一般會返回以下的值：

  • 舊版：

    引數名稱描述
    TaskId每個請求都有一個TaskId
    Code如果該請求執行失敗，會返回一個Code，如果執行成功，沒有Code，詳情可見錯誤程式碼
    ErrorMessage如果有ErrorCode就會有對應的ErrorMessage，是對執行失敗原因的描述
    Action每個請求都會返回對應的一個Action操作名稱
    返回引數其他操作返回的引數見相關API操作文件

    對於查詢類的操作，一般會返回一個 XXXSet（其中 XXX 部分是資源名稱，比如 VolumeSet），放置所查詢的資源的詳細資訊列表。

    對於建立類的操作，一般會返回一個 XXXId（如果建立單個資源，比如 InstanceId）或者 XXXs（資源名稱複數，用於建立多個資源的場景，比如 Instances），指示所建立資源的 ID。

  • 新版：

    引數名稱描述
    code如果該請求執行失敗，會返回一個code，如果執行成功返回10000，詳情可見錯誤程式碼
    message請求錯誤資訊，是對執行失敗原因的描述
    data返回通訊資料，舊版的返回資訊統一放到新版的data裡面