GetGroupList
- 인쇄
- PDF
GetGroupList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
리소스 그룹 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
GET | /api/v1/groups |
요청 헤더
Resource Manager API에서 공통으로 사용하는 헤더에 대한 정보는 Resource Manager 공통 헤더를 참조해 주십시오.
요청 쿼리 파라미터
요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
groupName | String | Optional | 리소스 그룹 이름 |
pageIndex | Integer | Optional | 페이지 번호
|
pageSize | Integer | Optional | 페이지 출력 수
|
요청 예시
요청 예시는 다음과 같습니다.
curl --location --request GET 'https://resourcemanager.apigw.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 'Content-Type: application/json'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
pageIndex | Integer | - | 페이지 번호 |
pageSize | Integer | - | 페이지 출력 수 |
itemCount | Integer | - | 응답 결과 수 |
hasMore | Boolean | - | 추가 페이지 존재 여부
|
items | Array | - | 응답 결과 |
error | Object | - | 오류 코드 및 메시지
|
error.errorCode | Integer | - | 오류 코드 |
error.message | String | - | 오류 메시지 |
error.details | String | - | 오류 메시지 설명 |
items
items
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
groupId | String | - | 리소스 그룹 아이디 |
groupName | String | - | 리소스 그룹 이름 |
groupDesc | String | - | 리소스 그룹 설명 |
createTime | Integer | - | 리소스 그룹 생성 일시 |
updateTime | Integer | - | 리소스 그룹 최종 변경 일시 |
응답 상태 코드
Resource Manager API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Resource Manager 응답 상태 코드를 참조해 주십시오.
응답 예시
응답 예시는 다음과 같습니다.
{
"pageIndex": 0,
"pageSize": 20,
"itemCount": 2,
"hasMore": false,
"items": [
{
"groupId": "821ad7869d494b298aa9a13b",
"groupName": "testgroup_01",
"groupDesc": "test",
"createTime": 1727441443000,
"updateTime": 1727441443000
},
{
"groupId": "64f077df093f6a0838604299",
"groupName": "testgroup_02",
"groupDesc": "",
"createTime": 1693480928000,
"updateTime": 1693480928000
}
]
}
이 문서가 도움이 되었습니까?