getList

VPC環境で利用できます。

Data Forestの全アカウントリストを照会します。

リクエスト

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

リクエストヘッダ

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

リクエスト例

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

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/accounts/getList' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json'

レスポンス

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

レスポンスボディ

レスポンスボディの詳細は、GetAccountListResponseをご参照ください。

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

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

レスポンス例

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

{
    "success": true,
    "total": 1,
    "contents": [
        {
            "id": "Arv**************kfn",
            "name": "df001",
            "principal": "df001@KR.DF.NAVERNCP.COM",
            "status": "RUNNING",
            "createdAt": "2025-02-20T09:32:55+09:00",
            "disabled": false
        }
    ]
}