GetGroupList
- Print
- PDF
GetGroupList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
- Search a Group.
API
GET /api/v1/groups
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
refer to Request Headers
Request
Parameters
| Parameter | Mandatory | Type | Constraints | Description |
|---|---|---|---|---|
| groupName | N | String | Group Name | |
| pageIndex | N | integer | default: 0, starting from 0 | |
| pageSize | N | integer | default: 20, max: 100 |
Response
Response body
{
"items": [
{
"groupId": "string",
"groupName": "string",
"groupDesc": "string",
"createTime": "integer",
"updateTime": "integer"
}
],
"pageIndex": "integer",
"pageSize": "integer",
"hasMore": "boolean"
}
| Parameter | Type | Description | Comment |
|---|---|---|---|
| items | array of object | ||
| - groupId | string | ||
| - groupName | string | ||
| - groupDesc | string | ||
| - createTime | integer | ||
| - updateTime | integer | ||
| pageIndex | integer | ||
| pageSize | integer | ||
| hasMore | boolean |
Error
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 Naver Cloud Platform API.
Was this article helpful?