getDetail

VPC環境で利用できます。

Data Forestアカウントの詳細情報を照会します。

リクエスト

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

リクエストヘッダ

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

リクエストボディ

リクエストボディの説明は次の通りです。

リクエスト例

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

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/accounts/getDetail' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "id": "Arv**************kfn"
}'

レスポンス

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

レスポンスボディ

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

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

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

レスポンス例

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

{
    "success": true,
    "id": "Arv**************kfn",
    "name": "df001",
    "status": "RUNNING",
    "createdAt": "2025-02-20T09:32:55+09:00",
    "quotas": [
        {
            "namespace": "koya",
            "fileCountMillion": 1,
            "spaceTb": 200
        },
        {
            "namespace": "tata",
            "fileCountMillion": 1,
            "spaceTb": 200
        }
    ]
}