checkAvailableName

Available in VPC

Check whether an AI workspace name can be created.

Requests

Request parameters

Request headers

See common guide.

Request bodies

• JSON

    {
        "accountId": "string",
        "name": "string"
    }
  

• XML

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

Responses

Response bodies

• JSON

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

• XML

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

Errors

See DataForest overview

Examples

Request examples

• HTTP

  POST https://df.apigw.ntruss.com/api/v2/aiworkspaces/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=
  {
      "accountId": "wWwEh34wOZOgdafhe36lEO",
      "name": "workspace"
  }
  

• BASH

  curl -X POST "https://df.apigw.ntruss.com/api/v2/aiworkspaces/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 "{ \"accountId\": \"wWwEh34wOZOgdafhe36lEO\", \"name\": \"workspace\"}" \
  

Response examples

• HTTP

  HTTP Status	Description
  200	OK

• BASH

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