更新时间:2025-06-26 GMT+08:00
分享

删除关键字目录

功能介绍

删除关键字目录

调用方法

请参见如何调用API

URI

DELETE /v3/{project_id}/basic-aw/cata/{id}

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释

项目UUID,项目唯一标识,固定长度32位字符(字母和数字)。获取方式请参见获取项目唯一标识

约束限制

不涉及

取值范围

32个字符组成的字符串

默认取值

不涉及

id

String

目录唯一标识

表2 Query参数

参数

是否必选

参数类型

描述

is_delete_children

Boolean

是否删除文件下关键字

默认取值:

false

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

约束限制:

必传。

取值范围:

字符串长度不少于1,不超过10万。

默认取值:

不涉及。

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

error

CommonResponseErrorOfobject object

统一错误返回

reason

String

错误原因

result

Object

结果

status

String

状态值,如success、error

表5 CommonResponseErrorOfobject

参数

参数类型

描述

code

String

错误码

reason

String

错误原因

状态码:401

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:403

表7 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:404

表8 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

状态码:500

表9 响应Body参数

参数

参数类型

描述

error_code

String

参数解释

接口调用失败错误码

取值范围

12-18个字符组成的字符串

error_msg

String

参数解释

接口调用失败错误信息

取值范围

3-1000个字符组成的字符串

请求示例

delete https://{endpoint}/v3/5a20b8323f3548008bd6e5669567538f/basic-aw/cata/111?is_delete_children=true

响应示例

状态码:200

SUCCESS

{
  "status" : "success",
  "result" : "success",
  "reason" : null,
  "error" : null,
  "code" : null
}

状态码

状态码

描述

200

SUCCESS

401

Unauthorized

403

Forbidden

404

Not Found

500

ERROR

错误码

请参见错误码

相关文档