get-datafence-infra-list

VPC環境で利用できます。

Datafenceのインフラリストを照会します。

リクエスト

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

メソッド	URI
GET	/api/v1/fence/get-datafence-infra-list

リクエストヘッダ

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

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

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

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

リクエスト例

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/fence/get-datafence-infra-list?fenceId=26&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	-	Datafenceリスト

`content`

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

フィールド	タイプ	必須の有無	説明
`infraType`	String	-	インフラタイプ `FENCE_UBUNTU`: 管理用 Ubuntuサーバ `FENCE_NAS`: Datafence NAS
`instanceName`	String	-	インフラのインスタンス名
`privateIp`	String	-	インフラのプライベート IPアドレス `infraType`が`FENCE_UBUNTU`の場合に表示
`publicIp`	String	-	インフラのグローバル IPアドレス `infraType`が`FENCE_UBUNTU`の場合に表示
`osName`	String	-	サーバの OS名 `infraType`が`FENCE_UBUNTU`の場合、表示
`specName`	String	-	サーバまたは NASスペック名 `infraType`が`NAS`の場合、容量を表示
`userName`	String	-	サーバアクセスアカウント名 `infraType`が`NAS`の場合、マウントパスを表示
`createDate`	String	-	Datafenceの作成日時 ISO 8601形式(UTC+9を含む)
`statusCode`	String	-	Datafenceの状態コード `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: インフラ作成中 `USE`: 利用中 `ING`: 変更中 `RETURN`: 返却中 `TERMINATE`: 返却完了
`statusName`	String	-	Datafenceの状態名 `インフラ作成中` \| `利用中` \| `変更中` \| `返却中` \| `返却完了`
`instanceNo`	Integer	-	インフラのインスタンス番号
`instanceStatus`	String	-	インフラの状態名 `利用中` \| `再起動` \| `設定中`
`instanceStatusCode`	String	-	インフラの状態コード `RUN` \| `REBOOT` \| `SETTING` `RUN`: 利用中 `REBOOT`: 再起動 `SETTTING`: 設定

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

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

レスポンス例

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

{
  "totalCount": 2,
  "content": [
    {
      "infraType": "Server",
      "instanceName": "fence-XX-Y",
      "privateIp": "xxx.xxx.xxx.xxx",
      "publicIp": "xxx.xxx.xxx.xxx",
      "osName": "Ubuntu",
      "specName": "CPU Linux Server (S2 L1 : 2vCPU 8GB Mem)",
      "userName": "root",
      "createDate": "2025-03-25T15:39:04+09:00",
      "statusCode": "USE",
      "statusName": "利用中",
      "instanceNo": "-",
      "instanceStatus": "利用中",
      "instanceStatusCode": "RUN"
    },
    {
      "infraType": "NAS",
      "instanceName": "XXfenceY",
      "specName": "500",
      "userName": "/mnt/nasr/XXfenceY",
      "createDate": "2025-01-09T13:51:10+09:00",
      "statusCode": "USE",
      "statusName": "利用中",
      "instanceNo": "-",
      "instanceStatus": "利用中",
      "instanceStatusCode": "USE"
    }
  ]
}