getDetail

Prev Next

Available in VPC

Get details of a Data Forest account.

Request

This section describes the request format. The method and URI are as follows:

Method URI
POST /api/v2/accounts/getDetail

Request headers

For information about the headers common to all Data Forest APIs, see Data Forest request headers.

Request body

You can include the following data in the body of your request:

Field Type Required Description
id String Required Account's unique identifier
  • 0-22 characters
  • UUID converted to Base62 format
  • See getList.

Request example

The request example is as follows:

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"
}'

Response

This section describes the response format.

Response body

See GetAccountDetailResponse for the response body.

Response status codes

For response status codes common to all Data Forest APIs, see Data Forest response status codes.

Response example

The response example is as follows:

{
    "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
        }
    ]
}