租户端 安全 密钥管理系统（KMS） 数据结构

数据结构

最近更新时间: 2025-01-20 17:15:23

TagFilter

标签过滤器

被如下接口引用：DescribeWhiteBoxKeyDetails、ListKeyDetail

名称 必选 允许NULL 类型 描述
TagKey 是 否 String 标签键
TagValue 否 否 Array of String 标签值

VpcZoneData

vpc区域数据详情

被如下接口引用：

名称 必选 允许NULL 类型 描述
Zone 是 否 String 可用区
Region 是 否 String vpc节点地域

DeviceFingerprint

设备指纹

被如下接口引用：DescribeWhiteBoxDeviceFingerprints、OverwriteWhiteBoxDeviceFingerprints

名称 必选 允许NULL 类型 描述
Identity 是 否 String 指纹信息，由设备指纹采集工具采集获得，格式满足正则表达式：^[0-9a-f]{8}[-][0-9a-f]{14}[-][0-9a-f]{14}[-][0-9a-f]{14}[-][0-9a-f]{16}$
Description 否 是 String 描述信息，如：IP，设备名称等，最大1024字节

KeyMetadata

CMK属性信息

被如下接口引用：DescribeKey、DescribeKeys、ListKeyDetail

名称 必选 允许NULL 类型 描述
KeyId 是 否 String CMK的全局唯一标识
Alias 是 否 String 作为密钥更容易辨识，更容易被人看懂的别名
CreateTime 是 否 Uint64 密钥创建时间
Description 是 否 String CMK的描述
KeyState 是 否 String CMK的状态， 取值为：Enabled | Disabled | PendingDelete | PendingImport
KeyUsage 是 否 String CMK用途，取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2
Type 是 否 Int64 CMK类型，2 表示符合FIPS标准，4表示符合国密标准
CreatorUin 是 否 Uint64 创建者
KeyRotationEnabled 是 否 Bool 是否开启了密钥轮换功能
Owner 是 否 String CMK的创建者，用户创建的为 user，授权各云产品自动创建的为对应的产品名
NextRotateTime 是 否 Uint64 在密钥轮换开启状态下，下次轮换的时间
DeletionDate 是 是 Uint64 计划删除的时间
Origin 是 是 String CMK 密钥材料类型，由KMS创建的为： TENCENT_KMS， 由用户导入的类型为：EXTERNAL
ValidTo 是 是 Uint64 在Origin为 EXTERNAL 时有效，表示密钥材料的有效日期， 0 表示不过期
ResourceId 是 否 String 资源ID，格式：creatorUin/$creatorUin/$keyId
RotateDays 否 是 Uint64 轮换天数
LastRotateTime 否 是 Uint64 上一次轮换的时间

Tag

标签键和标签值

被如下接口引用：CreateKey、CreateWhiteBoxKey

名称 必选 允许NULL 类型 描述
TagKey 是 否 String 标签键
TagValue 是 否 String 标签值

Key

返回CMK列表信息

被如下接口引用：ListKeys

名称 必选 允许NULL 类型 描述
KeyId 是 否 String CMK的全局唯一标识。

WhiteboxKeyInfo

白盒密钥信息

被如下接口引用：DescribeWhiteBoxKey、DescribeWhiteBoxKeyDetails

名称 必选 允许NULL 类型 描述
KeyId 是 否 String 白盒密钥的全局唯一标识符
Alias 是 否 String 作为密钥更容易辨识，更容易被人看懂的别名， 不可为空，1-60个字母数字 - _ 的组合，首字符必须为字母或者数字. 不可重复
CreatorUin 是 否 Uint64 创建者
Description 是 否 String 密钥的描述信息
CreateTime 是 否 Uint64 密钥创建时间，Unix时间戳
Status 是 否 String 白盒密钥的状态， 取值为：Enabled | Disabled
OwnerUin 是 否 Uint64 创建者
Algorithm 是 否 String 密钥所用的算法类型
EncryptKey 是 否 String 白盒加密密钥，base64编码
DecryptKey 是 否 String 白盒解密密钥，base64编码
ResourceId 是 否 String 资源ID，格式：creatorUin/$creatorUin/$keyId
DeviceFingerprintBind 是 是 Bool 是否有设备指纹与当前密钥绑定

AlgorithmInfo

算法的名称 和 标识

被如下接口引用：ListAlgorithms

名称 必选 允许NULL 类型 描述
KeyUsage 是 否 String 算法的标识
Algorithm 是 否 String 算法的名称

TsmLicense

TSM SDK授权License

被如下接口引用：DescribeTSMLicenses

名称 必选 允许NULL 类型 描述
Version 否 否 String License版本
TsmAppId 否 否 String TSM AppId
Cert 否 否 String 证书，这里返回的是字符串格式