MENU
      checkAvailableName

        checkAvailableName


        記事の要約

        VPC環境で利用できます。

        Notebookを作成する際に、作成可能な名前を確認します。

        リクエスト

        リクエストパラメータ

        パラメータ名要否タイプ制約事項説明
        nameYESString最小3文字から最大15文字まで入力ノートブック名

        リクエストヘッダ

        共通ガイド参照

        リクエストボディ

        • JSON
          {
            "name": "string"
          }
          JSON
        • XML
          <?xml version="1.0" encoding="UTF-8"?>
          <CheckNotebookAvailableNameRequest>
            <name>string</name>
          </CheckNotebookAvailableNameRequest>
          XML

        エラーコード

        HTTP StatusDescription
        400invalid request parameters
        403not allowed to access
        404no such element
        500unexpected error

        リクエスト例

        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"
        }
        HTTP
        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\"}"
        Bash

        レスポンス例

        • HTTP

          HTTP StatusDescription
          200OK
        • BASH

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

        エラーコードの例

        • HTTP

          HTTP StatusDescription
          403not allowed to access
        • BASH

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

        この記事は役に立ちましたか?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.