checkAvailableName
- 印刷する
- PDF
checkAvailableName
- 印刷する
- PDF
記事の要約
この要約は役に立ちましたか?
ご意見ありがとうございます
VPC環境で利用できます。
AIワークスペースの名前が作成できるかどうか確認します。
リクエスト
リクエストパラメータ
パラメータ名 | 要否 | タイプ | 制約事項 | 説明 |
---|---|---|---|---|
accountId | YES | String | 最大22文字まで入力 | - アカウント識別子 UUID(base62) - accountIdは Accountsの getList APIを通じて取得可能 |
name | YES | String | - 最大15文字まで入力 - 先頭の文字はアルファベット小文字、その他はアルファベット小文字/数字/ハイフン(-)で構成 -ハイフンの連続使用できず、末尾の文字にはハイフンにしない | AIワークスペースの名前 |
リクエストヘッダ
リクエストボディ
- JSON
{ "accountId": "string", "name": "string" }
- XML
<?xml version="1.0" encoding="UTF-8"?> <CheckAiWorkspaceAvailableNameRequest> <accountId>string</accountId> <name>string</name> </CheckAiWorkspaceAvailableNameRequest>
レスポンス
レスポンスボディ
- 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>
エラーコード
例
リクエスト例
- 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\"}" \
レスポンス例
HTTP
HTTP Status Description 200 OK BASH
{ "success": true, "message": "success", "availableName": true }
この記事は役に立ちましたか?