数据结构

最近更新时间: 2026-04-09 18:11:30

KeyMetadata

CMK属性信息

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

名称 必选 允许NULL 类型 描述
KeyId String CMK的全局唯一标识
示例值:
Alias String 作为密钥更容易辨识,更容易被人看懂的别名
示例值:
CreateTime Uint64 密钥创建时间
示例值:
Description String CMK的描述
示例值:
KeyState String CMK的状态, 取值为:Enabled 
KeyUsage String CMK用途,取值为: ENCRYPT_DECRYPT 
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 上一次轮换的时间
示例值:

TagFilter

标签过滤器

被如下接口引用:DescribeWhiteBoxKeyDetails、ListKeyDetail

名称 必选 允许NULL 类型 描述
TagKey String 标签键
示例值:
TagValue Array of 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 
OwnerUin Uint64 创建者
示例值:
Algorithm String 密钥所用的算法类型
示例值:
EncryptKey String 白盒加密密钥,base64编码
示例值:
DecryptKey String 白盒解密密钥,base64编码
示例值:
ResourceId String 资源ID,格式:creatorUin/$creatorUin/$keyId
示例值:
DeviceFingerprintBind Bool 是否有设备指纹与当前密钥绑定
示例值:

Tag

标签键和标签值

被如下接口引用:CreateKey、CreateWhiteBoxKey

名称 必选 允许NULL 类型 描述
TagKey String 标签键
示例值:
TagValue String 标签值
示例值:

TsmLicense

TSM SDK授权License

被如下接口引用:DescribeTSMLicenses

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

AlgorithmInfo

算法的名称 和 标识

被如下接口引用:ListAlgorithms

名称 必选 允许NULL 类型 描述
KeyUsage String 算法的标识
示例值:
Algorithm String 算法的名称
示例值:

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字节
示例值: