All Products
Search
Document Center

Data Management:SearchTable

Last Updated:Mar 14, 2024

Queries detailed information about tables.

Operation description

You can call this operation only for database instances that are managed in Security Collaboration mode.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dms:SearchTableRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

The ID of the tenant.

Note To view the tenant ID, move the pointer over the profile picture in the upper-right corner of the Data Management (DMS) console. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.
1
SearchKeystringNo

The keyword that is used to query tables.

test
PageNumberintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

10
EnvTypestringNo

The type of the environment to which databases belong. For more information, see Change the environment type of an instance.

PRODUCT
SearchRangestringNo

The scope of tables that you want to query. Valid values:

  • HAS_PERMSSION: the tables on which the current account has permissions.
  • OWNER: the tables owned by the current account.
  • MY_FOCUS: the tables that the current account follows.
  • UNKNOWN: all tables.
OWNER
SearchTargetstringNo

The type of table that you want to query. Valid values:

  • TABLE: physical and logical tables
  • SINGLE_TABLE: physical tables
  • LOGIC_TABLE: logical tables
LOGIC_TABLE
DbTypestringNo

The type of database. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
MySQL
ReturnGuidbooleanNo

Specifies whether to return the GUID of each table.

false

Response parameters

ParameterTypeDescriptionExample
object
SearchTableListobject []

The details of the tables.

DatabaseIdstring

The ID of the database to which the table belongs.

1
TableNamestring

The name of the table.

test_table
DBSearchNamestring

The name that is used to search for the database to which the table belongs.

test
Logicboolean

Indicates whether the table is a logical table. Valid values:

  • true: The table is a logical table.
  • false: The table is not a logical table.
false
EnvTypestring

The type of the environment to which the database belongs.

test
DbNamestring

The name of the database.

test
OwnerIdListarray

The IDs of the table owners.

string

The ID of the table owner.

1
Descriptionstring

The description of the table.

test
Encodingstring

The encoding format of the table.

utf8
DbTypestring

The type of the database. Valid values:

  • MySQL
  • SQLServer
  • PostgreSQL
  • Oracle
  • DRDS
  • OceanBase
  • Mongo
  • Redis
mysql
OwnerNameListarray

The nicknames of the table owners.

string

The nickname of the table owner.

user
TableSchemaNamestring

The name of the database to which the table belongs.

test@xxx.xxx.xxx.xxx:3306
TableGuidstring

The GUID of the table.

IDB_L_9032.db-test.yuyang_test
Enginestring

The engine of the table.

innodb
TableIdstring

The ID of the table.

1
TotalCountlong

The total number of entries that are returned.

1
RequestIdstring

The ID of the request.

1489257F-1B5D-4B5B-89EF-923C12CEEBD1
ErrorCodestring

The error code returned if the request failed.

UnknownError
ErrorMessagestring

The error message returned if the request failed.

UnknownError
Successboolean

Indicates whether the request was successful.

true

Examples

Sample success responses

JSONformat

{
  "SearchTableList": {
    "SearchTable": [
      {
        "DatabaseId": "1",
        "TableName": "test_table",
        "DBSearchName": "test",
        "Logic": false,
        "EnvType": "test",
        "DbName": "test",
        "OwnerIdList": {
          "OwnerIds": [
            "1"
          ]
        },
        "Description": "test",
        "Encoding": "utf8",
        "DbType": "mysql",
        "OwnerNameList": {
          "OwnerNames": [
            "user"
          ]
        },
        "TableSchemaName": "test@xxx.xxx.xxx.xxx:3306",
        "TableGuid": "IDB_L_9032.db-test.yuyang_test",
        "Engine": "innodb",
        "TableId": "1"
      }
    ]
  },
  "TotalCount": 1,
  "RequestId": "1489257F-1B5D-4B5B-89EF-923C12CEEBD1",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history