Copying a Key to a Specified Region
Function
Copy the key in the current region to the target region.
Calling Method
For details, see Calling APIs.
Authorization Information
Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.
- If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
 - If you are using identity policy-based authorization, the following identity policy-based permissions are required. 
     
Action
Access Level
Resource Type (*: required)
Condition Key
Alias
Dependencies
kms:cmk:replicate
Write
KeyId *
- 
            
kms:KeyOrigin
 - 
            
kms:KeySpec
 - 
            
kms:KeyUsage
 - 
            
kms:MultiRegionKeyType
 - 
            
g:EnterpriseProjectId
 - 
            
g:ResourceTag/<tag-key>
 
-
-
 - 
            
 
URI
POST /v2/{project_id}/kms/keys/{key_id}/replicate
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         project_id  | 
       
         Yes  | 
       
         String  | 
       
         Project ID  | 
      
| 
         key_id  | 
       
         Yes  | 
       
         String  | 
       
         ID of the key to be copied, which is 36-byte long and matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$, for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f  | 
      
Request Parameters
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         X-Auth-Token  | 
       
         Yes  | 
       
         String  | 
       
         User token. It can be obtained by calling the IAM API. The value of X-Subject-Token in the response header is the user token.  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         key_id  | 
       
         Yes  | 
       
         String  | 
       
         ID of the key to be copied, which is 36-byte long and matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$, for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f  | 
      
| 
         replica_region  | 
       
         Yes  | 
       
         String  | 
       
         Target region code of the copied key, for example, cn-north-4  | 
      
| 
         key_alias  | 
       
         Yes  | 
       
         String  | 
       
         Alias of the copied new key  | 
      
| 
         key_description  | 
       
         No  | 
       
         String  | 
       
         Description of the copied new key  | 
      
| 
         enterprise_project_id  | 
       
         No  | 
       
         String  | 
       
         Enterprise multi-project ID for the copied new key 
 If you do not have the permission to create resources under the default enterprise project, an error will be reported.  | 
      
| 
         replica_project_id  | 
       
         Yes  | 
       
         String  | 
       
         Project ID of the copied new key  | 
      
| 
         tags  | 
       
         No  | 
       
         Array of TagItem objects  | 
       
         Tag list, which is the value pairs of tag keys and values.  | 
      
| 
         Parameter  | 
       
         Mandatory  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|---|
| 
         key  | 
       
         Yes  | 
       
         String  | 
       
         Key. The value can contain up to 36 unicodes. This parameter cannot be left empty. The following nonprintable characters cannot be included: ASCII(0-31), *, <, >, , and =.  | 
      
| 
         value  | 
       
         No  | 
       
         String  | 
       
         Key. The value can contain up to 43 unicodes. This parameter can be left empty. The following nonprintable characters cannot be included: ASCII(0-31), *, <, >, , and =.  | 
      
Response Parameters
Status code: 200
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         key_id  | 
       
         String  | 
       
         ID of the copied key, which is 36-byte long and matches the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$, for example, 0d0466b0-e727-4d9c-b35d-f84bb474a37f  | 
      
| 
         domain_id  | 
       
         String  | 
       
         User domain ID  | 
      
| 
         region  | 
       
         String  | 
       
         Code of the region where the copied key is located, for example, cn-north-4  | 
      
Status code: 400
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Status code: 401
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Status code: 403
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Status code: 404
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Status code: 500
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Status code: 502
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Status code: 504
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error  | 
       
         Object  | 
       
         Error message  | 
      
| 
         Parameter  | 
       
         Type  | 
       
         Description  | 
      
|---|---|---|
| 
         error_code  | 
       
         String  | 
       
         Error code returned by the error request  | 
      
| 
         error_msg  | 
       
         String  | 
       
         Error information returned by the error request  | 
      
Example Requests
{
  "key_id" : "826314dd-1b5b-4037-b976-5f9b7a17df46",
  "replica_region" : "cn-north-4",
  "key_alias" : "replica_key_alias",
  "replica_project_id" : "2b31ed520xxxxxxebedb6e57xxxxxxxx"
}
  Example Responses
Status code: 200
Request succeeded.
{
  "key_id" : "8e85c00f-f7d0-47c9-ac96-548f977d16ba",
  "domain_id" : "3bab8e245e854f68af5967c00dd43127",
  "region" : "cn-north-4"
}
  SDK Sample Code
The SDK sample code is as follows.
          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  | 
         
          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 ReplicateKeySolution { 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(); ReplicateKeyRequest request = new ReplicateKeyRequest(); request.withKeyId("{key_id}"); ReplicateKeyRequestBody body = new ReplicateKeyRequestBody(); body.withReplicaProjectId("2b31ed520xxxxxxebedb6e57xxxxxxxx"); body.withKeyAlias("replica_key_alias"); body.withReplicaRegion("cn-north-4"); body.withKeyId("826314dd-1b5b-4037-b976-5f9b7a17df46"); request.withBody(body); try { ReplicateKeyResponse response = client.replicateKey(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()); } } }  | 
        
          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  | 
         
          # 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 = ReplicateKeyRequest() request.key_id = "{key_id}" request.body = ReplicateKeyRequestBody( replica_project_id="2b31ed520xxxxxxebedb6e57xxxxxxxx", key_alias="replica_key_alias", replica_region="cn-north-4", key_id="826314dd-1b5b-4037-b976-5f9b7a17df46" ) response = client.replicate_key(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg)  | 
        
          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  | 
         
          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.ReplicateKeyRequest{} request.KeyId = "{key_id}" request.Body = &model.ReplicateKeyRequestBody{ ReplicaProjectId: "2b31ed520xxxxxxebedb6e57xxxxxxxx", KeyAlias: "replica_key_alias", ReplicaRegion: "cn-north-4", KeyId: "826314dd-1b5b-4037-b976-5f9b7a17df46", } response, err := client.ReplicateKey(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } }  | 
        
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
| 
         Status Code  | 
       
         Description  | 
      
|---|---|
| 
         200  | 
       
         Request succeeded.  | 
      
| 
         400  | 
       
         Invalid request parameter.  | 
      
| 
         401  | 
       
         Username and password are required for the requested page.  | 
      
| 
         403  | 
       
         Authentication failed.  | 
      
| 
         404  | 
       
         The resource does not exist.  | 
      
| 
         500  | 
       
         Internal service error.  | 
      
| 
         502  | 
       
         Request failed. The server has received an invalid response.  | 
      
| 
         504  | 
       
         Gateway timed out.  | 
      
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot