Lists resource records by offset and size.
Try it now
Test
RAM authorization
Request syntax
GET /resources/{resourceName}/records HTTP/1.1Path Parameters
|
Parameter |
Type |
Required |
Description |
Example |
| resourceName |
string |
Yes |
The resource name. |
sls.alert.user |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| offset |
integer |
No |
The start position of the query. |
0 |
| size |
integer |
No |
The maximum number of records to return. Valid values: 1 to 200. |
100 |
| tag |
string |
No |
Filters records by label. |
production |
| ids |
string |
No |
Filters records by ID. Separate multiple IDs with commas (,). A maximum of 200 IDs are supported. |
record-001,record-002 |
| search |
string |
No |
Searches for the specified string in record content. |
example |
| sjson |
string |
No |
Searches by JSON content. |
status |
| jsonPath |
string |
No |
The JSON field path. Use this parameter together with jsonPathValue. |
$.status |
| jsonPathValue |
string |
No |
The filter value of the JSON field. Use this parameter together with jsonPath. |
enabled |
| includeSystemRecords |
boolean |
No |
Specifies whether to include system built-in records. |
false |
| jsonFilterAcc |
boolean |
No |
Specifies whether to enable JSON filter acceleration. |
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response struct. |
||
| count |
integer |
The number of records returned. |
100 |
| total |
integer |
The total number of records that match the specified conditions. |
245 |
| items |
array |
The list of resource records. |
|
| ResourceRecord |
The resource record struct. |
Examples
Success response
JSON format
{
"count": 100,
"total": 245,
"items": [
{
"id": "record-001",
"tag": "production",
"value": "{\"key\":\"value\"}",
"createTime": 1787800000,
"lastModifyTime": 1787803600
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.