cURL
Get CMEK-related information for a cluster
Can be used by the following roles assigned at the organization, folder or cluster scope:
- CLUSTER_ADMIN
- CLUSTER_OPERATOR_WRITER
GET
cURL
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Response
A successful response.
CMEKClusterInfo contains the status of CMEK across an entire cluster, including within each one its regions.
CMEKStatus describes the current status of CMEK for an entire CRDB cluster or a CMEK key within a region.
- DISABLED: DISABLED corresponds to the state of a cluster or region-level key when CMEK has finished being disabled. By default, CMEK will be disabled for new clusters.
- DISABLING: DISABLING corresponds to the state of a cluster or region-level key when CMEK is in the process of being disabled.
- DISABLE_FAILED: DISABLE_FAILED corresponds to the state of a cluster or region-level key when CMEK has failed to be disabled.
- ENABLED: ENABLED corresponds to the state of a cluster or region-level key when CMEK is enabled.
- ENABLING: ENABLING corresponds to the state of a cluster or region-level key when CMEK is in the process of being enabled.
- ENABLE_FAILED: ENABLE_FAILED corresponds to the state of a cluster or region-level key when CMEK has failed to be enabled.
- ROTATING: ROTATING corresponds to the state of a cluster or region when the a new spec is in the process of being enabled while an existing spec is being disabled.
- ROTATE_FAILED: ROTATE_FAILED corresponds to the state of a cluster or region if there was a failure to update from one CMEK spec to another.
- REVOKED: REVOKED corresponds to the state of a cluster or region-level key when the customer has revoked CockroachLab's permissions for their key.
- REVOKING: REVOKING corresponds to the state of a cluster or region-level key when CMEK is in the process of being revoked.
- REVOKE_FAILED: REVOKE_FAILED corresponds to the state of a cluster or region-level key when CMEK has failed to be revoked.
Available options:
DISABLED, DISABLING, DISABLE_FAILED, ENABLED, ENABLING, ENABLE_FAILED, ROTATING, ROTATE_FAILED, REVOKED, REVOKING, REVOKE_FAILED