Enabling EVS Default Encryption
Function
This API is used to enable EVS default encryption. This function is currently in the OBT. You need to submit a service ticket to apply for using it.
-
If EVS default encryption is enabled for the first time, evs/default is used as the default key for EVS default encryption.
-
If EVS default encryption has been enabled and the default key has been changed before, when default encryption is later disabled and then enabled, that key is inherited if it is still valid. Otherwise, the evs/default key is used.
-
If the agency *EVSAccessKMS is not created, EVS default encryption cannot be enabled.
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
POST /v5/{project_id}/default-encryption/enable
| 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
| 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 |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| default_encryption | Boolean | The value can be true (default encryption enabled) or *false (default encryption disabled). |
Status code: 400
| 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. |
| 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 | EVS default encryption status |
| 400 | Bad Request |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot