关联密钥别名
功能介绍
关联别名。
您可以将别名从原密钥关联到另一个新的密钥
调用方法
请参见如何调用API。
URI
POST /v1.0/{project_id}/kms/alias/associate
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
project_id |
是 |
String |
项目ID |
请求参数
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
X-Auth-Token |
否 |
String |
用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 |
参数 |
是否必选 |
参数类型 |
描述 |
---|---|---|---|
alias |
是 |
String |
待关联别名 |
target_key_id |
是 |
String |
待关联的密钥ID |
响应参数
状态码: 200
参数 |
参数类型 |
描述 |
---|---|---|
domain_id |
String |
账号ID |
key_id |
String |
密钥ID |
alias |
String |
别名 |
alias_urn |
String |
别名资源定位符 |
create_time |
String |
创建时间 |
update_time |
String |
更新时间 |
请求示例
将 kms-1234 关联到密钥 bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e
{ "target_key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "alias" : "kms-1234" }
响应示例
状态码: 200
关联别名响应消息体
{ "domain_id" : "3bab8e245e854f68af5967c00dd43127", "key_id" : "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", "alias" : "kms-1234", "alias_urn" : "kms:cn-north-7:3bab8e245e854f68af5967c00dd43127:alias:kms-1234", "create_time" : "2024-04-01T00:00:00Z", "update_time" : "2024-04-01T00:00:00Z" }
SDK代码示例
SDK代码示例如下。
将 kms-1234 关联到密钥 bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e
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 |
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 AssociateAliasSolution { 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(); AssociateAliasRequest request = new AssociateAliasRequest(); AssociateAliasRequestBody body = new AssociateAliasRequestBody(); body.withTargetKeyId("bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e"); body.withAlias("kms-1234"); request.withBody(body); try { AssociateAliasResponse response = client.associateAlias(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-1234 关联到密钥 bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e
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 |
# 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 = AssociateAliasRequest() request.body = AssociateAliasRequestBody( target_key_id="bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", alias="kms-1234" ) response = client.associate_alias(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-1234 关联到密钥 bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e
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 |
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 := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := kms.NewKmsClient( kms.KmsClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.AssociateAliasRequest{} request.Body = &model.AssociateAliasRequestBody{ TargetKeyId: "bb6a3d22-dc93-47ac-b5bd-88df7ad35f1e", Alias: "kms-1234", } response, err := client.AssociateAlias(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
更多编程语言的SDK代码示例,请参见API Explorer的代码示例页签,可生成自动对应的SDK代码示例。
状态码
状态码 |
描述 |
---|---|
200 |
关联别名响应消息体 |
错误码
请参见错误码。