Updated on 2022-12-06 GMT+08:00

Encryption Key Management

API

API Function

Permission

POST /v1.0/{project_id}/kms/create-key

Creates a CMK.

kms:cmk:create

POST /v1.0/{project_id}/kms/enable-key

Enables a CMK.

kms:cmk:enable

POST /v1.0/{project_id}/kms/disable-key

Disables a CMK.

kms:cmk:disable

POST /v1.0/{project_id}/kms/schedule-key-deletion

Schedules the deletion of a CMK.

kms:cmk:update

POST /v1.0/{project_id}/kms/cancel-key-deletion

Cancels the scheduled deletion of a CMK.

kms:cmk:update

POST /v1.0/{project_id}/kms/list-keys

Queries the list of CMKs.

kms:cmk:list

POST /v1.0/{project_id}/kms/describe-key

Queries the CMK information.

kms:cmk:get

POST /v1.0/{project_id}/kms/gen-random

Generates a random number.

kms:cmk:generate

POST /v1.0/{project_id}/kms/create-datakey

Creates a DEK.

kms:dek:create

POST /v1.0/{project_id}/kms/create-datakey-without-plaintext

Creates a plaintext-free DEK.

kms:dek:create

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

Encrypts a DEK.

kms:dek:crypto

POST /v1.0/{project_id}/kms/decrypt-datakey

Decrypts a DEK.

kms:dek:crypto

GET /v1.0/{project_id}/kms/user-instances

Queries the number of instances.

kms:cmk:getInstance

GET /v1.0/{project_id}/kms/user-quotas

Queries the user quota.

kms:cmk:getQuota

POST /v1.0/{project_id}/kms/update-key-alias

Modifies the CMK alias.

kms:cmk:update

POST /v1.0/{project_id}/kms/update-key-description

Modifies the description of a CMK.

kms:cmk:update

POST /v1.0/{project_id}/kms/get-parameters-for-import

Obtains parameters for importing a key.

kms:cmk:getMaterial

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

Imports key material.

kms:cmk:importMaterial

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

Deletes key material.

kms:cmk:deleteMaterial

POST /v1.0/{project_id}/kms/enable-key-rotation

Enables key rotation.

kms:cmk:enableRotation

POST /v1.0/{project_id}/kms/update-key-rotation-interval

Modifies the rotation interval.

kms:cmk:updateRotation

POST /v1.0/{project_id}/kms/disable-key-rotation

Disables key rotation.

kms:cmk:disableRotation

POST /v1.0/{project_id}/kms/get-key-rotation-status

Queries the key rotation status.

kms:cmk:getRotation