调用GetTableTopology获取数据表的拓扑信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用全部资源表示。
 
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 | 
|---|---|---|---|---|
| dms:GetTableTopology | get | *全部资源 * | 
 | 无 | 
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 | 
|---|---|---|---|---|
| TableGuid | string | 是 | 表在 DMS 中的唯一识别码 GUID(Globally Unique Identifier)。 说明 
 | IDB_L_308302.yuyang_test.test_ch | 
| Tid | long | 否 | 租户 ID。 说明 
取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。
 | 3*** | 
返回参数
示例
正常返回示例
JSON格式
{
  "RequestId": "F5ED6A40-F344-4C7D-A8F0-5685CA584CA7",
  "Success": true,
  "ErrorMessage": "UnknownError",
  "ErrorCode": "UnknownError",
  "TableTopology": {
    "TableGuid": "IDB_L_308302.yuyang_test.test_ch",
    "TableName": "test_ch",
    "TableTopologyInfoList": [
      {
        "TableNameList": "test_ch_0000,test_ch_0001,test_ch_0002,test_ch_0003,test_ch_0004,test_ch_0005",
        "TableNameExpr": "test_ch_[0000-0005]",
        "TableCount": 6,
        "DbId": 43215,
        "DbSearchName": "yuyang_test@localhost:3306[yuyang_test_dev]",
        "InstanceId": 4325325,
        "RegionId": "cn-hangzhou",
        "InstanceResourceId": "rm-xxx",
        "InstanceSource": "RDS",
        "DbName": "yuyang_test",
        "DbType": "mysql"
      }
    ],
    "Logic": true
  }
}错误码
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 | 
|---|
暂无变更历史
