getDetail

Available in VPC

Detailed Data Forest account information is viewed.

Requests

Request Parameters

Request headers

See common guide.

Request Bodies

• JSON

  {
  "id": "string"
  }
  

• XML

    <?xml version="1.0" encoding="UTF-8"?>
    <GetAccountDetailRequest>
        <id>string</id>
    </GetAccountDetailRequest>
  

Responses

Response bodies

GetAccountDetailResponse

• JSON

    {
      "createdAt": "2023-04-20T06:52:38.645Z",
      "id": "string",
      "message": "string",
      "name": "string",
      "quotas": [
        {
          "fileCountMillion": 1,
          "namespace": "koya",
          "spaceTb": 200
        }
      ],
      "status": "RUNNING",
      "success": true
    }
  

• XML

  <?xml version="1.0" encoding="UTF-8"?>
  <GetAccountDetailResponse>
    <createdAt>2023-04-20T07:06:56.308Z</createdAt>
    <id>string</id>
    <message>string</message>
    <name>string</name>
    <quotas>
      <fileCountMillion>1</fileCountMillion>
      <namespace>koya</namespace>
      <spaceTb>200</spaceTb>
    </quotas>
    <status>RUNNING</status>
    <success>true</success>
  </GetAccountDetailResponse>
  

Errors

See DataForest overview

Examples

Request Examples

• HTTP

  POST https://df.apigw.ntruss.com/api/v2/accounts/getDetail
  HOST: df.apigw.ntruss.com
  Content-Type: application/json
  x-ncp-apigw-timestamp: 1505290625682
  x-ncp-iam-access-key: D78BB444D6D3C84CA38A
  x-ncp-apigw-signature-v2: WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=
  {
    "id": "axE7wU9ERm8fTc7e17vNvu"
  }
  

• BASH

  curl -X POST "https://df.apigw.ntruss.com/api/v2/accounts/getDetail" \
  -H "accept: application/json" \ 
  -H "Content-Type: application/json" \
  -H "x-ncp-apigw-timestamp:1505290625682" \
  -H "x-ncp-iam-access-key:D78BB444D6D3C84CA38A" \
  -H "x-ncp-apigw-signature-v2:WTPItrmMIfLUk/UyUIyoQbA/z5hq9o3G8eQMolUzTEo=" \
  -d "{ \"id\": \"axE7wU9ERm8fTc7e17vNvu\"}" \
  

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

  {
   "success": true,
  "id": "axE7wU9ERm8fTc7e17vNvu",
   "name": "df-api",
   "status": "RUNNING",
   "createdAt": "2023-05-26T11:35:01+09:00",
   "quotas": [
       {
       "namespace": "koya",
       "fileCountMillion": 1,
       "spaceTb": 200
      },
      {
      "namespace": "tata",
      "fileCountMillion": 1,
      "spaceTb": 200
          }
      ]
   }
  

Errors examples

• HTTP

  HTTP Status	Description
  403	not allowed to access

• BASH

  {
   "error": {
  "errorCode": "10002",
   "requestId": "7c56cbaf-fe89-4cce-af58-3238e67f3e90",
  "message": "resource ('20nAZnjbUNFdc7RsILlC3A') is not allowed or not exists"
    }
  }