MENU
      GetGroupList

        GetGroupList


        Article summary

        Available in Classic and VPC

        Get the list of resource groups.

        Request

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

        MethodURI
        GET/api/v1/groups

        Request headers

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

        Request query parameters

        You can use the following query parameters with your request:

        FieldTypeRequiredDescription
        groupNameStringOptionalResource group name
        pageIndexIntegerOptionalPage number
        • 0 - N (default: 0)
        pageSizeIntegerOptionalPage output count
        • 1 - 100 (default: 20)

        Request example

        The request example is as follows:

        curl --location --request GET 'https://resourcemanager.apigw.ntruss.com/api/v1/groups' \
        --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'
        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
        errorObject-Error code and message
        • Display upon response failure
        error.errorCodeInteger-Error code
        error.messageString-Error message
        error.detailsString-Error message description

        items

        The following describes items.

        FieldTypeRequiredDescription
        groupIdString-Resource group ID
        groupNameString-Resource group name
        groupDescString-Resource group description
        createTimeInteger-Resource group creation date and time
        updateTimeInteger-Resource group last modification date and time

        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": 2,
            "hasMore": false,
            "items": [
                {
                    "groupId": "821ad7869d494b298aa9a13b",
                    "groupName": "testgroup_01",
                    "groupDesc": "test",
                    "createTime": 1727441443000,
                    "updateTime": 1727441443000
                },
                {
                    "groupId": "64f077df093f6a0838604299",
                    "groupName": "testgroup_02",
                    "groupDesc": "",
                    "createTime": 1693480928000,
                    "updateTime": 1693480928000
                }
            ]
        }
        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.