Data Types

Last updated: 2020-09-04 14:39:49

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
Alias String
CreateTime Integer
Description String
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
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.

Tag

Used by actions: CreateKey, CreateWhiteBoxKey.

Name Type Required Description
TagKey String Yes
TagValue String Yes

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

Used by actions: DescribeWhiteBoxKey, DescribeWhiteBoxKeyDetails.

Name Type Description
KeyId String
Alias String
CreatorUin Integer
Description String
CreateTime Integer
Status String
OwnerUin Integer
Algorithm String
EncryptKey String
DecryptKey String
ResourceId String
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