GetSoftwareEncryptionAtRestInfo

09/16/2024 Contributors

You can use the GetSoftwareEncryptionAtRestInfo method to get software encryption-at-rest information the cluster uses to encrypt data at rest.

Parameters

This method has no input parameters.

Return values

This method has the following return values:

Parameter Description Type Optional

Parameter	Description	Type	Optional
masterKeyInfo	Information about the current software encryption-at-rest master key.	EncryptionKeyInfo	True
rekeyMasterKeyAsyncResultID	The async result ID of the current or most recent rekey operation (if any), if it has not been deleted yet. `GetAsyncResult` output will include a `newKey` field that contains information about the new master key and a `keyToDecommission` field that contains information about the old key.	integer	True
state	The current software encryption-at-rest state. Possible values are `disabled` or `enabled`.	string	False
version	A version number that is incremented each time software encryption at rest is enabled.	integer	False

masterKeyInfo

Information about the current software encryption-at-rest master key.

EncryptionKeyInfo

True

rekeyMasterKeyAsyncResultID

The async result ID of the current or most recent rekey operation (if any), if it has not been deleted yet. GetAsyncResult output will include a newKey field that contains information about the new master key and a keyToDecommission field that contains information about the old key.

integer

True

state

The current software encryption-at-rest state. Possible values are disabled or enabled.

string

False

version

A version number that is incremented each time software encryption at rest is enabled.

integer

False

Request example

Requests for this method are similar to the following example:

{
 "method": "getsoftwareencryptionatrestinfo"
}

Response example

This method returns a response similar to the following example:

{
    "id": 1,
    "result": {
        "masterKeyInfo": {
            "keyCreatedTime": "2021-09-20T23:15:56Z",
            "keyID": "4d80a629-a11b-40ab-8b30-d66dd5647cfd",
            "keyManagementType": "internal"
        },
        "state": "enabled",
        "version": 1
    }
}

New since version

12.3