REST Resource: projects.locations.cmekConfigs

资源:CmekConfig

用于通过 Cloud KMS 密钥启用 CMEK 数据加密的配置。

JSON 表示法
{
  "name": string,
  "kmsKey": string,
  "kmsKeyVersion": string,
  "state": enum (State),
  "isDefault": boolean,
  "lastRotationTimestampMicros": string,
  "singleRegionKeys": [
    {
      object (SingleRegionKey)
    }
  ],
  "notebooklmState": enum (NotebookLMState)
}
字段
name

string

必需。CmekConfig 的名称,格式为 projects/{project}/locations/{location}/cmekConfigprojects/{project}/locations/{location}/cmekConfigs/{cmekConfig}

kmsKey

string

必需。将用于加密 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} 资源的 KMS 密钥的资源名称。

kmsKeyVersion

string

仅限输出。将用于加密 <kmsKey>/cryptoKeyVersions/{keyVersion} 资源的 KMS 密钥版本的资源名称。

state

enum (State)

仅限输出。CmekConfig 的状态。

isDefault

boolean

仅限输出。客户的默认 CmekConfig。

lastRotationTimestampMicros

string (int64 format)

仅限输出。上次密钥轮替时的时间戳。

singleRegionKeys[]

object (SingleRegionKey)

可选。某些 VAIS 功能所需的单区域 CMEK。

notebooklmState

enum (NotebookLMState)

仅限输出。指示 NotebookLM 语料库是否准备就绪可供使用。

状态

CmekConfig 的状态。

枚举
STATE_UNSPECIFIED CmekConfig 状态未知。
CREATING CmekConfig 正在创建中。
ACTIVE CmekConfig 可在数据存储区中使用。
KEY_ISSUE CmekConfig 不可用,很可能是因为 KMS 密钥已被撤销。
DELETING CmekConfig 正在删除中。
DELETE_FAILED CmekConfig 删除过程失败。
UNUSABLE CmekConfig 不可用,很可能是由于某些内部问题导致。
ACTIVE_ROTATING KMS 密钥版本正在轮替中。
DELETED KMS 密钥已被软删除。最终会应用某些清理政策。
EXPIRED KMS 密钥已过期,这意味着该密钥已停用 30 天以上。客户可以调用 cmekConfigs.delete 将该状态更改为“DELETED”。

SingleRegionKey

单区域 CMEK 的元数据。

JSON 表示法
{
  "kmsKey": string
}
字段
kmsKey

string

必需。将用于加密 projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId} 资源的单区域 KMS 密钥的资源名称。

NotebookLMState

NotebookLM 的状态。

枚举
NOTEBOOK_LM_STATE_UNSPECIFIED NotebookLM 状态未知。
NOTEBOOK_LM_NOT_READY NotebookLM 未就绪。
NOTEBOOK_LM_READY NotebookLM 已就绪可供使用。
NOTEBOOK_LM_NOT_ENABLED NotebookLM 未启用。

方法

delete

取消预配 CmekConfig。

get

获取 CmekConfig

list

列出项目中的所有 CmekConfig

patch

为客户项目某一位置预配一个 CMEK 密钥。