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

创建专属密钥库 - CreateKeyStore

功能介绍

  • "创建租户专属密钥库,专属密钥库使用DHSM实例作为密钥的存储"

调用方法

请参见如何调用API

授权信息

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

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

    授权项

    访问级别

    资源类型(*为必须)

    条件键

    别名

    依赖的授权项

    kms:keystore:create

    Write

    keystore *

    -

    -

    -

URI

POST /v1.0/{project_id}/keystores

表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参数

参数

是否必选

参数类型

描述

keystore_alias

String

参数解释:

专属密钥库别名

约束限制:

  • 1到255个字符

  • 满足正则匹配“^[a-zA-Z0-9:/_-]{1,255}$”

  • 且不与已有的专属密钥库别名重名

取值范围:

不涉及

默认取值:

不涉及

hsm_cluster_id

String

参数解释:

DHSM集群Id

约束限制:

要求集群当前未创建专属密钥库

取值范围:

不涉及

默认取值:

不涉及

hsm_ca_cert

String

参数解释:

DHSM集群的CA证书

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

cluster_id

String

参数解释:

集群ID

约束限制:

  • 当类型为DHSM时,cluster_id为hsm_cluster_id

  • 当类型为CDMS时,为cdms_cluster_id

取值范围:

不涉及

默认取值:

不涉及

keystore_type

String

参数解释:

专属密钥库集群类型

约束限制:

  • DHSM 表示专属加密服务集群

  • CDMS 表示密码卡集群

  • DEFAULT 表示KMS原有集群

  • DEFAULT

  • DHSM

  • CDMS

取值范围:

默认取值:

不涉及

响应参数

状态码:200

表4 响应Body参数

参数

参数类型

描述

keystore

KeystoreInfo object

参数解释:

密钥库信息

取值范围:

不涉及

表5 KeystoreInfo

参数

参数类型

描述

keystore_id

String

参数解释:

密钥库ID

取值范围:

不涉及

domain_id

String

参数解释:

用户域ID

取值范围:

不涉及

请求示例

创建别名为"keystore_alia1",集群ID为"hsm_cluster_id"的租户专属密钥库。

{
  "keystore_alias" : "keystore_alia1",
  "hsm_cluster_id" : "hsm_cluster_id",
  "hsm_ca_cert" : "-----BEGIN CERTIFICATE---******----END CERTIFICATE-----"
}

响应示例

状态码:200

请求已成功

{
  "keystore" : {
    "keystore_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e",
    "domain_id" : "b168fe00ff56492495a7d22974df2d0b"
  }
}

SDK代码示例

SDK代码示例如下。

创建别名为"keystore_alia1",集群ID为"hsm_cluster_id"的租户专属密钥库。

 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
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 CreateKeyStoreSolution {

    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();
        CreateKeyStoreRequest request = new CreateKeyStoreRequest();
        CreateKeyStoreRequestBody body = new CreateKeyStoreRequestBody();
        body.withHsmCaCert("-----BEGIN CERTIFICATE---******----END CERTIFICATE-----");
        body.withHsmClusterId("hsm_cluster_id");
        body.withKeystoreAlias("keystore_alia1");
        request.withBody(body);
        try {
            CreateKeyStoreResponse response = client.createKeyStore(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());
        }
    }
}

创建别名为"keystore_alia1",集群ID为"hsm_cluster_id"的租户专属密钥库。

 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
# 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 = CreateKeyStoreRequest()
        request.body = CreateKeyStoreRequestBody(
            hsm_ca_cert="-----BEGIN CERTIFICATE---******----END CERTIFICATE-----",
            hsm_cluster_id="hsm_cluster_id",
            keystore_alias="keystore_alia1"
        )
        response = client.create_key_store(request)
        print(response)
    except exceptions.ClientRequestException as e:
        print(e.status_code)
        print(e.request_id)
        print(e.error_code)
        print(e.error_msg)

创建别名为"keystore_alia1",集群ID为"hsm_cluster_id"的租户专属密钥库。

 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
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.CreateKeyStoreRequest{}
	hsmCaCertCreateKeyStoreRequestBody:= "-----BEGIN CERTIFICATE---******----END CERTIFICATE-----"
	hsmClusterIdCreateKeyStoreRequestBody:= "hsm_cluster_id"
	request.Body = &model.CreateKeyStoreRequestBody{
		HsmCaCert: &hsmCaCertCreateKeyStoreRequestBody,
		HsmClusterId: &hsmClusterIdCreateKeyStoreRequestBody,
		KeystoreAlias: "keystore_alia1",
	}
	response, err := client.CreateKeyStore(request)
	if err == nil {
        fmt.Printf("%+v\n", response)
    } else {
        fmt.Println(err)
    }
}

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

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档