API Overview
You can use all the functions of Data Encryption Workshop (DEW) by calling its APIs.
Type |
Description |
---|---|
Key management APIs |
Create, query, modify, and delete keys. |
Key pair management APIs (V2) |
Create, query, modify, and delete key pairs. |
Key pair management APIs (V2.1) |
Create, query, modify, and delete key pairs. |
Key Management APIs
API |
Description |
---|---|
Creates a CMK. |
|
Enables a CMK. Only an enabled CMK can be used. |
|
Disables a CMK. A disabled CMK cannot be used. |
|
Schedules the deletion of a specific key. The deletion can be scheduled 7 to 1096 days in advance. After a key is deleted, the data encrypted using the key cannot be decrypted. |
|
Cancels a scheduled deletion of a key. Once the deletion is cancelled, the key can be used. |
|
Queries the list of all CMKs. |
|
Queries details of a specified key. |
|
Generates a multiple of 8 that is 8 bits to 8192 bits long. |
|
Creates a DEK. A returned result includes the plaintext and the ciphertext of a DEK. |
|
Creates a plaintext-free DEK, that is, the returned result of this API includes only the ciphertext of the DEK. |
|
Uses a specified CMK to encrypt a DEK. |
|
Uses a specified CMK to decrypt a DEK. |
|
Obtains the number of created CMKs, excluding the default master keys. |
|
Queries the total quota of CMKs available and the usage information, excluding the default master keys. |
|
Changes the alias of a CMK. |
|
Changes the description of a CMK. |
|
Grants a user the permissions required for operating a specific key. |
|
Revokes the key operation permissions granted to a user. |
|
Retires the granted key operation permissions. |
|
Queries grants of a CMK. |
|
Queries grants that can be retired. |
|
Uses a specified CMK to encrypt data. |
|
Decrypts data. |
|
Obtains necessary parameters to import a key, including an import token and an encryption public key. |
|
Imports the key material of a specified key. |
|
Deletes the key material of a specified key. |
|
Enables the rotation of a CMK. Default master keys and imported keys do not support the rotation function. |
|
Changes the rotation interval for a CMK. |
|
Disables the rotation of a CMK. |
|
Queries the rotation status of a CMK. |
|
Uses the tag filtering function to query the detailed information of a CMK. |
|
Queries tags of a CMK. |
|
Queries all tag sets of a project. |
|
Adds or deletes CMK tags in a batch. |
|
Adds a tag to a CMK. |
|
Deletes a tag from a CMK. |
Key Pair Management APIs (V2)
API |
Description |
---|---|
Queries the list key pairs. |
|
Queries a specified key pair based on the key pair name. |
|
Creates a key pair or import a public key to the cloud to generate a key pair. After a key pair is created, you need to download the private key to a local directory. Then, you can use this private key to log in to an Elastic Cloud Server (ECS). To ensure ECS security, the private key can be downloaded only once. Keep it secure. |
|
Deletes a specified key pair based on the key pair name. |
|
A tenant may contain multiple users. This operation copies the key pair from the target user to the current user under the same tenant account. |
|
Key Pair Management APIs (V2.1)
API |
Description |
---|---|
Queries the list of key pairs. |
|
Queries details of a key pair. |
|
Creates and imports a key pair, and allows you to manage the private key in the cloud. |
|
Deletes a specified key pair based on the key pair name. |
|
Modifies the description of a key pair based on the name of the key pair. |
