手动把表挂载到指定业务目录,用于修正错误的目录挂载;Replace=true 时先解绑该表其它已有目录关系(改挂)
接口说明
手动把表挂载到指定业务目录,用于修正错误的目录挂载;单挂载语义(挂新目录会自动解绑旧目录),只能挂到叶子目录;不传 CategoryId 与 CategoryPath 时退化为纯解绑
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST / HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DbId |
string |
是 |
数据库 ID,可以调用 ListDatabases 接口获取。 |
1*** |
| Tid |
integer |
否 |
租户 ID。 说明
取自系统右上角头像处悬停展示的租户 ID 信息,详情请参见查看租户信息。 |
3*** |
| TableName |
string |
是 |
表名 |
order_info |
| CategoryId |
integer |
否 |
目标叶子目录 ID,与 CategoryPath 二选一(优先生效),可通过 ListAssetCategories 查询;与 CategoryPath 都不传时仅解绑该表现有目录 |
123 |
| CategoryPath |
string |
否 |
目标目录路径(层级用 / 分隔),逐层定位已有目录,最深 4 层;最终目录必须是叶子目录 |
业务域/交易/订单 |
| ParentCategoryId |
integer |
否 |
CategoryPath 的起始父目录 ID,留空表示从根目录开始 |
100 |
| CreateMissingCategory |
boolean |
否 |
CategoryPath 对应目录不存在时是否逐层创建,默认 false 直接报 404,避免误传路径凭空造目录 |
false |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
返回内容 |
||
| RequestId |
string |
Id of the request |
0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931 |
| ErrorCode |
string |
错误码。 |
UnknownError |
| ErrorMessage |
string |
错误信息。 |
UnknownError |
| Success |
boolean |
请求是否成功,返回值如下:
|
true |
| Data |
object |
挂载结果 |
|
| TableId |
integer |
表 ID |
1760934XXX |
| CategoryId |
integer |
最终挂载到的目录 ID;纯解绑(不传目录参数)时为空 |
FC-0F46B2A2E4FA22AF |
| NewlyMounted |
boolean |
是否新建了挂载关系,false 表示表与目标目录的关系已存在 |
|
| RemovedCategoryIds |
array |
本次被解绑的原目录 ID 列表(单挂载语义下挂新目录会自动解绑旧目录) |
|
|
integer |
本次被解绑的原目录 ID |
123 |
示例
正常返回示例
JSON格式
{
"RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
"ErrorCode": "UnknownError",
"ErrorMessage": "UnknownError",
"Success": true,
"Data": {
"TableId": 0,
"CategoryId": 0,
"NewlyMounted": true,
"RemovedCategoryIds": [
123
]
}
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。