DocsICP FilingConsole
Documentation

EnableDiskEncryptionByDefault

Updated at:
Copy as MD
Product
My Favorites

Enables the Account-level Elastic Block Storage (EBS) Default Encryption feature in a region.

Operation description

Note

The Account-level EBS Default Encryption feature is available only in specific regions and to specific users. To use the feature, submit a ticket.

  • Precautions

    • To enable the Account-level EBS Default Encryption feature as a Resource Access Management (RAM) user, grant the AliyunECSFullAccess permission to the RAM user. For more information, see Grant permissions to a RAM user.

    • Before you can enable the Account-level EBS Default Encryption feature in a region, you must activate Key Management Service (KMS) in the region.

    • After you enable the Account-level EBS Default Encryption feature in a region, you can purchase only encrypted cloud disks in the region. For more information, see the Limits section of the "Encrypt cloud disks" topic.

  • Considerations

    • After you enable the Account-level EBS Default Encryption feature in a region, new pay-as-you-go and subscription cloud disks in the region must be encrypted. You can use the KMS key configured for the feature or specify other KMS keys to encrypt the cloud disks.

    • The first time you enable the Account-level EBS Default Encryption feature in a region, the service key in the region is automatically used to encrypt EBS resources.

  • Suggestions

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ecs:EnableDiskEncryptionByDefault

none

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
RegionId

string

Yes

The region ID. You can call the DescribeRegions operation to query the most recent region list.

cn-hangzhou

Response elements

Element

Type

Description

Example

object

The response parameters.

RequestId

string

The request ID.

473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E

Examples

Success response

JSON format

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E"
}

Error codes

HTTP status code

Error code

Error message

Description
400 InvalidParameter.Encrypted.KmsNotEnabled KMS must be enabled for encrypted disks. KMS is not activated. You must activate KMS before you can encrypt disks.
400 InvalidParameter.KmsNotEnabled Failed to perform this operation because KMS is not activated. You need to activate KMS key management service.
403 Abs.InvalidAction.RegionNotSupport This region does not support this action. The operation is not supported in the region.
403 InvalidOperation.DefaultEncryptionAlreadyEnabled The specified region is already default encryption settings. The region has enabled cloud disk encryption by default.
403 InvalidParameter.RegionIdNotExists The specified region does not exists. The region does not exist.
403 InvalidParameter.KMSKeyId.KMSUnauthorized ECS service have no right to access your KMS. ECS is not authorized to access your KMS resources.
403 InvalidOperation.KMSKeyIdNotFound The specified KMSKeyId not found, %s. The associated KMS encryption key cannot be found. Verify that the KMS encryption key is valid.
403 InvalidOperation.KMSServiceNotOpen KMS service is currently not open. The KMS service has not been enabled.
403 UserNotInTheWhiteList The user is not in disk white list. You are not authorized to manage the disk. Try again when you are authorized.
403 InvalidParameter.KMSKeyId.CMKNotEnabled The CMK (Customer Master Key) must be in an active state. The CMK (Customer Master Key) must be in an active state.
403 InvalidParameter.KMSKeyId.CMKUnauthorized The CMK(Customer Master Key) lacks authorization to add tags to the ECS service. The CMK(Customer Master Key) lacks authorization to add tags to the ECS service.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.