Data Types

Last updated: 2020-10-16 18:21:04

AlgorithmInfo

Algorithm name and ID

Used by actions: ListAlgorithms.

Name Type Description
KeyUsage String Algorithm ID
Algorithm String Algorithm name

DeviceFingerprint

Device fingerprint

Used by actions: DescribeWhiteBoxDeviceFingerprints, OverwriteWhiteBoxDeviceFingerprints.

Name Type Required Description
Identity String Yes Fingerprint information collected by device fingerprint collector. Its format must be in the following regular expression: ^[0-9a-f]{8}[-][0-9a-f]{14}[-][0-9a-f]{14}[-][0-9a-f]{14}[-][0-9a-f]{16}$
Description String No Description, such as IP and device name. Length limit: 1,024 bytes
Note: this field may return null, indicating that no valid values can be obtained.

Key

Returned CMK list information

Used by actions: ListKeys.

Name Type Description
KeyId String Globally unique CMK ID.

KeyMetadata

CMK attribute information

Used by actions: DescribeKey, DescribeKeys, ListKeyDetail.

Name Type Description
KeyId String Globally unique CMK ID
Alias String Alias that makes a key more recognizable and understandable
CreateTime Integer Key creation time
Description String CMK description
KeyState String CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport, Archived.
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 Creator
KeyRotationEnabled Boolean Whether key rotation is enabled
Owner String CMK creator. The value of this parameter is user if the CMK is created by the user, or the corresponding service name if it is created automatically by an authorized Tencent Cloud service.
NextRotateTime Integer Time of next rotation if key rotation is enabled
DeletionDate Integer Scheduled deletion time
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.

Tag

Tag key and tag value

Used by actions: CreateKey, CreateWhiteBoxKey.

Name Type Required Description
TagKey String Yes Tag key
TagValue String Yes Tag value

TagFilter

Tag filter

Used by actions: DescribeWhiteBoxKeyDetails, ListKeyDetail.

Name Type Required Description
TagKey String Yes Tag key
TagValue Array of String No Tag value

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 cannot be empty, can contain 1 to 60 letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
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
DeviceFingerprintBind Boolean Whether there is a device fingerprint bound to the current key
Note: this field may return null, indicating that no valid values can be obtained.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help