ovahubGETBearer トークン
注文詳細を取得
/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 桁の16進数文字列です。対応する一覧エンドポイントが返すプラットフォーム ID を使用し、プロバイダーのインスタンス ID は使用しないでください。
レスポンス
HTTP ステータス 200
組織の注文 1 件と、提供完了後のプラットフォームサーバー識別子を取得します。
_idstring (ObjectId)注文識別子。
assetstring ('USD' | 'xTOVA')保存された決済資産。
amountstring整数の USD セント数、または整数の xTOVA 単位数。
planIdstring購入したプランの識別子。
regionstring購入したリージョンのコード。
daysnumber購入した課金期間の日数。
hostnamestringサーバーのホスト名。
namestring (optional)設定されている場合、ユーザー指定の表示名。
osstring指定された OS 識別子。
statusstring ('pending' | 'provisioning' | 'completed' | 'failed' | 'refunded')注文の提供処理状況。
providerServerIdstring | null判明している場合、プロバイダーのインスタンス識別子。
failureReasonstring | null存在する場合、記録された失敗理由。
createdAtstring (ISO 8601)注文作成日時。
updatedAtstring (ISO 8601)注文の最終更新日時。
testOnlyboolean注文が隔離されたテスト用リソースを使用するかどうか。
serverIdstring | null提供完了後のプラットフォームサーバー ObjectId、または null。providerServerId とは異なります。