get-box-infra-history

VPC環境で利用できます。

Boxのインフラ履歴を照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/box/get-box-infra-history

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`fenceId`	Integer	Required	Datafence番号 get-datafenceを参照
`boxId`	Integer	Required	Box番号 get-box-listを参照
`page`	Integer	Optional	ページ番号 0~100 (デフォルト: 0)
`size`	Integer	Optional	ページごとの項目数 1~100 (デフォルト: 10)

リクエスト例

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/box/get-box-infra-history?fenceId=26&boxId=74&page=1&size=10' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`totalCount`	Integer	-	レスポンス結果数
`content`	Array	-	Boxインフラ履歴リスト

`content`

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

フィールド	タイプ	必須の有無	説明
`infraType`	String	-	インフラタイプ `Connect Server` `TensorFlow Server(CPU)` `TensorFlow Server(GPU)` `Linux Server(Ubuntu)` `Hadoop` `NAS` `Block Storage`
`instanceNo`	Integer	-	インフラのインスタンス番号
`instanceName`	String	-	インフラのインスタンス名
`statusCode`	String	-	Boxの状態コード `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: インフラ作成中 `USE`: 利用中 `ING`: 変更中 `RETURN`: 返却中 `TERMINATE`: 返却完了
`statusName`	String	-	Boxの状態名 `インフラ作成中` \| `利用中` \| `変更中` \| `返却中` \| `返却完了`
`createDate`	String	-	Boxの作成日時 ISO 8601形式(UTC+9を含む)
`endDate`	String	-	Boxの返却日時 ISO 8601形式(UTC+9を含む)

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

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

レスポンス例

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

{
  "totalCount": 10,
  "content": [
    {
      "infraType": "Connect Server",
      "instanceNo": *********,
      "instanceName": "conn-XX-YYY-1",
      "createDate": "2025-01-09T13:51:10+09:00",
      "statusCode": "USE",
      "statusName": "利用中"
    },
    {
      "infraType": "Connect Server",
      "instanceNo": *********,
      "instanceName": "conn-XX-YYY-2",
      "createDate": "2025-02-25T19:13:04+09:00",
      "endDate": "2025-03-06T23:32:50+09:00",
      "statusCode": "TERMINATE",
      "statusName": "返却完了"
    },
    {
      "infraType": "Linux Server(Ubuntu)",
      "instanceNo": *********,
      "instanceName": "svrlnx-XX-YYY-1",
      "createDate": "2025-01-09T13:51:10+09:00",
      "endDate": "2025-03-06T23:34:50+09:00",
      "statusCode": "TERMINATE",
      "statusName": "返却完了"
    },
    {
      "infraType": "Linux Server(Ubuntu)",
      "instanceNo": *********,
      "instanceName": "svrlnx-XX-YYY-2",
      "createDate": "2025-02-11T17:24:13+09:00",
      "endDate": "2025-02-11T17:49:40+09:00",
      "statusCode": "TERMINATE",
      "statusName": "返却完了"
    },
    {
      "infraType": "Linux Server(Ubuntu)",
      "instanceNo": *********,
      "instanceName": "svrlnx-XX-YYY-3",
      "createDate": "2025-03-06T19:30:08+09:00",
      "statusCode": "USE",
      "statusName": "利用中"
    },
    {
      "infraType": "TensorFlow Server(CPU)",
      "instanceNo": *********,
      "instanceName": "tfcpu-XX-YYY-1",
      "createDate": "2025-03-14T13:53:19+09:00",
      "statusCode": "USE",
      "statusName": "利用中"
    },
    {
      "infraType": "NAS",
      "instanceNo": *********,
      "instanceName": "YYYbox1",
      "createDate": "2025-01-09T13:51:10+09:00",
      "statusCode": "USE",
      "statusName": "利用中"
    },
    {
      "infraType": "Hadoop",
      "instanceNo": *********,
      "instanceName": "hd-XX-YYY-1",
      "createDate": "2025-02-18T11:48:25+09:00",
      "endDate": "2025-02-19T10:13:50+09:00",
      "statusCode": "TERMINATE",
      "statusName": "返却完了"
    },
    {
      "infraType": "Hadoop",
      "instanceNo": *********,
      "instanceName": "hd-XX-YYY-2",
      "createDate": "2025-02-19T10:09:18+09:00",
      "endDate": "2025-02-19T17:01:40+09:00",
      "statusCode": "TERMINATE",
      "statusName": "返却完了"
    },
    {
      "infraType": "Block Storage",
      "instanceNo": *********,
      "instanceName": "conn-XX-YYY-1-storage",
      "createDate": "2025-01-09T13:51:10+09:00",
      "statusCode": "USE",
      "statusName": "利用中",
      "serverInstanceNo": 1,
      "serverInstanceName": "conn-XX-YYY-1"
    }
  ]
}