文档首页/ 代码检查 CodeArts Check/ API参考/ API/ 任务管理/ 删除租户配置 - DeleteTenantConfig
更新时间:2026-07-13 GMT+08:00

删除租户配置 - DeleteTenantConfig

功能介绍

删除租户配置。

调用方法

请参见如何调用API

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

codeartscheck::updateConfig

Write

-

-

-

-

URI

DELETE /v1/tenant-configs/{id}

表1 路径参数

参数

是否必选

参数类型

描述

id

String

参数解释:

租户配置的ID。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及。

取值范围:

长度为[1~100000]的字符。

默认取值:

不涉及。

Content-Type

String

参数解释:

编码格式。

约束限制:

不涉及。

取值范围:

不涉及。

默认取值:

application/json,传任何值,接口返回值均为json格式。

响应参数

状态码:200

表3 响应Body参数

参数

参数类型

描述

result

String

参数解释:

删除租户配置结果。如果成功则为null。

取值范围:

不涉及。

状态码:400

表4 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

状态码:401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码。

取值范围:

不涉及。

error_msg

String

参数解释:

错误描述。

取值范围:

不涉及。

请求示例

删除系统配置ID为bbcc56db34b149f0a15bd106dc3ae5b5的系统配置。

DELETE https://{endpoint}/v1/tenant-configs/bbcc56db34b149f0a15bd106dc3ae5b5

响应示例

状态码:200

删除租户配置成功

{
  "result" : "delete success"
}

状态码:400

请求异常。

{
  "error_code" : "CC.xxxxxxxx.400",
  "error_msg" : "请求参数校验失败,请检查请求参数是否正确"
}

状态码:401

权限不足。

{
  "error_code" : "CC.00000003",
  "error_msg" : "认证信息过期"
}

状态码

状态码

描述

200

删除租户配置成功

400

请求异常。

401

权限不足。

错误码

请参见错误码