GetResourceList
    • PDF

    GetResourceList

    • PDF

    Article Summary

    • Search for resources.

    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

    Go to Guide Request Headers

    Requests

    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"
    }
    
    ParameterRequirement statusTypeRestrictionsDescription
    nrnNstringYou can search only a single item (1 case) when requesting through nrn
    regionCodeNstring
    productNameNstring
    resourceTypeNstring
    resourceNameNstring
    resourceIdNstring
    tagNarray of object
    - tagKeyNstringRequired when using tag search conditions
    - tagValueNstring
    groupNameNstring
    pageIndexNintegerdefault: 0, starting from 0
    pageSizeNintegerdefault: 20, max: 100

    Responses

    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"
    }
    
    ItemTypeDescriptionRemarks
    itemsarray of object
    - nrnstring
    - platformTypestring
    - productNamestring
    - productDisplayNamestring
    - regionCodestring
    - regionDispalyNamestring
    - resourceTypestring
    - resourceIdstring
    - resourceNamestring
    - createTimeinteger
    - eventTimeinteger
    - tagarray of objectDisplayed only when searching for a single item through nrn
    -- tagKeystring
    -- tagValuestring
    - grouparray of stringDisplayed only when searching for a single item through nrn
    pageIndexinteger
    pageSizeinteger
    hasMoreboolean

    Errors

    Errors that may occur while using this action are listed below. For error response format, please see ErrorResponse.
    For more information about common errors, refer to the NAVER Cloud Platform API.

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

    Was this article helpful?

    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.