get-datafence

VPC環境で利用できます。

Datafenceを照会します。

リクエスト

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

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

リクエストヘッダ

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

リクエスト例

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

curl --location --request GET 'https://datafence.apigw.ntruss.com/api/v1/fence/get-datafence' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`fenceId`	Integer	-	Datafence番号
`fenceName`	String	-	Datafence名
`boxCount`	Integer	-	Box数
`createDate`	String	-	Datafenceの作成日時 ISO 8601形式(UTC+9を含む)
`statusCode`	String	-	Datafenceの状態コード `INITIALIZE` \| `USE` \| `ING` \| `RETURN` \| `TERMINATE` `INITIALIZE`: インフラ作成中 `USE`: 利用中 `ING`: 変更中 `RETURN`: 返却中 `TERMINATE`: 返却完了
`statusName`	String	-	Datafenceの状態名 `インフラ作成中` \| `利用中` \| `変更中` \| `返却中` \| `返却完了`
`exportScreenBucketName`	String	-	持ち出し審査用バケット名
`description`	String	-	Datafenceの説明
`sslVpnName`	String	-	SSL VPN名

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

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

レスポンス例

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

[
    {
        "fenceId": 26,
        "fenceName": "datafense001",
        "boxCount": 1,
        "createDate": "2025-04-21T11:24:01+09:00",
        "statusCode": "USE",
        "statusName": "利用中",
        "description": "Description",
        "exportScreenBucketName": "datafense001",
        "sslVpnName": "datafence-ssl001"
    }
]