Classic/VPC 환경에서 이용 가능합니다.
프로필 이름의 유효성 및 중복 여부를 체크합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/profiles/validation |
요청 헤더
Global Edge API에서 공통으로 사용하는 헤더에 대한 정보는 Global Edge 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
name |
String | Required | 프로필 이름
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles/validation?name=profilename-test' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
code |
String | - | 응답 코드 |
message |
String | - | 응답 메시지 |
result |
Boolean | - | 프로필 이름 체크 결과
|
응답 상태 코드
Global Edge API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Global Edge 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
체크 결과 사용 가능 이름인 경우
체크 결과 사용 가능 이름인 경우의 응답 예시는 다음과 같습니다.
{
"code": "0000",
"message": "Success",
"result": false
}
체크 결과 사용 불가능 이름인 경우
체크 결과 사용 불가능 이름인 경우의 응답 예시는 다음과 같습니다.
- 프로필 이름이 이미 존재하는 경우
{ "code": "0000", "message": "Success", "result": true }
- 프로필 이름이 유효하지 않은 경우
{ "traceId": "32ohg69i6aphn36d1lccr3adhk", "path": "/v1/external/profiles/validation", "timestamp": 1752547449310, "product": "Global Edge", "status": 400, "code": "0040", "message": "Field validation Error", "details": "existsProfileName.name=my : size must be between 3 and 35" }