ClearCategoryMountedTables - 清理指定目录下的所有表

更新时间:
复制 MD 格式

清理指定一级业务目录下挂载的所有表

接口说明

清理指定业务目录下挂载的所有表,目录结构保持不变。目录层级不限(L1~L4 均可),以该目录为根递归覆盖其全部子孙目录,仅解除表与目录的挂载关系,不删除任何目录。DryRun=true 时只返回受影响统计不实际清理。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST / HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

CategoryId

integer

待清理的业务目录 ID,层级不限;仅解除其下(含全部子孙目录)所有表的挂载关系,目录本身及层级结构不变;目录不存在返回 404

20

DryRun

boolean

是否仅预演:true 时只统计将被清理的挂载关系数与表数,不实际删除;默认 false

false

返回参数

名称

类型

描述

示例值

object

返回内容

RequestId

string

Id of the request

0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931

ErrorCode

string

错误码。

UnknownError

ErrorMessage

string

错误信息。

UnknownError

Success

boolean

请求是否成功,返回值如下:

  • true:请求成功

  • false:请求失败

true

Data

object

清理结果

CategoryId

integer

被清理的业务目录 ID

FC-0F46B2A2E4FA22AF

CategoryName

string

被清理的业务目录名称

xxx

ScannedCategoryCount

integer

本次扫描到的目录数(含该目录自身与全部子孙目录)

1

ClearedRelationCount

integer

解除的挂载关系行数;DryRun=true 时为将会解除的行数

1

ClearedTableCount

integer

去重后受影响的表数

1

ClearedTableIds

array

受影响的表 ID 样例,最多返回 200 个

integer

表 ID

1

DryRun

boolean

是否为预演模式

True

示例

正常返回示例

JSON格式

{
  "RequestId": "0C1CB646-1DE4-4AD0-B4A4-7D47DD52E931",
  "ErrorCode": "UnknownError",
  "ErrorMessage": "UnknownError",
  "Success": true,
  "Data": {
    "CategoryId": 0,
    "CategoryName": "xxx",
    "ScannedCategoryCount": 1,
    "ClearedRelationCount": 1,
    "ClearedTableCount": 1,
    "ClearedTableIds": [
      1
    ],
    "DryRun": true
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情