更新时间:2025-07-23 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"
  }
}

响应示例

状态码:200

请求下发成功。

{
  "job_id" : "2c9080d08cc99d28018ccd139e942498"
}

SDK代码示例

SDK代码示例如下。

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
package com.huaweicloud.sdk.test;

import com.huaweicloud.sdk.core.auth.ICredential;
import com.huaweicloud.sdk.core.auth.BasicCredentials;
import com.huaweicloud.sdk.core.exception.ConnectionException;
import com.huaweicloud.sdk.core.exception.RequestTimeoutException;
import com.huaweicloud.sdk.core.exception.ServiceResponseException;
import com.huaweicloud.sdk.dws.v2.region.DwsRegion;
import com.huaweicloud.sdk.dws.v2.*;
import com.huaweicloud.sdk.dws.v2.model.*;


public class EncryptClusterSolution {

    public static void main(String[] args) {
        // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
        // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
        String ak = System.getenv("CLOUD_SDK_AK");
        String sk = System.getenv("CLOUD_SDK_SK");
        String projectId = "{project_id}";

        ICredential auth = new BasicCredentials()
                .withProjectId(projectId)
                .withAk(ak)
                .withSk(sk);

        DwsClient client = DwsClient.newBuilder()
                .withCredential(auth)
                .withRegion(DwsRegion.valueOf("<YOUR REGION>"))
                .build();
        EncryptClusterRequest request = new EncryptClusterRequest();
        request.withClusterId("{cluster_id}");
        EncryptClusterReq body = new EncryptClusterReq();
        EncryptCluster encryptbody = new EncryptCluster();
        encryptbody.withMasterKeyId("0f3196c8-5c23-469f-84da-92ecd2499dce")
            .withMasterKeyName("KMS-1abd-1016")
            .withCryptAlgorithm("generalCipher");
        body.withEncrypt(encryptbody);
        request.withBody(body);
        try {
            EncryptClusterResponse response = client.encryptCluster(request);
            System.out.println(response.toString());
        } catch (ConnectionException e) {
            e.printStackTrace();
        } catch (RequestTimeoutException e) {
            e.printStackTrace();
        } catch (ServiceResponseException e) {
            e.printStackTrace();
            System.out.println(e.getHttpStatusCode());
            System.out.println(e.getRequestId());
            System.out.println(e.getErrorCode());
            System.out.println(e.getErrorMsg());
        }
    }
}

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkdws.v2.region.dws_region import DwsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkdws.v2 import *

if __name__ == "__main__":
    # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak = os.environ["CLOUD_SDK_AK"]
    sk = os.environ["CLOUD_SDK_SK"]
    projectId = "{project_id}"

    credentials = BasicCredentials(ak, sk, projectId)

    client = DwsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(DwsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = EncryptClusterRequest()
        request.cluster_id = "{cluster_id}"
        encryptbody = EncryptCluster(
            master_key_id="0f3196c8-5c23-469f-84da-92ecd2499dce",
            master_key_name="KMS-1abd-1016",
            crypt_algorithm="generalCipher"
        )
        request.body = EncryptClusterReq(
            encrypt=encryptbody
        )
        response = client.encrypt_cluster(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    dws "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/dws/v2/region"
)

func main() {
    // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security.
    // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment
    ak := os.Getenv("CLOUD_SDK_AK")
    sk := os.Getenv("CLOUD_SDK_SK")
    projectId := "{project_id}"

    auth := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        Build()

    client := dws.NewDwsClient(
        dws.DwsClientBuilder().
            WithRegion(region.ValueOf("<YOUR REGION>")).
            WithCredential(auth).
            Build())

    request := &model.EncryptClusterRequest{}
	request.ClusterId = "{cluster_id}"
	masterKeyNameEncrypt:= "KMS-1abd-1016"
	encryptbody := &model.EncryptCluster{
		MasterKeyId: "0f3196c8-5c23-469f-84da-92ecd2499dce",
		MasterKeyName: &masterKeyNameEncrypt,
		CryptAlgorithm: "generalCipher",
	}
	request.Body = &model.EncryptClusterReq{
		Encrypt: encryptbody,
	}
	response, err := client.EncryptCluster(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。

状态码

状态码

描述

200

请求下发成功。

400

请求错误。

401

鉴权失败。

403

没有操作权限。

404

找不到资源。

500

服务内部错误。

503

服务不可用。

相关文档