GetResourceList
  • PDF

GetResourceList

  • PDF

  • Resource를 조회합니다.

API

POST /api/v1/resources

Content-Type: application/json; charset=utf-8
x-ncp-apigw-timestamp: {Timestamp}
x-ncp-iam-access-key: {Sub Account Access Key or STS Access Key}`
x-ncp-apigw-signature-v2: {API Gateway Signature}

API Header

가이드 바로가기 Request Headers

요청

Request body

{
  "nrn": "string",
  "regionCode": "string",
  "productName": "string",
  "resourceType": "string",
  "resourceName": "string",
  "resourceId": "string",
  "tag": [
    {
      "tagKey": "string"
    },
    {
      "tagKey": "string",
      "tagValue": "string"
    }
  ],
  "groupName": "string",
  "pageIndex": "integer",
  "pageSize": "integer"
}
파라미터 필수여부 타입 제약사항 설명
nrn N string nrn을 통한 요청시 단건(1건)만 조회 가능
regionCode N string
productName N string
resourceType N string
resourceName N string
resourceId N string
tag N array of object
- tagKey N string tag 조회 조건 사용시, 필수
- tagValue N string
groupName N string
pageIndex N integer default: 0, starting from 0
pageSize N integer default: 20, max: 100

응답

Response body

{
  "items": [
    {
      "nrn": "string",
      "platformType": "string",
      "productName": "string",
      "productDisplayName": "string",
      "regionCode": "string",
      "regionDispalyName": "string",
      "resourceType": "string",
      "resourceId": "string",
      "resourceName": "string",
      "createTime": "integer",
      "eventTime": "integer",
      "tag": [
        {
          "tagKey": "string",
          "tagValue": "string"
        }
      ],
      "group": [
        "string"
      ]
    }
  ],
  "pageIndex": "integer",
  "pageSize": "integer",
  "hasMore": "boolean"
}
항목 타입 설명 비고
items array of object
- nrn string
- platformType string
- productName string
- productDisplayName string
- regionCode string
- regionDispalyName string
- resourceType string
- resourceId string
- resourceName string
- createTime integer
- eventTime integer
- tag array of object nrn을 통한 단건 조회시에만 표기됨
-- tagKey string
-- tagValue string
- group array of string nrn을 통한 단건 조회시에만 표기됨
pageIndex integer
pageSize integer
hasMore boolean

에러

아래 에러 코드는 이 액션(Action)에서 특징적으로 발생하는 에러입니다. 에러 응답 형식은 ErrorResponse를 참조하세요.

공통적으로 발생하는 에러에 대한 상세한 설명은 NAVER Cloud Platform API를 참고해주세요.

HTTP status code message
400 'tagKey' cannot be empty when using 'tag' parameter.

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

What's Next
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.