Query table list
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| NextToken |
string |
No |
Pagination token |
0 |
| Limit |
integer |
No |
Items per page |
10 |
| Catalog |
string |
No |
Data catalog |
my_catalog |
| Namespace |
string |
No |
Namespace |
my_namespace |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
|||
| Message |
string |
API response message |
Operation success |
| RequestId |
string |
Request ID |
34AD682D-5B91-5773-8132-AA38C130**** |
| Data |
object |
Response data |
{"Tables":[{"Name":"my_table","Comment":"测试事件表"}],"NextToken":"10","Total":1} |
| Tables |
array |
Table entities. Each element represents a specific table, including but not limited to information such as table name and table ID. |
|
| Table |
Table entities. Each element represents a specific table, including but not limited to information such as table name and table ID. |
||
| NextToken |
string |
Next page token |
10 |
| Total |
integer |
Total count |
1 |
| Code |
string |
Response code |
200 |
| Success |
boolean |
Whether successful |
true |
Examples
Success response
JSON format
{
"Message": "Operation success",
"RequestId": "34AD682D-5B91-5773-8132-AA38C130****",
"Data": {
"Tables": [
{
"Catalog": "my_catalog",
"Namespace": "my_namespace",
"Name": "my_table",
"Comment": "测试事件表",
"CreateTime": 1717948800000,
"UpdateTime": 1717948800000,
"RetentionPolicy": {
"HotTTL": 7,
"ColdTTL": 30
},
"Columns": [
{
"Name": "id",
"Type": "bigint",
"Comment": "主键ID"
}
]
}
],
"NextToken": "10",
"Total": 1
},
"Code": "200",
"Success": true
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 403 | ServiceNotEnable | Service not enable |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.