Obtains
Debugging
Authorization information
There is currently no authorization information disclosed in the API.
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Tid | long | No | The ID of the tenant. Note
To view the ID of the tenant, go to the Data Management (DMS) console and move the pointer over the profile picture in the upper-right corner. For more information, see the View information about the current tenant section of the "Manage DMS tenants" topic.
| 3*** |
| UserId | string | Yes | The ID of the user. | 1*** |
| DatabaseName | string | No | The database name. | db_name |
| OwnerType | string | Yes | The type of the owner. Valid values:
| INSTANCE |
| Logic | boolean | No | Specifies whether the database is a logical database. Valid values:
| false |
| EnvType | string | No | The type of the environment in which the database instance is deployed. Valid values:
| product |
| DbType | string | No | The type of the database instance. For more information about the valid values of this parameter, see DbType parameter. | MYSQL |
| PageNumber | integer | No | The page number. | 1 |
| PageSize | integer | No | The number of entries to return on each page. | 10 |
Response parameters
Examples
Sample success responses
JSONformat
{
"TotalCount": 1,
"RequestId": "8E88933E-E3D4-5BA8-8CBF-0A1CAE666690",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Data": {
"resourceList": [
{
"InstanceId": 291594,
"DbId": 29697059,
"SchemaName": "as_task_engine",
"Logic": false,
"SearchName": "dtstest [dtstest_dms]",
"TableName": "addepmap",
"EnvType": "product",
"DbType": "MySQL",
"TableId": 1760934555,
"Alias": "DMS_GYX_TESTupdata",
"Host": "rm-wz98bw60x1i1303c5.mysql.rds.aliyuncs.com",
"Port": 6379,
"DbInstanceId": "876XXX"
}
]
},
"Success": true
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-10-30 | Add Operation | View Change Details |
