View the user table collection of UDB instances - ListUDBUserTables
Overview
View all user table sets of the udb instance (only includes tables with InnoDB and MyISAM engines)
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is ListUDBUserTables . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | Region. See List of Regions and Availability Zones | Yes |
DBId | string | ID of the UDB instance | Yes |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
Tables | array[UDBDatabaseData] | Collection of User Database Tables | Yes |
Data Model
UDBDatabaseData
Field Name | Type | Description Information | Required |
---|---|---|---|
DBName | string | Database Name | Yes |
TableDataSet | array[TableData] | The collection of all tables in this library | Yes |
TableData
Field Name | Type | Description Information | Required |
---|---|---|---|
TableName | string | Table Name | Yes |
DBName | string | The name of the library to which the table belongs | Yes |
Engine | string | Table's engine (innodb, myisam) | Yes |
Example
Request Example
https://api.surfercloud.com/?Action=ListUDBUserTables
&Region=cn-zj
&DBId=VqOTzPFh
Response Example
{
"Action": "ListUDBUserTablesResponse",
"RetCode": 0,
"Tables": [
{
"DBName": "wqrPZnjX",
"TableDataSet": [
{
"DBName": "pkuKFgfr",
"Engine": "QKYqWolU",
"TableName": "xHNesJxX"
}
]
}
]
}