Help Center> Data Encryption Workshop> API Reference> APIs> Key Management APIs> CMK Importing Management> Importing CMK Material
Updated on 2022-09-15 GMT+08:00
View PDF

Importing CMK Material

Function

This API allows you to import CMK material.

URI

POST /v1.0/{project_id}/kms/import-key-material

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token. The token can be obtained by calling the IAM API (value of X-Subject-Token in the response header).
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

key_id

Yes

String

CMK ID. It should be 36 bytes and match the regular expression ^[0-9a-z]{8}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{4}-[0-9a-z]{12}$. Example: 0d0466b0-e727-4d9c-b35d-f84bb474a37f

import_token

Yes

String

Key import token in Base64 format, which matches the regular expression ^[0-9a-zA-Z+/=]{200,6144}$.

encrypted_key_material

Yes

String

Encrypted key material, which is in Base64 format and matches the regular expression ^[0-9a-zA-Z+/=]{344,360}$.

expiration_time

No

String

Time when the key material expires. The timestamp indicates the total seconds past the start of the epoch date (January 1, 1970). KMS will delete the key material within 24 hours after its expiration. Example: 1550291833

sequence

No

String

36-byte sequence number of a request message. Example: 919c82d4-8046-4722-9094-35c3c6524cff

Response Parameters

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 5 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 403

Table 6 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 7 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error

Object

Error message.
Table 9 ErrorDetail

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error information.

Example Requests

{
  "key_id" : "0d0466b0-e727-4d9c-b35d-f84bb474a37f",
  "import_token" : "AACIBjY2ZTQxYItNDU4Ny04OTIxLWVhZTVhZjg5NDZm....",
  "expiration_time" : 1521578672
}

Example Responses

Status code: 400

Invalid request parameters.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status code: 403

Authentication failed.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status code: 404

The requested resource does not exist or is not found.

{
  "error" : {
    "error_code" : "KMS.XXX",
    "error_msg" : "XXX"
  }
}

Status Codes

Status Code

Description

200

Request processing succeeded.

400

Invalid request parameters.

403

Authentication failed.

404

The requested resource does not exist or is not found.

Error Codes

See Error Codes.

Parent topic: CMK Importing Management