文档首页/代码托管 CodeArts Repo/API参考/API/V4/Tenant/修改当前租户的仓库加密配置 - UpdateTenantRepoEncryptionSetting
更新时间：2026-04-07 GMT+08:00
在线调试
CLI示例
查看PDF
分享

修改当前租户的仓库加密配置 - UpdateTenantRepoEncryptionSetting

功能介绍

修改当前租户的仓库加密配置

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

授权信息

当前API调用无需身份策略权限。

URI

PUT /v4/tenants/{tenant_id}/repo-encryption/setting

表1 路径参数

参数

是否必选

参数类型

描述

tenant_id

是

String

参数解释：

租户id

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

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

约束限制：

不涉及。

取值范围：

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

默认取值：

不涉及。

表3 请求Body参数

参数

是否必选

参数类型

描述

tenant_id

否

String

参数解释：

租户id。

取值范围：

字符串长度不少于1，不超过1000。

encryption_type

否

String

参数解释：

加密类型。

取值范围：

KMS 表示开启KMS加密，normal或者表示未开启KMS加密。

default_encryption_enabled

否

Boolean

参数解释：

是否开启租户下默认加密设置。

cmk_key_name

否

String

参数解释：

加密主密钥的名称。

取值范围：

字符串长度不少于1，不超过1000。

cmk_key_id

否

String

参数解释：

加密主密钥的id。

取值范围：

字符串长度不少于1，不超过1000。

响应参数

状态码：200

表4 响应Body参数

参数

参数类型

描述

tenant_id

String

参数解释：

租户id。

取值范围：

字符串长度不少于1，不超过1000。

encryption_type

String

参数解释：

加密类型。

取值范围：

KMS 表示开启KMS加密，normal或者表示未开启KMS加密。

default_encryption_enabled

Boolean

参数解释：

是否开启租户下默认加密设置。

cmk_key_name

String

参数解释：

加密主密钥的名称。

取值范围：

字符串长度不少于1，不超过1000。

cmk_key_id

String

参数解释：

加密主密钥的id。

取值范围：

字符串长度不少于1，不超过1000。

id

Integer

参数解释：

记录id。

取值范围：

1~2147483647

key_state

Integer

参数解释：

加密主密钥key的状态。

取值范围：

1表示待激活状态,2 表示启用状态,3 表示禁用状态,4 表示计划删除状态,5 表示等待导入状态。

region

String

参数解释：

当前region 。

取值范围：

字符串长度不少于1，不超过1000。

region_type

String

参数解释：

region类型。

取值范围：

字符串长度不少于1，不超过1000。

状态码：401

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释：

错误码。

error_msg

String

参数解释：

错误信息。

请求示例

PUT https://{endpoint}/v4/tenants/{tenant_id}/repo-encryption/setting

{
  "cmk_key_id" : "7308c1b8-557f-453a-aef7-28643f49cf1e",
  "cmk_key_name" : "test111",
  "default_encryption_enabled" : true,
  "encryption_type" : "KMS",
  "tenant_id" : "159b65b41ead484d8ddff250a4731781"
}

响应示例

状态码：200

OK

{
  "id" : 8,
  "tenant_id" : "159b65b41ead484d8ddff250a4731781",
  "encryption_type" : "KMS",
  "default_encryption_enabled" : false,
  "cmk_key_name" : "test111",
  "cmk_key_id" : "7308c1b8-557f-453a-aef7-28643f49cf1e",
  "key_state" : 2,
  "region" : "cn-north-7",
  "region_type" : "primary"
}

状态码：401

Unauthorized

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

状态码

状态码

描述

200

OK

401

Unauthorized

错误码

请参见错误码。

父主题：Tenant

相关文档