Help Center > > API Reference> API Overview

API Overview

Updated at: May 26, 2020 GMT+08:00

By using the APIs provided by DEW, you can use all the functions of the service.

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

Creating a CMK

Creates a CMK.

Enabling a CMK

Enables a CMK. Only an enabled CMK can be used.

Disabling a CMK

Disables a CMK. A disabled CMK cannot be used.

Scheduling the Deletion of a CMK

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.

Canceling the Scheduled Deletion of a CMK

Cancels a scheduled deletion of a key. Once the deletion is cancelled, the key can be used.

Querying the List of CMKs

Queries the list of all CMKs.

Querying the Information About a CMK

Queries details of a specified key.

Creating a Random Number

Generates a multiple of 8 that is 8 bits to 8192 bits long.

Creating a DEK

Creates a DEK. A returned result includes the plaintext and the ciphertext of a DEK.

Creating a Plaintext-Free DEK

Creates a plaintext-free DEK, that is, the returned result of this API includes only the ciphertext of the DEK.

Encrypting a DEK

Uses a specified CMK to encrypt a DEK.

Decrypting a DEK

Uses a specified CMK to decrypt a DEK.

Querying the Number of Instances

Obtains the number of created CMKs, excluding the default master keys.

Querying the Quota of a User

Queries the total quota of CMKs available and the usage information, excluding the default master keys.

Changing the Alias of a CMK

Changes the alias of a CMK.

Changing the Description of a CMK

Changes the description of a CMK.

Creating a Grant

Grants a user the permissions required for operating a specific key.

Revoking a Grant

Revokes the key operation permissions granted to a user.

Retiring a Grant

Retires the granted key operation permissions.

Querying Grants on a CMK

Queries grants of a CMK.

Querying Grants That Can Be Retired

Queries grants that can be retired.

Encrypting Data

Uses a specified CMK to encrypt data.

Decrypting Data

Decrypts data.

Obtaining CMK Import Parameters

Obtains necessary parameters to import a key, including an import token and an encryption public key.

Importing CMK Material

Imports the key material of a specified key.

Deleting CMK Material

Deletes the key material of a specified key.

Enabling Rotation for a CMK

Enables the rotation of a CMK. Default master keys and imported keys do not support the rotation function.

Changing the Rotation Interval for a CMK

Changes the rotation interval for a CMK.

Disabling Rotation for a CMK

Disables the rotation of a CMK.

Querying the Rotation Status of a CMK

Queries the rotation status of a CMK.

Querying CMK Instances

Uses the tag filtering function to query the detailed information of a CMK.

Querying CMK Tags

Queries tags of a CMK.

Querying Project Tags

Queries all tag sets of a project.

Adding or Deleting CMK Tags in Batches

Adds or deletes CMK tags in a batch.

Adding a CMK Tag

Adds a tag to a CMK.

Deleting a CMK Tag

Deletes a tag from a CMK.

Key Pair Management APIs (V2)

API

Description

Querying the List of SSH Key Pairs

Queries the list key pairs.

Querying Details About an SSH Key Pair

Queries a specified key pair based on the key pair name.

Creating and Importing an SSH Key Pair

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.

Deleting an SSH Key Pair

Deletes a specified key pair based on the key pair name.

Copying an SSH Key Pair (Old)

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.

Copying an SSH Key Pair

Key Pair Management APIs (V2.1)

API

Description

Querying the List of SSH Key Pairs

Queries the list of key pairs.

Querying Details About an SSH Key Pair

Queries details of a key pair.

Creating and Importing an SSH Key Pair

Creates and imports a key pair, and allows you to manage the private key in the cloud.

Deleting an SSH Key Pair

Deletes a specified key pair based on the key pair name.

Modifying the Description of a Key Pair

Modifies the description of a key pair based on the name of the key pair.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel