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, "availableName": true }
이 문서가 도움이 되었습니까?