Algorithm name and ID
Used by actions: ListAlgorithms.
| Name | Type | Description |
|---|---|---|
| KeyUsage | String | Algorithm ID |
| Algorithm | String | Algorithm name |
Specifies the data key attribute.
Used by actions: ListDataKeys.
| Name | Type | Required | Description |
|---|---|---|---|
| DataKeyId | String | No | Globally unique id of DataKey. |
Specifies the data key attribute information.
Used by actions: DescribeDataKey, DescribeDataKeys, ListDataKeyDetail.
| Name | Type | Description |
|---|---|---|
| DataKeyId | String | Globally unique ID of the DataKey |
| KeyId | String | Globally unique ID of the CMK. |
| KeyName | String | CMK name |
| DataKeyName | String | Data key name that is easier to identify and understand as a key |
| NumberOfBytes | Integer | Length of the data key, in bytes |
| CreateTime | Integer | Key creation time |
| Description | String | Description of DataKey |
| KeyState | String | DataKey state, value: Enabled | Disabled | PendingDelete |
| CreatorUin | Integer | Creator. |
| Owner | String | Creator of the data key. For user-created keys, it is user; for keys automatically created by authorized cloud services, it is the corresponding product name. |
| DeletionDate | Integer | Schedule deletion time |
| Origin | String | DataKey key material type. For keys created by KMS: TENCENT_KMS. For keys of user import type: EXTERNAL. |
| HsmClusterId | String | HSM Cluster ID (only applicable to KMS exclusive edition/managed version service instances) |
| ResourceId | String | Resource ID, format: creatorUin/$creatorUin/$dataKeyId |
| IsSyncReplica | Integer | Whether the key is a primary replica. 0: primary replica, 1: synced replica. |
| SourceRegion | String | Synchronous original region |
| SyncStatus | Integer | Key synchronization status. 0: unsynced, 1: synchronization successful, 2: synchronization failure, 3: syncing. |
| SyncMessages | String | Synchronous result description |
| SyncStartTime | Integer | Start time of synchronization |
| SyncEndTime | Integer | Synchronous end time |
| SourceHsmClusterId | String | Synchronous primitive cluster. If empty, it is a public cloud public cluster. |
| AccountAppId | Integer | Member account appId |
| AccountUin | Integer | member account uin |
| AccountName | String | Enter the member account name. |
| CreatorUinString | String | Creator UIN |
Target region list of the sync task, including region and cluster information. if the cluster is empty, it means public cloud shared cluster. if the cluster is not empty, it means dedicated cluster.
Used by actions: GetServiceStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| DestinationRegion | String | No | Specifies the target region of the synchronization task. |
| HsmClusterId | String | No | HsmClusterId being empty indicates public cloud shared version. if not empty, it indicates exclusive edition cluster in the region. |
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 information, such as IP and device name, with a maximum of 1024 bytes. |
Exclusive edition cluster.
Used by actions: GetServiceStatus.
| Name | Type | Description |
|---|---|---|
| HsmClusterId | String | Dedicated cluster Id. |
| HsmClusterName | String | Dedicated cluster name. |
Returned CMK list information
Used by actions: ListKeys.
| Name | Type | Description |
|---|---|---|
| KeyId | String | Globally unique CMK ID. |
CMK attribute information
Used by actions: DescribeKey, DescribeKeys, ListKeyDetail.
| Name | Type | Description |
|---|---|---|
| KeyId | String | Globally unique ID of the CMK. |
| Alias | String | An alias name as a key that is easier to identify and understand |
| CreateTime | Integer | Key creation time |
| Description | String | Description of the CMK. |
| KeyState | String | CMK state, value: Enabled | Disabled | PendingDelete | PendingImport | Archived |
| KeyUsage | String | CMK purpose. Value: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC |
| Type | Integer | CMK type. 2 means compliant with FIPS 140-2 standard. 4 means compliant with national cryptography standards. Enumeration value:
|
| CreatorUin | Integer | Creator. |
| KeyRotationEnabled | Boolean | Is key rotation function enabled? |
| Owner | String | Creator of the CMK. For user-created CMKs, the value is user. For CMKs auto-created by authorized Cloud services, the value is the corresponding product name. |
| NextRotateTime | Integer | The time when the next rotation occurs with key rotation enabled |
| DeletionDate | Integer | The time when schedule deletion |
| Origin | String | CMK key material type. TENCENT_KMS for those created by KMS, EXTERNAL for user import. |
| ValidTo | Integer | Valid when Origin is EXTERNAL. Indicates the expiration date of the key material. 0 means never expire. |
| ResourceId | String | Resource ID, format: creatorUin/$creatorUin/$keyId |
| HsmClusterId | String | HSM Cluster ID (only applicable to KMS exclusive/managed service instance) |
| RotateDays | Integer | Key rotation cycle (days) |
| LastRotateTime | Integer | Last rotation time (Unix timestamp). |
| IsSyncReplica | Integer | Whether the key is the primary replica. 0: primary replica, 1: synced replica. |
| SourceRegion | String | Synchronous original region |
| SyncStatus | Integer | Key synchronization state: 0: unsynced, 1: synced successfully, 2: synchronization failed, 3: syncing. |
| SyncMessages | String | Synchronous result description |
| SyncStartTime | Integer | Start time of synchronization |
| SyncEndTime | Integer | Synchronous end time |
| SourceHsmClusterId | String | Synchronous original cluster. If empty, it is a public cloud public cluster. |
| AccountAppId | Integer | Member account appId |
| AccountUin | Integer | member account uin |
| AccountName | String | Member account name |
| CreatorUinString | String | Creator UIN |
Shared member account information.
Used by actions: ArchiveKey, CancelDataKeyDeletion, CancelKeyArchive, CancelKeyDeletion, DescribeDataKey, DescribeDataKeys, DescribeKey, DescribeKeys, DisableDataKey, DisableDataKeys, DisableKey, DisableKeyRotation, DisableKeys, EnableDataKey, EnableDataKeys, EnableKey, EnableKeyRotation, EnableKeys, GetDataKeyCiphertextBlob, GetKeyRotationStatus, ListDataKeyDetail, ListKeyDetail, RotateKey, ScheduleDataKeyDeletion, ScheduleKeyDeletion, UpdateAlias, UpdateDataKeyDescription, UpdateDataKeyName, UpdateKeyDescription.
| Name | Type | Required | Description |
|---|---|---|---|
| MemberAppId | Integer | No | Member account appid. |
| MemberUin | Integer | No | Member account UIN |
Region extra QPS package
Used by actions: GetServiceStatus.
| Name | Type | Required | Description |
|---|---|---|---|
| Region | String | No | Region. |
| Qps | Integer | No | qps size |
Tag key and tag value
Used by actions: CreateKey, CreateWhiteBoxKey, GenerateDataKey, ImportDataKey.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | String | Yes | Tag value |
Tag filter
Used by actions: DescribeWhiteBoxKeyDetails, ListDataKeyDetail, ListKeyDetail.
| Name | Type | Required | Description |
|---|---|---|---|
| TagKey | String | Yes | Tag key |
| TagValue | Array of String | No | Tag value |
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 | Specifies whether there is a device fingerprint bound to the current key. |
Apakah halaman ini membantu?
Anda juga dapat Menghubungi Penjualan atau Mengirimkan Tiket untuk meminta bantuan.
masukan