Help Center/ Elastic Volume Service/ API Reference/ API/ Default Encryption/ Changing the Default Key for EVS Default Encryption
Updated on 2026-06-25 GMT+08:00

Changing the Default Key for EVS Default Encryption

Function

This API is used to change the default key for EVS default encryption.

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, no identity policy-based permission required for calling this API.

URI

PUT /v5/{project_id}/default-encryption/key

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

The project ID. For details, see Obtaining a Project ID.

Constraints

N/A

Range

N/A

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

The user token.

You can obtain it by calling the IAM API. The value of X-Subject-Token in the response header is the user token.

Constraints

N/A

Range

N/A

Default Value

N/A

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

kms_key_id

Yes

String

The KMS key ID.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

kms_key_id

String

The ID of the default key of EVS default encryption.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error

Error object

Definition

The error code returned if an error occurs. For details about the error code, see Error Codes.

Range

The object that includes the error code and error message.

Table 6 Error

Parameter

Type

Description

code

String

Definition

The error code returned if an error occurs.

Range

For details about the error code, see Error Codes.

message

String

Definition

The error message returned if an error occurs.

Range

A character string that describes the error message.

Example Requests

None

Example Responses

None

Status Codes

Status Code

Description

200

The ID of the default key for EVS default encryption.

400

Error response

Error Codes

See Error Codes.