GetResourceList
- Print
- PDF
GetResourceList
- Print
- PDF
Article Summary
Share feedback
Thanks for sharing your feedback!
- 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"
}
Parameter | Requirement status | Type | Restrictions | Description |
---|---|---|---|---|
nrn | N | string | You can search only a single item (1 case) when requesting through nrn | |
regionCode | N | string | ||
productName | N | string | ||
resourceType | N | string | ||
resourceName | N | string | ||
resourceId | N | string | ||
tag | N | array of object | ||
- tagKey | N | string | Required when using tag search conditions | |
- tagValue | N | string | ||
groupName | N | string | ||
pageIndex | N | integer | default: 0, starting from 0 | |
pageSize | N | integer | default: 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"
}
Item | Type | Description | Remarks |
---|---|---|---|
items | array of object | ||
- nrn | string | ||
- platformType | string | ||
- productName | string | ||
- productDisplayName | string | ||
- regionCode | string | ||
- regionDispalyName | string | ||
- resourceType | string | ||
- resourceId | string | ||
- resourceName | string | ||
- createTime | integer | ||
- eventTime | integer | ||
- tag | array of object | Displayed only when searching for a single item through nrn | |
-- tagKey | string | ||
-- tagValue | string | ||
- group | array of string | Displayed only when searching for a single item through nrn | |
pageIndex | integer | ||
pageSize | integer | ||
hasMore | boolean |
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 code | message |
---|---|
400 | 'tagKey' cannot be empty when using 'tag' parameter. |
Was this article helpful?