Data Types

Last updated: 2020-05-15 11:20:04

AlgorithmInfo

Algorithm name and ID

Used by actions: ListAlgorithms.

Name Type Description
KeyUsage String Algorithm ID
Algorithm String Algorithm name

KeyMetadata

CMK attribute information

Used by actions: DescribeKey、DescribeKeys、ListKeyDetail.

Name Type Description
KeyId String
Alias String
CreateTime Integer
Description String
KeyState String CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport.
KeyUsage String CMK purpose. Valid values: ENCRYPT_DECRYPT, ASYMMETRIC_DECRYPT_RSA_2048, ASYMMETRIC_DECRYPT_SM2
Type Integer CMK type. 2: FIPS-compliant; 4: SM-CRYPTO
CreatorUin Integer
KeyRotationEnabled Boolean
Owner String
NextRotateTime Integer
DeletionDate Integer
Origin String CMK key material type. TENCENT_KMS: created by KMS; EXTERNAL: imported by user.
Note: This field may return null, indicating that no valid values can be obtained.
ValidTo Integer It’s valid when Origin is EXTERNAL, indicating the expiration date of key material. 0 means valid forever.
Note: This field may return null, indicating that no valid values can be obtained.
ResourceId String Resource ID in the format of creatorUin/$creatorUin/$keyId.

WhiteboxKeyInfo

White-box key information

Used by actions: DescribeWhiteBoxKey、DescribeWhiteBoxKeyDetails.

Name Type Description
KeyId String Globally unique white-box key ID
Alias String Unique alias that makes a key more recognizable and understandable. This parameter should be 1 to 60 letters, digits, -, and _; it must begin with a letter or digit and cannot be left empty.
CreatorUin Integer Creator
Description String Key description information
CreateTime Integer Key creation time in Unix timestamp
Status String White-box key status. Valid values: Enabled, Disabled
OwnerUin Integer Creator
Algorithm String Key algorithm type
EncryptKey String Base64-encoded white-box encryption key
DecryptKey String Base64-encoded white-box decryption key
ResourceId String Resource ID in the format of creatorUin/$creatorUin/$keyId.