checkAvailableName

VPC 환경에서 이용 가능합니다.

Notebook 생성 시, 생성 가능한 이름을 확인합니다.

요청

요청 파라미터

요청 헤더

공통 가이드 참조

요청 바디

• JSON

  {
    "name": "string"
  }
  

• XML

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

응답

응답 바디

• JSON

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

• XML

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

오류코드

DataForest 개요 참조

예시

요청 예시

POST https://df.apigw.ntruss.com/api/v2/notebooks/checkAvailableName
HOST: df.apigw.ntruss.com
Content-Type: application/json
x-ncp-apigw-signature-v2: Azm1WBMWDgEONUCUbsVkB4tRIpc053uOHU8bitbQRtU=
x-ncp-apigw-timestamp: 1658898041497
x-ncp-iam-access-key: 17F9A6E9F72BD92ED94B
{
  "name": "df-test"
}

  curl -X POST "https://df.apigw.ntruss.com/api/v2/notebooks/checkAvailableName" \
  -H "accept: application/json" \
  -H "Content-Type: application/json" \
  -H "x-ncp-iam-access-key: F5O55GOTR4CqYJqPDnCu"\
  -H "x-ncp-apigw-timestamp: 1684389111294"\
  -H "x-ncp-apigw-signature-v2: QNRzcCz87VRhaBByb7jz8/iJ+ZyDbHZimPm6hM0Hyp8=" \
  -d "{ \"name\": \"df-test\"}"

응답 예시

• HTTP

  HTTP Status	Description
  200	OK

• BASH

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

  {
  "success": true,
  "message": "'df-notebook' is not registrable name. already registered.",
  "availableName": false
  }
  

오류 코드 예시

• HTTP

  HTTP Status	Description
  403	not allowed to access

• BASH

  {
    "message": "resource ('string') is not allowed or not exists",
    "success": false
  }