GetResourceList
    • PDF

    GetResourceList

    • PDF

    Article Summary

    • 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"
    }
    
    파라미터필수여부타입제약사항설명
    nrnNstringnrn을 통한 요청시 단건(1건)만 조회 가능
    regionCodeNstring
    productNameNstring
    resourceTypeNstring
    resourceNameNstring
    resourceIdNstring
    tagNarray of object
    - tagKeyNstringtag 조회 조건 사용시, 필수
    - tagValueNstring
    groupNameNstring
    pageIndexNintegerdefault: 0, starting from 0
    pageSizeNintegerdefault: 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"
    }
    
    항목타입설명비고
    itemsarray of object
    - nrnstring
    - platformTypestring
    - productNamestring
    - productDisplayNamestring
    - regionCodestring
    - regionDispalyNamestring
    - resourceTypestring
    - resourceIdstring
    - resourceNamestring
    - createTimeinteger
    - eventTimeinteger
    - tagarray of objectnrn을 통한 단건 조회시에만 표기됨
    -- tagKeystring
    -- tagValuestring
    - grouparray of stringnrn을 통한 단건 조회시에만 표기됨
    pageIndexinteger
    pageSizeinteger
    hasMoreboolean

    에러

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

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

    HTTP status codemessage
    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.