그룹 목록 조회
- 인쇄
- PDF
그룹 목록 조회
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
그룹 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
| 메서드 | URI |
|---|---|
| GET | /api/v1/groups |
요청 헤더
Sub Account API에서 공통으로 사용하는 헤더에 대한 정보는 Sub Account 요청 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
page | Integer | Optional | 페이지 번호
|
size | Integer | Optional | 페이지 출력 수
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://subaccount.apigw.gov-ntruss.com/api/v1/groups' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Accept: application/json'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
page | Integer | - | 페이지 번호 |
totalPages | Integer | - | 전체 페이지 수 |
totalItems | Integer | - | 응답 결과 수 |
hasPrevious | Boolean | - | 이전 페이지 존재 여부
|
hasNext | Boolean | - | 다음 페이지 존재 여부
|
items | Array | - | 그룹 목록 |
isFirst | Boolean | - | 첫 페이지 여부
|
isLast | Boolean | - | 마지막 페이지 여부
|
items
items에 대한 설명은 다음과 같습니다.
| 필드 | 타입 | 필수 여부 | 설명 |
|---|---|---|---|
groupId | String | - | 그룹 아이디 |
groupName | String | - | 그룹 이름 |
nrn | String | - | 그룹에 대한 네이버 클라우드 플랫폼 리소스 식별 값 |
응답 상태 코드
Sub Account API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Sub Account 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"page": 0,
"totalPages": 1,
"totalItems": 2,
"hasPrevious": false,
"hasNext": false,
"items": [
{
"groupId": "50b77400-****-****-****-246e96591a38",
"groupName": "group001",
"nrn": "nrn:PUB:IAM::2768364:Group/50b77400-****-****-****-246e96591a38"
},
{
"groupId": "c046b960-****-****-****-246e96591594",
"groupName": "group",
"nrn": "nrn:PUB:IAM::2768364:Group/c046b960-****-****-****-246e96591594"
}
],
"isFirst": true,
"isLast": true
}
이 문서가 도움이 되었습니까?