更新时间：2025-12-10 GMT+08:00

转加密集群

功能介绍

转加密集群。

约束限制：

转加密集群起始支持版本：8.0.0

转加密集群guestAgent起始支持版本：8.3.0.200

调用方法

请参见如何调用API。

URI

POST /v2/{project_id}/clusters/{cluster_id}/encrypt

表1 路径参数
参数	是否必选	参数类型	描述
project_id	是	String	参数解释：项目ID。获取方法请参见获取项目ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
cluster_id	是	String	参数解释：集群ID。获取方法请参见获取集群ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。

请求参数

表2 请求Body参数
参数	是否必选	参数类型	描述
encrypt	否	EncryptCluster object	参数解释：转加密集群请求信息。取值范围：不涉及。

表3 EncryptCluster
参数	是否必选	参数类型	描述
master_key_id	是	String	参数解释： KMS密钥ID。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
master_key_name	否	String	参数解释： KMS密钥名称。约束限制：不涉及。取值范围：不涉及。默认取值：不涉及。
crypt_algorithm	是	String	参数解释：加密类型。国密、国际加密。约束限制：不涉及。取值范围： generalCipher：AES-CBC算法加密。 SMcompatible：sm4算法加密。默认取值：不涉及。

响应参数

状态码：200

表4 响应Body参数
参数	参数类型	描述
error_code	String	参数解释：错误码。取值范围：不涉及。
error_msg	String	参数解释：错误信息。取值范围：不涉及。
job_id	String	参数解释：任务ID，可用于查询任务进度信息。取值范围：不涉及。

请求示例

使用名称为KMS-1abd-1016的kms密钥，并且使用默认的国际加密算法，把dws集群转为加密集群。

POST https://{endpoint}/v2/89cd04f168b84af6be287f71730fdb4b/clusters/97cbaab3-939e-4dbc-9187-0fe240f2b9fd/encrypt

{
  "encrypt" : {
    "crypt_algorithm" : "generalCipher",
    "master_key_id" : "0f3196c8-5c23-469f-84da-92ecd2499dce",
    "master_key_name" : "KMS-1abd-1016"
  }
}

响应示例