checkAvailableName
- 印刷する
- PDF
checkAvailableName
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
Notebookを作成する際に、作成可能な名前を確認します。
リクエスト
リクエストパラメータ
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
name | YES | String | 最小3文字から最大15文字まで入力 | ノートブック名 |
リクエストヘッダ
リクエストボディ
- JSON
{ "name": "string" }
- XML
<?xml version="1.0" encoding="UTF-8"?> <CheckNotebookAvailableNameRequest> <name>string</name> </CheckNotebookAvailableNameRequest>
エラーコード
HTTP Status | Description |
---|---|
400 | invalid request parameters |
403 | not allowed to access |
404 | no such element |
500 | unexpected 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"
}
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 }
この記事は役に立ちましたか?