更新时间:2026-05-20 GMT+08:00
分享

加密数据 - EncryptData

功能介绍

  • 功能介绍:加密数据,用指定的用户主密钥加密数据。

接口约束

  • 使用非对称密钥加密数据时,请记录选择的密钥ID和加密算法。解密数据时,您将需要提供相同的密钥ID和加密算法。如果指定的密钥和加密算法与用于加密数据的值不匹配,解密操作将失败。

  • 使用对称密钥解密时,不需要提供密钥ID和加密算法,KMS会将此信息存储在密文中。KMS无法将元数据存储在使用非对称密钥生成的密文中,非对称密钥密文的标准格式不包括可配置字段。

调用方法

请参见如何调用API

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,需具备如下身份策略权限。

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    kms:cmk:encryptData

    Write

    KeyId *

    • kms:KeyOrigin

    • kms:KeySpec

    • kms:KeyUsage

    • kms:MultiRegionKeyType

    • g:EnterpriseProjectId

    • g:ResourceTag/<tag-key>

    • kms:cmk:crypto
    • kms:cmk:encrypt

    -

    -

    • kms:EncryptionAlgorithm

    • kms:RequestAlias

    • kms:ResourceAliases

    • kms:EncryptionContext

URI

POST /v1.0/{project_id}/kms/encrypt-data

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID。可参考获取项目ID获取。

约束限制:

不涉及

取值范围:

以IAM服务接口返回值为准,字符长度32-32。

默认取值:

不涉及

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

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

约束限制:

不涉及

取值范围:

IAM服务查询用户Token接口为准

默认取值:

不涉及

表3 请求Body参数

参数

是否必选

参数类型

描述

key_id

String

参数解释:

密钥ID

约束限制:

  • 36字节ID

  • 满足正则匹配“^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$”

取值范围:

不涉及

默认取值:

不涉及

plain_text

String

参数解释:

明文数据

约束限制:

  • 满足正则匹配“^.{1,4096}$”,且转化为byte数组后长度取值范围为1~4096字节

取值范围:

不涉及

默认取值:

不涉及

encryption_algorithm

String

参数解释:

数据加密算法,仅使用非对称密钥需要指定该参数

约束限制:

不涉及

取值范围:

  • SYMMETRIC_DEFAULT

  • RSAES_OAEP_SHA_256

  • SM2_ENCRYPT

默认取值:

SYMMETRIC_DEFAULT

additional_authenticated_data

String

参数解释:

身份验证的非敏感额外数据

约束限制:

长度不超过128字节

取值范围:

任意字符串

默认取值:

不涉及

sequence

String

参数解释:

请求消息序列号,36字节序列号,例如:919c82d4-8046-4722-9094-35c3c6524cff

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

key_id

String

密钥ID。

cipher_text

String

参数解释:

加密后的密文

取值范围:

不涉及

请求示例

使用ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的用户主密钥加密明文数据“hello world”,数据加密算法为"SYMMETRIC_DEFAULT",附加数据为“123aad”。

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "plain_text" : "hello world",
  "encryption_algorithm" : "SYMMETRIC_DEFAULT",
  "additional_authenticated_data" : "123aad"
}

响应示例

状态码:200

请求已成功

{
  "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
  "cipher_text" : "AgDoAG7EsEc2OHpQxz4gDFDH54CqwaelpTdEl+RFXXX..."
}

SDK代码示例

SDK代码示例如下。

使用ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的用户主密钥加密明文数据“hello world”,数据加密算法为"SYMMETRIC_DEFAULT",附加数据为“123aad”。

 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
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.kms.v2.region.KmsRegion;
import com.huaweicloud.sdk.kms.v2.*;
import com.huaweicloud.sdk.kms.v2.model.*;


public class EncryptDataSolution {

    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);

        KmsClient client = KmsClient.newBuilder()
                .withCredential(auth)
                .withRegion(KmsRegion.valueOf("<YOUR REGION>"))
                .build();
        EncryptDataRequest request = new EncryptDataRequest();
        EncryptDataRequestBody body = new EncryptDataRequestBody();
        body.withAdditionalAuthenticatedData("123aad");
        body.withEncryptionAlgorithm(EncryptDataRequestBody.EncryptionAlgorithmEnum.fromValue("SYMMETRIC_DEFAULT"));
        body.withPlainText("hello world");
        body.withKeyId("0d0466b0-e727-4d9c-b35d-f84bb474a37f");
        request.withBody(body);
        try {
            EncryptDataResponse response = client.encryptData(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());
        }
    }
}

使用ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的用户主密钥加密明文数据“hello world”,数据加密算法为"SYMMETRIC_DEFAULT",附加数据为“123aad”。

 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
# coding: utf-8

import os
from huaweicloudsdkcore.auth.credentials import BasicCredentials
from huaweicloudsdkkms.v2.region.kms_region import KmsRegion
from huaweicloudsdkcore.exceptions import exceptions
from huaweicloudsdkkms.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 = KmsClient.new_builder() \
        .with_credentials(credentials) \
        .with_region(KmsRegion.value_of("<YOUR REGION>")) \
        .build()

    try:
        request = EncryptDataRequest()
        request.body = EncryptDataRequestBody(
            additional_authenticated_data="123aad",
            encryption_algorithm="SYMMETRIC_DEFAULT",
            plain_text="hello world",
            key_id="0d0466b0-e727-4d9c-b35d-f84bb474a37f"
        )
        response = client.encrypt_data(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

使用ID为“0d0466b0-e727-4d9c-b35d-f84bb474a37f”的用户主密钥加密明文数据“hello world”,数据加密算法为"SYMMETRIC_DEFAULT",附加数据为“123aad”。

 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
56
57
package main

import (
	"fmt"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic"
    kms "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2"
	"github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/v2/model"
    region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/kms/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, err := basic.NewCredentialsBuilder().
        WithAk(ak).
        WithSk(sk).
        WithProjectId(projectId).
        SafeBuild()

    if err != nil {
        fmt.Println(err)
        return
    }

    hcClient, err := kms.KmsClientBuilder().
         WithRegion(region.ValueOf("<YOUR REGION>")).
         WithCredential(auth).
         SafeBuild()


    if err != nil {
        fmt.Println(err)
        return
    }

    client := kms.NewKmsClient(hcClient)

    request := &model.EncryptDataRequest{}
	additionalAuthenticatedDataEncryptDataRequestBody:= "123aad"
	encryptionAlgorithmEncryptDataRequestBody:= model.GetEncryptDataRequestBodyEncryptionAlgorithmEnum().SYMMETRIC_DEFAULT
	request.Body = &model.EncryptDataRequestBody{
		AdditionalAuthenticatedData: &additionalAuthenticatedDataEncryptDataRequestBody,
		EncryptionAlgorithm: &encryptionAlgorithmEncryptDataRequestBody,
		PlainText: "hello world",
		KeyId: "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
	}
	response, err := client.EncryptData(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档