跳至文檔內容
開發者文檔API 參考查詢訂單詳情
GETBearer 權杖

查詢訂單詳情

/api/v1/orders/:id

查詢訂單,以及交付後的 serverId。

呼叫前請注意

結果待處理或不明時,請查詢原訂單。不要為了確認結果而再次購買。

API 欄位名稱、型別與程式碼在所有語言中保持原樣。

請求範例

cURL
curl "https://tovahub.com/api/v1/orders/507f1f77bcf86cd799439012" \
  -H "Authorization: Bearer $TOVAHUB_TOKEN"

僅提供範例,此頁不會發送 API 請求。

參數

id路徑 · 必填

string

資源 ID:24 個十六進位字元。請使用對應列表端點回傳的平台 ID,而非供應商的執行個體 ID。

回應

HTTP 狀態 200

讀取一筆組織訂單及交付後的平台伺服器識別碼。

_idstring (ObjectId)

訂單識別碼。

assetstring ('USD' | 'xTOVA')

儲存的付款資產。

amountstring

整數美分或整數 xTOVA 單位。

planIdstring

購買的方案識別碼。

regionstring

購買的地區代碼。

daysnumber

購買的計費天數。

hostnamestring

伺服器主機名稱。

namestring (optional)

使用者設定的顯示名稱(若有)。

osstring

請求的作業系統識別碼。

statusstring ('pending' | 'provisioning' | 'completed' | 'failed' | 'refunded')

訂單履行狀態。

providerServerIdstring | null

供應商執行個體識別碼(若已知)。

failureReasonstring | null

記錄的失敗原因(若有)。

createdAtstring (ISO 8601)

訂單建立時間。

updatedAtstring (ISO 8601)

訂單最後更新時間。

testOnlyboolean

此訂單是否使用隔離測試資源。

serverIdstring | null

交付後的平台伺服器 ObjectId,或 null;與 providerServerId 不同。