调用GetTableDBTopology接口获取数据表的拓扑图。
目前仅支持逻辑库实例调用该API。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | GetTableDBTopology |
系统规定参数。取值:GetTableDBTopology。 |
TableGuid | String | 是 | IDB_L_9032.db-test.yuyang_test |
表在DMS中的唯一识别码GUID(Globally Unique Identifier)。 说明
|
Tid | Long | 否 | 123 |
租户ID。 说明 取自系统右上角头像处悬停展示的租户ID信息,详情请参见查看租户信息。
|
RegionId | String | 否 | cn-hangzhou |
选择DMS的服务地域,用于调用该接口,取值请参见RegionID参数说明。 说明 请根据应用所在地就近选择。
|
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
DBTopology | Struct |
DB拓扑信息。 |
|
DataSourceList | Array of DataSource |
数据源列表。 |
|
DatabaseList | Array of Database |
物理分库列表。 |
|
DbId | String | 489347 |
库ID。 |
DbName | String | db-test |
物理库库名。 |
DbType | String | mysql |
数据库类型,取值请参考dbType参数说明。 |
EnvType | String | pre |
环境类型,取值和说明如下:
说明 更多信息,请参见实例环境说明。
|
TableList | Array of Table |
物理分表列表。 |
|
TableId | String | 151977812 |
表ID。 |
TableName | String | yuyang_test_0000 |
物理表表名。 |
TableType | String | NORMAL |
表类型,保留字段。 |
DbType | String | mysql |
数据库类型,取值请参考dbType参数说明。 |
Host | String | xxx.mysql.polardb.rds.aliyuncs.com |
数据源的连接地址。 |
Port | Integer | 3306 |
数据源连接端口。 |
Sid | String | def |
数据源SID。 |
TableGuid | String | IDB_L_9032.db-test.yuyang_test |
表在DMS中的唯一识别码GUID(Globally Unique Identifier)。 |
TableName | String | yuyang_test |
表名。 说明
|
ErrorCode | String | UnknownError |
错误码。 |
ErrorMessage | String | UnknownError |
错误信息。 |
RequestId | String | 853F7FD4-D922-4EFB-931C-D253EF159E06 |
请求ID。 |
Success | Boolean | true |
请求是否成功。 |
示例
请求示例
http(s)://[Endpoint]/?Action=GetTableDBTopology
&<公共请求参数>
正常返回示例
XML
格式
<RequestId>55B7CF50-4610-4707-B2B2-5EF2BE000367</RequestId>
<DBTopology>
<TableName>yuyang_test</TableName>
<TableGuid>IDB_L_9032.db-test.yuyang_test</TableGuid>
<DataSourceList>
<DatabaseList>
<DbId>489347</DbId>
<DbName>db-test</DbName>
<TableList>
<TableId>151977811</TableId>
<TableName>yuyang_test_0000</TableName>
</TableList>
<TableList>
<TableId>151977812</TableId>
<TableName>yuyang_test_0001</TableName>
</TableList>
<TableList>
<TableId>151977813</TableId>
<TableName>yuyang_test_0002</TableName>
</TableList>
<TableList>
<TableId>151977814</TableId>
<TableName>yuyang_test_0003</TableName>
</TableList>
<TableList>
<TableId>151977815</TableId>
<TableName>yuyang_test_0004</TableName>
</TableList>
<EnvType>dev</EnvType>
<DbType>polardb</DbType>
</DatabaseList>
<Port>3306</Port>
<Host>xxx.mysql.polardb.rds.aliyuncs.com</Host>
<DbType>polardb</DbType>
</DataSourceList>
</DBTopology>
<Success>true</Success>
JSON
格式
{
"RequestId": "55B7CF50-4610-4707-B2B2-5EF2BE000367",
"DBTopology": {
"TableName": "yuyang_test",
"TableGuid": "IDB_L_9032.db-test.yuyang_test",
"DataSourceList": [
{
"DatabaseList": [
{
"DbId": 489347,
"DbName": "db-test",
"TableList": [
{
"TableId": 151977811,
"TableName": "yuyang_test_0000"
},
{
"TableId": 151977812,
"TableName": "yuyang_test_0001"
},
{
"TableId": 151977813,
"TableName": "yuyang_test_0002"
},
{
"TableId": 151977814,
"TableName": "yuyang_test_0003"
},
{
"TableId": 151977815,
"TableName": "yuyang_test_0004"
}
],
"EnvType": "dev",
"DbType": "polardb"
}
],
"Port": 3306,
"Host": "xxx.mysql.polardb.rds.aliyuncs.com",
"DbType": "polardb"
}
]
},
"Success": true
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交