GetGroupList
- Print
- PDF
GetGroupList
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
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:
Method | URI |
---|---|
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:
Field | Type | Required | Description |
---|---|---|---|
groupName | String | Optional | Resource group name |
pageIndex | Integer | Optional | Page number
|
pageSize | Integer | Optional | Page output count
|
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'
Response
This section describes the response format.
Response body
The response body includes the following data:
Field | Type | Required | Description |
---|---|---|---|
pageIndex | Integer | - | Page number |
pageSize | Integer | - | Page output count |
itemCount | Integer | - | Number of response results |
hasMore | Boolean | - | Whether additional pages exist
|
items | Array | - | Response result |
error | Object | - | Error code and message
|
error.errorCode | Integer | - | Error code |
error.message | String | - | Error message |
error.details | String | - | Error message description |
items
The following describes items
.
Field | Type | Required | Description |
---|---|---|---|
groupId | String | - | Resource group ID |
groupName | String | - | Resource group name |
groupDesc | String | - | Resource group description |
createTime | Integer | - | Resource group creation date and time |
updateTime | Integer | - | 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
}
]
}
Was this article helpful?