GetGroupList
    • PDF

    GetGroupList

    • PDF

    기사 요약

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

    리소스 그룹 목록을 조회합니다.

    요청

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

    메서드URI
    GET/api/v1/groups

    요청 헤더

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

    요청 쿼리 파라미터

    요청 쿼리 파라미터에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    groupNameStringOptional리소스 그룹 이름
    pageIndexIntegerOptional페이지 번호
    • 0~N (기본값: 0)
    pageSizeIntegerOptional페이지 출력 수
    • 1~100 (기본값: 20)

    요청 예시

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

    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'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

    응답 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    pageIndexInteger-페이지 번호
    pageSizeInteger-페이지 출력 수
    itemCountInteger-응답 결과 수
    hasMoreBoolean-추가 페이지 존재 여부
    • true | false
      • true: 존재
      • false: 존재 안 함
    itemsArray-응답 결과
    errorObject-오류 코드 및 메시지
    • 응답 실패 시 표시
    error.errorCodeInteger-오류 코드
    error.messageString-오류 메시지
    error.detailsString-오류 메시지 설명

    items

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

    필드타입필수 여부설명
    groupIdString-리소스 그룹 아이디
    groupNameString-리소스 그룹 이름
    groupDescString-리소스 그룹 설명
    createTimeInteger-리소스 그룹 생성 일시
    updateTimeInteger-리소스 그룹 최종 변경 일시

    응답 상태 코드

    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
            }
        ]
    }
    

    이 문서가 도움이 되었습니까?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.