GetResourceList
- 인쇄
- PDF
GetResourceList
- 인쇄
- PDF
기사 요약
이 요약이 도움이 되었나요?
의견을 보내 주셔서 감사합니다.
Classic/VPC 환경에서 이용 가능합니다.
리소스 목록을 조회합니다.
요청
요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.
메서드 | URI |
---|---|
POST | /api/v1/resources |
요청 헤더
Resource Manager API에서 공통으로 사용하는 헤더에 대한 정보는 Resource Manager 요청 헤더를 참조해 주십시오.
요청 바디
요청 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
nrn | String | Optional | 네이버 클라우드 플랫폼 리소스 식별 값
|
productName | String | Optional | 리소스의 서비스 코드 |
regionCode | String | Optional | 리소스의 리전 코드 |
resourceType | String | Optional | 리소스 유형 |
resourceId | String | Optional | 리소스 아이디 |
resourceName | String | Optional | 리소스 이름 |
tag | Array | Optional | 리소스 태그 정보 |
groupName | String | Optional | 리소스 그룹 이름 |
pageIndex | Integer | Optional | 페이지 번호
|
pageSize | Integer | Optional | 페이지 출력 수
|
tag
tag
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
tagKey | String | Required | 태그 키
|
tagValue | String | Optional | 태그 값
|
요청 예시
요청 예시는 다음과 같습니다.
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"
}'
응답
응답 형식을 설명합니다.
응답 바디
응답 바디에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
pageIndex | Integer | - | 페이지 번호 |
pageSize | Integer | - | 페이지 출력 수 |
itemCount | Integer | - | 응답 결과 수 |
hasMore | Boolean | - | 추가 페이지 존재 여부
|
items | Array | - | 응답 결과 |
items
items
에 대한 설명은 다음과 같습니다.
필드 | 타입 | 필수 여부 | 설명 |
---|---|---|---|
nrn | String | - | 네이버 클라우드 플랫폼 리소스 식별 값 |
platformType | String | - | 플랫폼 구분
|
productName | String | - | 리소스의 서비스 코드 |
productDisplayName | String | - | 리소스의 서비스 이름 |
regionCode | String | - | 리소스의 리전 코드 |
regionDispalyName | String | - | 리소스의 리전 이름 |
resourceType | String | - | 리소스 유형 |
resourceId | String | - | 리소스 아이디 |
resourceName | String | - | 리소스 이름 |
createTime | Integer | - | 리소스 생성 일시 (밀리초)
|
eventTime | Integer | - | 리소스 변경 일시 (밀리초)
|
tag | Array | - | 리소스 태그 정보
|
group | Array | - | 리소스 그룹 이름
|
응답 상태 코드
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"
]
}
]
}
이 문서가 도움이 되었습니까?