checkAvailableName

VPC環境で利用できます。

Data Forestアプリ名の有効性と重複チェックを行います。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
POST	/api/v2/apps/checkAvailableName

リクエストヘッダ

Data Forest APIで共通して使用されるヘッダの詳細は、Data Forestのリクエストヘッダをご参照ください。

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`accountId`	String	Required	アカウント固有 ID 0~22文字 UUIDを Base62に変換した形式 AccountsのgetListを参照
`name`	String	Required	アプリ名英字の小文字、数字、記号の「-」を組み合わせて3~15文字以内で入力文字列の先頭文字と末尾文字は英字の小文字または数字のみ使用記号の「-」は連続使用できない

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request POST 'https://df.apigw.ntruss.com/api/v2/apps/checkAvailableName' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--data '{
    "accountId": "Arv**************kfn",
    "name": "dev24x7"
}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`success`	Boolean	-	API処理結果 `true` \| `false` `true`: 成功 `false`: 失敗
`message`	String	-	結果メッセージ `success`または`availableName`が`false`の場合、表示
`availableName`	Boolean	-	アプリ名が有効かどうか `true` \| `false` `true`: 有効 `false`: 無効

レスポンスステータスコード

Data Forest APIで共通して使用されるレスポンスステータスコードの詳細は、Data Forestのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

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