GetResourceList
    • PDF

    GetResourceList

    • PDF

    기사 요약

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

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

    요청

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

    메서드URI
    POST/api/v1/resources

    요청 헤더

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

    요청 바디

    요청 바디에 대한 설명은 다음과 같습니다.

    필드타입필수 여부설명
    nrnStringOptional네이버 클라우드 플랫폼 리소스 식별 값
    • 특정 리소스 1건 조회 시 사용
    productNameStringOptional리소스의 서비스 코드
    regionCodeStringOptional리소스의 리전 코드
    resourceTypeStringOptional리소스 유형
    resourceIdStringOptional리소스 아이디
    resourceNameStringOptional리소스 이름
    tagArrayOptional리소스 태그 정보
    groupNameStringOptional리소스 그룹 이름
    pageIndexIntegerOptional페이지 번호
    • 0~N (기본값: 0)
    pageSizeIntegerOptional페이지 출력 수
    • 1~100 (기본값: 20)

    tag

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

    필드타입필수 여부설명
    tagKeyStringRequired태그 키
    • 1~127자
    • 특수문자( -, _) 사용 가능
    • 이미 존재하는 키 추가 시 태그값만 업데이트
    tagValueStringOptional태그 값
    • 1~127자
    • 특수문자( -, _) 사용 가능
    • 태그 키 공유하는 개별 리소스 구분 시 사용

    요청 예시

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

    curl --location --request POST 'https://resourcemanager.apigw.ntruss.com/api/v1/resources' \
    --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' \
    --data '{
              "nrn": "nrn:PUB:IoTDeviceHub::****:Project/49"
    }'
    

    응답

    응답 형식을 설명합니다.

    응답 바디

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

    필드타입필수 여부설명
    pageIndexInteger-페이지 번호
    pageSizeInteger-페이지 출력 수
    itemCountInteger-응답 결과 수
    hasMoreBoolean-추가 페이지 존재 여부
    • true | false
      • true: 존재
      • false: 존재 안 함
    itemsArray-응답 결과

    items

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

    필드타입필수 여부설명
    nrnString-네이버 클라우드 플랫폼 리소스 식별 값
    platformTypeString-플랫폼 구분
    • BOTH | VPC | Classic
      • BOTH: 플랫폼 공통 환경
      • VPC: VPC 환경
      • Classic: Classic 환경
    productNameString-리소스의 서비스 코드
    productDisplayNameString-리소스의 서비스 이름
    regionCodeString-리소스의 리전 코드
    regionDispalyNameString-리소스의 리전 이름
    resourceTypeString-리소스 유형
    resourceIdString-리소스 아이디
    resourceNameString-리소스 이름
    createTimeInteger-리소스 생성 일시 (밀리초)
    • Unix Timestamp 형식
    eventTimeInteger-리소스 변경 일시 (밀리초)
    • Unix Timestamp 형식
    tagArray-리소스 태그 정보
    • 특정 리소스 1건 조회 시 표시
    groupArray-리소스 그룹 이름
    • 특정 리소스 1건 조회 시 표시

    응답 상태 코드

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

    응답 예시

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

    {
        "pageIndex": 0,
        "pageSize": 20,
        "itemCount": 1,
        "hasMore": false,
        "items": [
            {
                "nrn": "nrn:PUB:IoTDeviceHub::****:Project/49",
                "platformType": "BOTH",
                "productName": "IoTDeviceHub",
                "productDisplayName": "IoT Device Hub",
                "regionCode": "KR",
                "regionDisplayName": "Korea",
                "resourceType": "Project",
                "resourceId": "49",
                "resourceName": "testrename",
                "createTime": 1646809414000,
                "eventTime": 1646809414000,
                "tag": [
                    {
                        "tagKey": "key02",
                        "tagValue": "key02-01"
                    },
                    {
                        "tagKey": "key01",
                        "tagValue": "key01-01"
                    }
                ],
                "group": [
                    "group02",
                    "group01"
                ]
            }
        ]
    }
    

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

    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.