MENU
      GetResourceList

        GetResourceList


        Article summary

        Available in Classic and VPC

        Get the resource list.

        Request

        This section describes the request format. The method and URI are as follows:

        MethodURI
        POST/api/v1/resources

        Request headers

        For information about the headers common to all Resource Manager APIs, see Resource Manager request headers.

        Request body

        You can include the following data in the body of your request:

        FieldTypeRequiredDescription
        nrnStringOptionalNAVER Cloud Platform resource identification value
        • Use when querying a specific resource
        productNameStringOptionalService code of the resource
        regionCodeStringOptionalRegion code of the resource
        resourceTypeStringOptionalResource type
        resourceIdStringOptionalResource ID
        resourceNameStringOptionalResource name
        tagArrayOptionalResource tag information
        groupNameStringOptionalResource group name
        pageIndexIntegerOptionalPage number
        • 0 - N (default: 0)
        pageSizeIntegerOptionalPage output count
        • 1 - 100 (default: 20)

        tag

        The following describes tag.

        FieldTypeRequiredDescription
        tagKeyStringRequiredTag key
        • 1 - 127 characters
        • Special characters (-, _) can be used
        • Only update tag values when adding an already existing key
        tagValueStringOptionalTag value
        • 1 - 127 characters
        • Special characters (-, _) can be used
        • Use to distinguish individual resources that share a tag key

        Request example

        The request example is as follows:

        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"
        }'
        Shell

        Response

        This section describes the response format.

        Response body

        The response body includes the following data:

        FieldTypeRequiredDescription
        pageIndexInteger-Page number
        pageSizeInteger-Page output count
        itemCountInteger-Number of response results
        hasMoreBoolean-Whether additional pages exist
        • true | false
          • true: It exists
          • false: It doesn't exist
        itemsArray-Response result

        items

        The following describes items.

        FieldTypeRequiredDescription
        nrnString-NAVER Cloud Platform resource identification value
        platformTypeString-Platform type
        • BOTH | VPC | Classic
          • BOTH: common platform environment
          • VPC: VPC environment
          • Classic: Classic environment
        productNameString-Service code of the resource
        productDisplayNameString-Service name of the resource
        regionCodeString-Region code of the resource
        regionDispalyNameString-Region name of the resource
        resourceTypeString-Resource type
        resourceIdString-Resource ID
        resourceNameString-Resource name
        createTimeInteger-Resource creation date and time (millisecond)
        • Unix timestamp format
        eventTimeInteger-Resource change date and time (millisecond)
        • Unix timestamp format
        tagArray-Resource tag information
        • Display upon query of a specific resource
        groupArray-Resource group name
        • Display upon query of a specific resource

        Response status codes

        For information about the HTTP status codes common to all Resource Manager APIs, see Resource Manager response status codes.

        Response example

        The response example is as follows:

        {
            "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"
                    ]
                }
            ]
        }
        JSON

        Was this article helpful?

        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.