Lists the mounted table assets under a business catalog along with the current catalog mount paths.
Operation description
Lists the mounted table assets under a business catalog along with the current catalog mount paths.
Try it now
Test
RAM authorization
Request syntax
POST / HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Tid |
integer |
No |
The tenant ID. Note
Move the pointer over the profile picture in the upper-right corner of the console to view the tenant ID. For more information, see View tenant information. |
10**** |
| CategoryId |
integer |
Yes |
The business catalog ID. Typically set to L1. The query recursively includes mounted tables from all descendant directories. |
20 |
| DbId |
integer |
No |
The database ID. This parameter is optional and used to filter results by database. |
66317185 |
| Offset |
integer |
No |
The pagination offset. Default value: 0. |
0 |
| Size |
integer |
No |
The number of entries per page. Default value: 100. Maximum value: 500. |
100 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response content. |
||
| RequestId |
string |
Id of the request |
0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
| ErrorCode |
string |
The error code. |
UnknownError |
| ErrorMessage |
string |
The error message. |
UnknownError |
| Success |
boolean |
Indicates whether the request was successful. Valid values:
|
true |
| TotalCount |
integer |
The total number of tables that match the conditions. |
12 |
| Data |
array<object> |
The list of mounted tables under the catalog, including the current mount paths. |
|
|
object |
The returned data. |
||
| TableId |
integer |
The table ID. |
1760934XXX |
| TableName |
string |
The table name. |
tab_add_teacher_record |
| DbId |
integer |
The database ID. |
29697XXX |
| InstanceId |
integer |
The instance ID. |
291XXX |
| InstanceName |
string |
The instance alias. |
ros-fvt-pre-821ce |
| SchemaName |
string |
The schema name. |
as_task_engine |
| DbName |
string |
The database name. |
fruit_shop |
| Description |
string |
The table description. |
Test |
| CategoryId |
integer |
The ID of the current mount directory. |
FC-0F46B2A2E4FA22AF |
| CategoryName |
string |
The name of the current mount directory. |
xxx |
| CategoryPath |
string |
The full path from the directory tree root to the current mount directory, such as CTO Division/Supply Chain/Inventory Management. |
CTO/Data |
| CategoryDepth |
integer |
The depth of the current mount directory. |
1 |
Examples
Success response
JSON format
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"TotalCount": 12,
"Data": [
{
"TableId": 0,
"TableName": "tab_add_teacher_record",
"DbId": 0,
"InstanceId": 0,
"InstanceName": "ros-fvt-pre-821ce",
"SchemaName": "as_task_engine",
"DbName": "fruit_shop",
"Description": "Test",
"CategoryId": 0,
"CategoryName": "xxx",
"CategoryPath": "CTO/Data ",
"CategoryDepth": 1
}
]
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.