프로필 목록 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

프로필 목록을 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /api/v1/profiles

요청 헤더

Global Edge API에서 공통으로 사용하는 헤더에 대한 정보는 Global Edge 요청 헤더를 참조해 주십시오.

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://edge.apigw.ntruss.com/api/v1/profiles' \
--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 Array - 프로필 목록

result

result에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id Integer - 프로필 아이디
customerId Integer - 사용자 식별 번호
profileName String - 프로필 이름
참고

customerId는 응답 결과에 노출될 수 있으나 서비스 사용에 영향을 주지 않는 필드입니다.

응답 상태 코드

Global Edge API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Global Edge 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "code": "0000",
    "message": "Success",
    "result": [
        {
            "id": 1599,
            "customerId": 35,
            "profileName": "myprofile"
        },
        {
            "id": 1600,
            "customerId": 35,
            "profileName": "myprofile2"
        }
    ]
}