get-box-custom-image

Prev Next

VPC環境で利用できます。

Boxのユーザーサーバイメージを照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド URI
GET /api/v1/box/get-box-custom-image

リクエストヘッダ

Datafence APIで共通して使用されるヘッダの詳細は、Datafenceのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド タイプ 必須の有無 説明
fenceId Integer Required Datafence番号
productCode String Required Boxスペックコード
  • CON | TF_CPU | TF_GPU | SVR_LNX_UBUNTU | SVR_WIN
    • CON: Connectサーバ
    • TF_CPU: TensorFlowサーバ(CPU)
    • TF_GPU: TensorFlowサーバ(GPU)
    • SVR_LNX_UBUNTU: Linuxサーバ(Ubuntu)
    • SVR_WIN: Windows Server

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-custom-image?fenceId=26&productCode=CON' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
content Array - ユーザーサーバイメージ情報

content

contentの説明は次の通りです。

フィールド タイプ 必須の有無 説明
imageNo Integer - イメージ番号
imageName String - イメージ名
productCode String - Boxスペックコード
  • CON | TF_CPU | TF_GPU | SVR_LNX_UBUNTU | SVR_WIN
    • CON: Connectサーバ
    • TF_CPU: TensorFlowサーバ(CPU)
    • TF_GPU: TensorFlowサーバ(GPU)
    • SVR_LNX_UBUNTU: Linuxサーバ(Ubuntu)
    • SVR_WIN: Windows Server
baseServerName String - イメージの基本サーバ名

レスポンスステータスコード

Datafence APIで共通して使用されるレスポンスステータスコードの詳細は、Datafence APIのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

{
  "content": [
    {
      "imageNo": 1,
      "imageName": "box-custom-image-1",
      "productCode": "CON",
      "baseServerName": "conn-1-1"
    }
  ]
}