checkAvailableName

Available in VPC

View the name of the account that can be created when creating a Data Forest account.

Requests

Request parameters

Request header

See common guide.

Request body

• JSON

  {
    "name": "string"
  }
  

• XML

  <?xml version="1.0" encoding="UTF-8"?>
  <CheckAccountAvailableNameRequest>
    <name>string</name>
  </CheckAccountAvailableNameRequest>
  

Responses

Response bodies

• JSON

    {
        "success": true,
        "availableName": true
    }
  

• XML

  <?xml version="1.0" encoding="UTF-8"?>
    <CheckAccountAvailableNameResponse>
        <success>true</success>
        <message/>
        <availableName>true</availableName>
    </CheckAccountAvailableNameResponse>
  

Errors

See DataForest overview.

Examples

Request examples

• HTTP

  POST https://df.apigw.ntruss.com/api/v2/accounts/checkAvailableName
  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=
  {
    "name": "cloud1"
  }
  

• BASH

  curl -X POST https://df.apigw.ntruss.com/api/v2/accounts/checkAvailableName \
  -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 "{ "name": "cloud1"}"
  

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

    {
        "success": true,
        "availableName": true
    }
  

  {
      "success": true,
      "message": "This account name is already in use.",
      "availableName": false
  }