Skip to main content
A newer release of this product is available.

Re-key the internal key in the key hierarchy for an SVM

Contributors
PDFs

POST /security/gcp-kms/{gcp_kms.uuid}/rekey-internal

Introduced In: 9.9

Rekeys the internal key in the key hierarchy for an SVM with a Google Cloud KMS configuration. Note: This method is only available to the NetApp Cloud Volume Services for GCP.

  • security key-manager external gcp rekey-internal

Parameters

Name Type In Required Description

gcp_kms.uuid

string

path

True

UUID of the existing Google Cloud KMS configuration.

return_timeout

integer

query

False

The number of seconds to allow the call to execute before returning. When doing a POST, PATCH, or DELETE operation on a single record, the default is 0 seconds. This means that if an asynchronous operation is started, the server immediately returns HTTP code 202 (Accepted) along with a link to the job. If a non-zero value is specified for POST, PATCH, or DELETE operations, ONTAP waits that length of time to see if the job completes so it can return something other than 202.

  • Default value: 1

  • Max value: 120

  • Min value: 0

return_records

boolean

query

False

The default is false. If set to true, the records are returned.

  • Default value:

Response

Status: 202, Accepted

Error

Status: Default

ONTAP Error Response Codes

Error Code Description

65537547

One or more volume encryption keys for encrypted volumes of this data SVM are stored in the key manager configured for the admin SVM. Use the REST API POST method to migrate this data SVM's keys from the admin SVM's key manager to this data SVM's key manager before running the rekey operation.

65537559

There are no existing internal keys for the SVM. A rekey operation is allowed for an SVM with one or more encryption keys.

65537721

Google Cloud KMS is not configured for the given SVM.
Name Type Description

error

error
Example error 
{
  "error": {
    "arguments": {
      "code": "string",
      "message": "string"
    },
    "code": "4",
    "message": "entry doesn't exist",
    "target": "uuid"
  }
}

Definitions

See Definitions

error_arguments

Name Type Description

code

string

Argument code

message

string

Message argument

error

Name Type Description

arguments

array[error_arguments]

Message arguments

code

string

Error code

message

string

Error message

target

string

The target parameter that caused the error.