Documentation ¶
Index ¶
- Constants
- type AlgorithmInfo
- type ArchiveKeyRequest
- type ArchiveKeyResponse
- type AsymmetricRsaDecryptRequest
- type AsymmetricRsaDecryptResponse
- type AsymmetricSm2DecryptRequest
- type AsymmetricSm2DecryptResponse
- type BindCloudResourceRequest
- type BindCloudResourceResponse
- type CancelKeyArchiveRequest
- type CancelKeyArchiveResponse
- type CancelKeyDeletionRequest
- type CancelKeyDeletionResponse
- type Client
- func (c *Client) ArchiveKey(request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)
- func (c *Client) ArchiveKeyWithContext(ctx context.Context, request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)
- func (c *Client) AsymmetricRsaDecrypt(request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)
- func (c *Client) AsymmetricRsaDecryptWithContext(ctx context.Context, request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)
- func (c *Client) AsymmetricSm2Decrypt(request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)
- func (c *Client) AsymmetricSm2DecryptWithContext(ctx context.Context, request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)
- func (c *Client) BindCloudResource(request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)
- func (c *Client) BindCloudResourceWithContext(ctx context.Context, request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)
- func (c *Client) CancelKeyArchive(request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)
- func (c *Client) CancelKeyArchiveWithContext(ctx context.Context, request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)
- func (c *Client) CancelKeyDeletion(request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)
- func (c *Client) CancelKeyDeletionWithContext(ctx context.Context, request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)
- func (c *Client) CreateKey(request *CreateKeyRequest) (response *CreateKeyResponse, err error)
- func (c *Client) CreateKeyWithContext(ctx context.Context, request *CreateKeyRequest) (response *CreateKeyResponse, err error)
- func (c *Client) CreateWhiteBoxKey(request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)
- func (c *Client) CreateWhiteBoxKeyWithContext(ctx context.Context, request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)
- func (c *Client) Decrypt(request *DecryptRequest) (response *DecryptResponse, err error)
- func (c *Client) DecryptWithContext(ctx context.Context, request *DecryptRequest) (response *DecryptResponse, err error)
- func (c *Client) DeleteImportedKeyMaterial(request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)
- func (c *Client) DeleteImportedKeyMaterialWithContext(ctx context.Context, request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)
- func (c *Client) DeleteWhiteBoxKey(request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)
- func (c *Client) DeleteWhiteBoxKeyWithContext(ctx context.Context, request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)
- func (c *Client) DescribeKey(request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)
- func (c *Client) DescribeKeyWithContext(ctx context.Context, request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)
- func (c *Client) DescribeKeys(request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)
- func (c *Client) DescribeKeysWithContext(ctx context.Context, request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)
- func (c *Client) DescribeWhiteBoxDecryptKey(request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)
- func (c *Client) DescribeWhiteBoxDecryptKeyWithContext(ctx context.Context, request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)
- func (c *Client) DescribeWhiteBoxDeviceFingerprints(request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)
- func (c *Client) DescribeWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)
- func (c *Client) DescribeWhiteBoxKey(request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)
- func (c *Client) DescribeWhiteBoxKeyDetails(request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)
- func (c *Client) DescribeWhiteBoxKeyDetailsWithContext(ctx context.Context, request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)
- func (c *Client) DescribeWhiteBoxKeyWithContext(ctx context.Context, request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)
- func (c *Client) DescribeWhiteBoxServiceStatus(request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)
- func (c *Client) DescribeWhiteBoxServiceStatusWithContext(ctx context.Context, request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)
- func (c *Client) DisableKey(request *DisableKeyRequest) (response *DisableKeyResponse, err error)
- func (c *Client) DisableKeyRotation(request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)
- func (c *Client) DisableKeyRotationWithContext(ctx context.Context, request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)
- func (c *Client) DisableKeyWithContext(ctx context.Context, request *DisableKeyRequest) (response *DisableKeyResponse, err error)
- func (c *Client) DisableKeys(request *DisableKeysRequest) (response *DisableKeysResponse, err error)
- func (c *Client) DisableKeysWithContext(ctx context.Context, request *DisableKeysRequest) (response *DisableKeysResponse, err error)
- func (c *Client) DisableWhiteBoxKey(request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)
- func (c *Client) DisableWhiteBoxKeyWithContext(ctx context.Context, request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)
- func (c *Client) DisableWhiteBoxKeys(request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)
- func (c *Client) DisableWhiteBoxKeysWithContext(ctx context.Context, request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)
- func (c *Client) EnableKey(request *EnableKeyRequest) (response *EnableKeyResponse, err error)
- func (c *Client) EnableKeyRotation(request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)
- func (c *Client) EnableKeyRotationWithContext(ctx context.Context, request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)
- func (c *Client) EnableKeyWithContext(ctx context.Context, request *EnableKeyRequest) (response *EnableKeyResponse, err error)
- func (c *Client) EnableKeys(request *EnableKeysRequest) (response *EnableKeysResponse, err error)
- func (c *Client) EnableKeysWithContext(ctx context.Context, request *EnableKeysRequest) (response *EnableKeysResponse, err error)
- func (c *Client) EnableWhiteBoxKey(request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)
- func (c *Client) EnableWhiteBoxKeyWithContext(ctx context.Context, request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)
- func (c *Client) EnableWhiteBoxKeys(request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)
- func (c *Client) EnableWhiteBoxKeysWithContext(ctx context.Context, request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)
- func (c *Client) Encrypt(request *EncryptRequest) (response *EncryptResponse, err error)
- func (c *Client) EncryptByWhiteBox(request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)
- func (c *Client) EncryptByWhiteBoxWithContext(ctx context.Context, request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)
- func (c *Client) EncryptWithContext(ctx context.Context, request *EncryptRequest) (response *EncryptResponse, err error)
- func (c *Client) GenerateDataKey(request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)
- func (c *Client) GenerateDataKeyWithContext(ctx context.Context, request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)
- func (c *Client) GenerateRandom(request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)
- func (c *Client) GenerateRandomWithContext(ctx context.Context, request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)
- func (c *Client) GetKeyRotationStatus(request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)
- func (c *Client) GetKeyRotationStatusWithContext(ctx context.Context, request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)
- func (c *Client) GetParametersForImport(request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)
- func (c *Client) GetParametersForImportWithContext(ctx context.Context, request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)
- func (c *Client) GetPublicKey(request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)
- func (c *Client) GetPublicKeyWithContext(ctx context.Context, request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)
- func (c *Client) GetRegions(request *GetRegionsRequest) (response *GetRegionsResponse, err error)
- func (c *Client) GetRegionsWithContext(ctx context.Context, request *GetRegionsRequest) (response *GetRegionsResponse, err error)
- func (c *Client) GetServiceStatus(request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)
- func (c *Client) GetServiceStatusWithContext(ctx context.Context, request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)
- func (c *Client) ImportKeyMaterial(request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)
- func (c *Client) ImportKeyMaterialWithContext(ctx context.Context, request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)
- func (c *Client) ListAlgorithms(request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)
- func (c *Client) ListAlgorithmsWithContext(ctx context.Context, request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)
- func (c *Client) ListKeyDetail(request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)
- func (c *Client) ListKeyDetailWithContext(ctx context.Context, request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)
- func (c *Client) ListKeys(request *ListKeysRequest) (response *ListKeysResponse, err error)
- func (c *Client) ListKeysWithContext(ctx context.Context, request *ListKeysRequest) (response *ListKeysResponse, err error)
- func (c *Client) OverwriteWhiteBoxDeviceFingerprints(request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)
- func (c *Client) OverwriteWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)
- func (c *Client) ReEncrypt(request *ReEncryptRequest) (response *ReEncryptResponse, err error)
- func (c *Client) ReEncryptWithContext(ctx context.Context, request *ReEncryptRequest) (response *ReEncryptResponse, err error)
- func (c *Client) ScheduleKeyDeletion(request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)
- func (c *Client) ScheduleKeyDeletionWithContext(ctx context.Context, request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)
- func (c *Client) SignByAsymmetricKey(request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)
- func (c *Client) SignByAsymmetricKeyWithContext(ctx context.Context, request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)
- func (c *Client) UnbindCloudResource(request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)
- func (c *Client) UnbindCloudResourceWithContext(ctx context.Context, request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)
- func (c *Client) UpdateAlias(request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)
- func (c *Client) UpdateAliasWithContext(ctx context.Context, request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)
- func (c *Client) UpdateKeyDescription(request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)
- func (c *Client) UpdateKeyDescriptionWithContext(ctx context.Context, request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)
- func (c *Client) VerifyByAsymmetricKey(request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)
- func (c *Client) VerifyByAsymmetricKeyWithContext(ctx context.Context, request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)
- type CreateKeyRequest
- type CreateKeyResponse
- type CreateWhiteBoxKeyRequest
- type CreateWhiteBoxKeyResponse
- type DecryptRequest
- type DecryptResponse
- type DeleteImportedKeyMaterialRequest
- type DeleteImportedKeyMaterialResponse
- type DeleteWhiteBoxKeyRequest
- type DeleteWhiteBoxKeyResponse
- type DescribeKeyRequest
- type DescribeKeyResponse
- type DescribeKeysRequest
- type DescribeKeysResponse
- type DescribeWhiteBoxDecryptKeyRequest
- type DescribeWhiteBoxDecryptKeyResponse
- type DescribeWhiteBoxDeviceFingerprintsRequest
- type DescribeWhiteBoxDeviceFingerprintsResponse
- type DescribeWhiteBoxKeyDetailsRequest
- type DescribeWhiteBoxKeyDetailsResponse
- type DescribeWhiteBoxKeyRequest
- type DescribeWhiteBoxKeyResponse
- type DescribeWhiteBoxServiceStatusRequest
- type DescribeWhiteBoxServiceStatusResponse
- type DeviceFingerprint
- type DisableKeyRequest
- type DisableKeyResponse
- type DisableKeyRotationRequest
- type DisableKeyRotationResponse
- type DisableKeysRequest
- type DisableKeysResponse
- type DisableWhiteBoxKeyRequest
- type DisableWhiteBoxKeyResponse
- type DisableWhiteBoxKeysRequest
- type DisableWhiteBoxKeysResponse
- type EnableKeyRequest
- type EnableKeyResponse
- type EnableKeyRotationRequest
- type EnableKeyRotationResponse
- type EnableKeysRequest
- type EnableKeysResponse
- type EnableWhiteBoxKeyRequest
- type EnableWhiteBoxKeyResponse
- type EnableWhiteBoxKeysRequest
- type EnableWhiteBoxKeysResponse
- type EncryptByWhiteBoxRequest
- type EncryptByWhiteBoxResponse
- type EncryptRequest
- type EncryptResponse
- type GenerateDataKeyRequest
- type GenerateDataKeyResponse
- type GenerateRandomRequest
- type GenerateRandomResponse
- type GetKeyRotationStatusRequest
- type GetKeyRotationStatusResponse
- type GetParametersForImportRequest
- type GetParametersForImportResponse
- type GetPublicKeyRequest
- type GetPublicKeyResponse
- type GetRegionsRequest
- type GetRegionsResponse
- type GetServiceStatusRequest
- type GetServiceStatusResponse
- type ImportKeyMaterialRequest
- type ImportKeyMaterialResponse
- type Key
- type KeyMetadata
- type ListAlgorithmsRequest
- type ListAlgorithmsResponse
- type ListKeyDetailRequest
- type ListKeyDetailResponse
- type ListKeysRequest
- type ListKeysResponse
- type OverwriteWhiteBoxDeviceFingerprintsRequest
- type OverwriteWhiteBoxDeviceFingerprintsResponse
- type ReEncryptRequest
- type ReEncryptResponse
- type ScheduleKeyDeletionRequest
- type ScheduleKeyDeletionResponse
- type SignByAsymmetricKeyRequest
- type SignByAsymmetricKeyResponse
- type Tag
- type TagFilter
- type UnbindCloudResourceRequest
- type UnbindCloudResourceResponse
- type UpdateAliasRequest
- type UpdateAliasResponse
- type UpdateKeyDescriptionRequest
- type UpdateKeyDescriptionResponse
- type VerifyByAsymmetricKeyRequest
- type VerifyByAsymmetricKeyResponse
- type WhiteboxKeyInfo
Constants ¶
const ( // CAM signature/authentication error AUTHFAILURE = "AuthFailure" // Operation failed. FAILEDOPERATION = "FailedOperation" // The CMK is being used by a Tencent Cloud product. FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" // Decryption failed. FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError" // Internal error. INTERNALERROR = "InternalError" // Invalid parameter. INVALIDPARAMETER = "InvalidParameter" // Decryption of `EncryptedKeyMaterial` failed. INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError" // The schedule deletion time parameter is invalid. INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays" // Incorrect parameter value. INVALIDPARAMETERVALUE = "InvalidParameterValue" // The alias already exists. INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" // Duplicate `KeyId`. INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" // Incorrect alias format INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" // Incorrect ciphertext format INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext" // Invalid `KeyId`. INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" // Incorrect `KeyUsage` parameter. INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" // Invalid `Plaintext`. INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext" // Incorrect `Type` parameter. INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType" // The key material is different from the one previously imported. INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch" // Duplicate tag key. INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated" // The tag key or tag value does not exist. INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted" // The number of CMKs has reached the upper limit. LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded" // The number of device fingerprints exceeded the limit. LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded" // The number of created keys exceeded the limit. LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // The CMK is not bound with the Tencent Cloud resource RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound" // The CMK has been archived. RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived" // The CMK has been disabled. RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" // The CMK does not exist. RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" // As the CMK is not scheduled for deletion, you cannot cancel the schedule deletion. RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete" // An enabled CMK cannot be scheduled for deletion. RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled" // This operation cannot be performed under the current CMK status. RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" // The key has been disabled. RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled" // The white-box key service has not been activated. RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" // Token has expired. RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired" // Unauthorized operation. UNAUTHORIZEDOPERATION = "UnauthorizedOperation" // External CMKs cannot be rotated. UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate" // Incorrect CMK type. Only `External` CMKs are supported. UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" // You can only update the CMKs created by you. UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk" // The service is temporarily unavailable. UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable" // The encryption method is not supported in the current region. UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion" )
const APIVersion = "2019-01-18"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AlgorithmInfo ¶
type ArchiveKeyRequest ¶
type ArchiveKeyRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewArchiveKeyRequest ¶
func NewArchiveKeyRequest() (request *ArchiveKeyRequest)
func (*ArchiveKeyRequest) FromJsonString ¶
func (r *ArchiveKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ArchiveKeyRequest) ToJsonString ¶
func (r *ArchiveKeyRequest) ToJsonString() string
type ArchiveKeyResponse ¶
type ArchiveKeyResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewArchiveKeyResponse ¶
func NewArchiveKeyResponse() (response *ArchiveKeyResponse)
func (*ArchiveKeyResponse) FromJsonString ¶
func (r *ArchiveKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ArchiveKeyResponse) ToJsonString ¶
func (r *ArchiveKeyResponse) ToJsonString() string
type AsymmetricRsaDecryptRequest ¶
type AsymmetricRsaDecryptRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Base64-encoded ciphertext encrypted with `PublicKey` Ciphertext *string `json:"Ciphertext,omitempty" name:"Ciphertext"` // Corresponding algorithm when a public key is used for encryption. Valid values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256 Algorithm *string `json:"Algorithm,omitempty" name:"Algorithm"` }
func NewAsymmetricRsaDecryptRequest ¶
func NewAsymmetricRsaDecryptRequest() (request *AsymmetricRsaDecryptRequest)
func (*AsymmetricRsaDecryptRequest) FromJsonString ¶
func (r *AsymmetricRsaDecryptRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AsymmetricRsaDecryptRequest) ToJsonString ¶
func (r *AsymmetricRsaDecryptRequest) ToJsonString() string
type AsymmetricRsaDecryptResponse ¶
type AsymmetricRsaDecryptResponse struct { *tchttp.BaseResponse Response *struct { // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Base64-encoded plaintext after decryption Plaintext *string `json:"Plaintext,omitempty" name:"Plaintext"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewAsymmetricRsaDecryptResponse ¶
func NewAsymmetricRsaDecryptResponse() (response *AsymmetricRsaDecryptResponse)
func (*AsymmetricRsaDecryptResponse) FromJsonString ¶
func (r *AsymmetricRsaDecryptResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AsymmetricRsaDecryptResponse) ToJsonString ¶
func (r *AsymmetricRsaDecryptResponse) ToJsonString() string
type AsymmetricSm2DecryptRequest ¶
type AsymmetricSm2DecryptRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Base64-encoded ciphertext encrypted with `PublicKey`, whose length cannot exceed 256 bytes. Ciphertext *string `json:"Ciphertext,omitempty" name:"Ciphertext"` }
func NewAsymmetricSm2DecryptRequest ¶
func NewAsymmetricSm2DecryptRequest() (request *AsymmetricSm2DecryptRequest)
func (*AsymmetricSm2DecryptRequest) FromJsonString ¶
func (r *AsymmetricSm2DecryptRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AsymmetricSm2DecryptRequest) ToJsonString ¶
func (r *AsymmetricSm2DecryptRequest) ToJsonString() string
type AsymmetricSm2DecryptResponse ¶
type AsymmetricSm2DecryptResponse struct { *tchttp.BaseResponse Response *struct { // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Base64-encoded plaintext after decryption Plaintext *string `json:"Plaintext,omitempty" name:"Plaintext"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewAsymmetricSm2DecryptResponse ¶
func NewAsymmetricSm2DecryptResponse() (response *AsymmetricSm2DecryptResponse)
func (*AsymmetricSm2DecryptResponse) FromJsonString ¶
func (r *AsymmetricSm2DecryptResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AsymmetricSm2DecryptResponse) ToJsonString ¶
func (r *AsymmetricSm2DecryptResponse) ToJsonString() string
type BindCloudResourceRequest ¶
type BindCloudResourceRequest struct { *tchttp.BaseRequest // CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Unique ID of a Tencent Cloud service ProductId *string `json:"ProductId,omitempty" name:"ProductId"` // Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features. ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"` }
func NewBindCloudResourceRequest ¶
func NewBindCloudResourceRequest() (request *BindCloudResourceRequest)
func (*BindCloudResourceRequest) FromJsonString ¶
func (r *BindCloudResourceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindCloudResourceRequest) ToJsonString ¶
func (r *BindCloudResourceRequest) ToJsonString() string
type BindCloudResourceResponse ¶
type BindCloudResourceResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewBindCloudResourceResponse ¶
func NewBindCloudResourceResponse() (response *BindCloudResourceResponse)
func (*BindCloudResourceResponse) FromJsonString ¶
func (r *BindCloudResourceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*BindCloudResourceResponse) ToJsonString ¶
func (r *BindCloudResourceResponse) ToJsonString() string
type CancelKeyArchiveRequest ¶
type CancelKeyArchiveRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewCancelKeyArchiveRequest ¶
func NewCancelKeyArchiveRequest() (request *CancelKeyArchiveRequest)
func (*CancelKeyArchiveRequest) FromJsonString ¶
func (r *CancelKeyArchiveRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CancelKeyArchiveRequest) ToJsonString ¶
func (r *CancelKeyArchiveRequest) ToJsonString() string
type CancelKeyArchiveResponse ¶
type CancelKeyArchiveResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCancelKeyArchiveResponse ¶
func NewCancelKeyArchiveResponse() (response *CancelKeyArchiveResponse)
func (*CancelKeyArchiveResponse) FromJsonString ¶
func (r *CancelKeyArchiveResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CancelKeyArchiveResponse) ToJsonString ¶
func (r *CancelKeyArchiveResponse) ToJsonString() string
type CancelKeyDeletionRequest ¶
type CancelKeyDeletionRequest struct { *tchttp.BaseRequest // Unique ID of the CMK for which to cancel schedule deletion KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewCancelKeyDeletionRequest ¶
func NewCancelKeyDeletionRequest() (request *CancelKeyDeletionRequest)
func (*CancelKeyDeletionRequest) FromJsonString ¶
func (r *CancelKeyDeletionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CancelKeyDeletionRequest) ToJsonString ¶
func (r *CancelKeyDeletionRequest) ToJsonString() string
type CancelKeyDeletionResponse ¶
type CancelKeyDeletionResponse struct { *tchttp.BaseResponse Response *struct { // Unique ID of the CMK for which the schedule deletion is canceled KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCancelKeyDeletionResponse ¶
func NewCancelKeyDeletionResponse() (response *CancelKeyDeletionResponse)
func (*CancelKeyDeletionResponse) FromJsonString ¶
func (r *CancelKeyDeletionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CancelKeyDeletionResponse) ToJsonString ¶
func (r *CancelKeyDeletionResponse) ToJsonString() string
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) ArchiveKey ¶
func (c *Client) ArchiveKey(request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)
ArchiveKey This API is used to archive keys. The archived keys can only be used for decryption but not encryption.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) ArchiveKeyWithContext ¶
func (c *Client) ArchiveKeyWithContext(ctx context.Context, request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)
ArchiveKey This API is used to archive keys. The archived keys can only be used for decryption but not encryption.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) AsymmetricRsaDecrypt ¶
func (c *Client) AsymmetricRsaDecrypt(request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)
AsymmetricRsaDecrypt This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption.
error code that may be returned:
FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) AsymmetricRsaDecryptWithContext ¶
func (c *Client) AsymmetricRsaDecryptWithContext(ctx context.Context, request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)
AsymmetricRsaDecrypt This API is used to decrypt data with the specified private key that is encrypted with RSA asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption.
error code that may be returned:
FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) AsymmetricSm2Decrypt ¶
func (c *Client) AsymmetricSm2Decrypt(request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)
AsymmetricSm2Decrypt This API is used to decrypt data with the specified private key that is encrypted with SM2 asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption. The length of the ciphertext passed in cannot exceed 256 bytes.
error code that may be returned:
FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"
func (*Client) AsymmetricSm2DecryptWithContext ¶
func (c *Client) AsymmetricSm2DecryptWithContext(ctx context.Context, request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)
AsymmetricSm2Decrypt This API is used to decrypt data with the specified private key that is encrypted with SM2 asymmetric cryptographic algorithm. The ciphertext must be encrypted with the corresponding public key. The asymmetric key must be in `Enabled` state for decryption. The length of the ciphertext passed in cannot exceed 256 bytes.
error code that may be returned:
FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"
func (*Client) BindCloudResource ¶
func (c *Client) BindCloudResource(request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)
BindCloudResource This API is used to bind a key with a Tencent Cloud resource. If the key has been set to be expired automatically, the setting will be canceled to ensure that the key will not be invalid automatically. If the key and the resource has already been bound, the call will still be successful.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) BindCloudResourceWithContext ¶
func (c *Client) BindCloudResourceWithContext(ctx context.Context, request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)
BindCloudResource This API is used to bind a key with a Tencent Cloud resource. If the key has been set to be expired automatically, the setting will be canceled to ensure that the key will not be invalid automatically. If the key and the resource has already been bound, the call will still be successful.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) CancelKeyArchive ¶
func (c *Client) CancelKeyArchive(request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)
CancelKeyArchive This API is used to unarchive keys. If a key is unarchived, its status will be `Enabled`.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) CancelKeyArchiveWithContext ¶
func (c *Client) CancelKeyArchiveWithContext(ctx context.Context, request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)
CancelKeyArchive This API is used to unarchive keys. If a key is unarchived, its status will be `Enabled`.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) CancelKeyDeletion ¶
func (c *Client) CancelKeyDeletion(request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)
CancelKeyDeletion Cancel the scheduled deletion of CMK
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) CancelKeyDeletionWithContext ¶
func (c *Client) CancelKeyDeletionWithContext(ctx context.Context, request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)
CancelKeyDeletion Cancel the scheduled deletion of CMK
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) CreateKey ¶
func (c *Client) CreateKey(request *CreateKeyRequest) (response *CreateKeyResponse, err error)
CreateKey Create a master key CMK (Custom Master Key) for user management data keys
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType" INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated" INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted" LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable" UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"
func (*Client) CreateKeyWithContext ¶
func (c *Client) CreateKeyWithContext(ctx context.Context, request *CreateKeyRequest) (response *CreateKeyResponse, err error)
CreateKey Create a master key CMK (Custom Master Key) for user management data keys
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage" INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType" INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated" INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted" LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable" UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"
func (*Client) CreateWhiteBoxKey ¶
func (c *Client) CreateWhiteBoxKey(request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)
CreateWhiteBoxKey This API is used to create a white-box key. Up to 50 ones can be created.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated" INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted" LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) CreateWhiteBoxKeyWithContext ¶
func (c *Client) CreateWhiteBoxKeyWithContext(ctx context.Context, request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)
CreateWhiteBoxKey This API is used to create a white-box key. Up to 50 ones can be created.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated" INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted" LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) Decrypt ¶
func (c *Client) Decrypt(request *DecryptRequest) (response *DecryptResponse, err error)
Decrypt This API is used to decrypt the ciphertext and obtain the plaintext data.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DecryptWithContext ¶
func (c *Client) DecryptWithContext(ctx context.Context, request *DecryptRequest) (response *DecryptResponse, err error)
Decrypt This API is used to decrypt the ciphertext and obtain the plaintext data.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DeleteImportedKeyMaterial ¶
func (c *Client) DeleteImportedKeyMaterial(request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)
DeleteImportedKeyMaterial This API is used to delete the imported key material. It is only valid for EXTERNAL CMKs. Specifically, it puts a CMK into `PendingImport` status instead of deleting the CMK, so that the CMK can be used again after key material is reimported. To delete the CMK completely, please call the `ScheduleKeyDeletion` API.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) DeleteImportedKeyMaterialWithContext ¶
func (c *Client) DeleteImportedKeyMaterialWithContext(ctx context.Context, request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)
DeleteImportedKeyMaterial This API is used to delete the imported key material. It is only valid for EXTERNAL CMKs. Specifically, it puts a CMK into `PendingImport` status instead of deleting the CMK, so that the CMK can be used again after key material is reimported. To delete the CMK completely, please call the `ScheduleKeyDeletion` API.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) DeleteWhiteBoxKey ¶
func (c *Client) DeleteWhiteBoxKey(request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)
DeleteWhiteBoxKey This API is used to delete a white-box key. Note: only disabled white-box keys can be deleted.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DeleteWhiteBoxKeyWithContext ¶
func (c *Client) DeleteWhiteBoxKeyWithContext(ctx context.Context, request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)
DeleteWhiteBoxKey This API is used to delete a white-box key. Note: only disabled white-box keys can be deleted.
error code that may be returned:
FAILEDOPERATION = "FailedOperation" INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeKey ¶
func (c *Client) DescribeKey(request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)
DescribeKey This API is used to get the attribute details of the CMK with a specified `KeyId`.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeKeyWithContext ¶
func (c *Client) DescribeKeyWithContext(ctx context.Context, request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)
DescribeKey This API is used to get the attribute details of the CMK with a specified `KeyId`.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeKeys ¶
func (c *Client) DescribeKeys(request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)
DescribeKeys This API is used to get the attribute information of CMKs in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeKeysWithContext ¶
func (c *Client) DescribeKeysWithContext(ctx context.Context, request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)
DescribeKeys This API is used to get the attribute information of CMKs in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxDecryptKey ¶
func (c *Client) DescribeWhiteBoxDecryptKey(request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)
DescribeWhiteBoxDecryptKey This API is used to get a white-box decryption key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxDecryptKeyWithContext ¶
func (c *Client) DescribeWhiteBoxDecryptKeyWithContext(ctx context.Context, request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)
DescribeWhiteBoxDecryptKey This API is used to get a white-box decryption key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxDeviceFingerprints ¶
func (c *Client) DescribeWhiteBoxDeviceFingerprints(request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)
DescribeWhiteBoxDeviceFingerprints This API is used to get the device fingerprint list of a specified key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxDeviceFingerprintsWithContext ¶
func (c *Client) DescribeWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)
DescribeWhiteBoxDeviceFingerprints This API is used to get the device fingerprint list of a specified key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxKey ¶
func (c *Client) DescribeWhiteBoxKey(request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)
DescribeWhiteBoxKey This API is used to display white-box key information.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxKeyDetails ¶
func (c *Client) DescribeWhiteBoxKeyDetails(request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)
DescribeWhiteBoxKeyDetails This API is used to get the white-box key list.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxKeyDetailsWithContext ¶
func (c *Client) DescribeWhiteBoxKeyDetailsWithContext(ctx context.Context, request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)
DescribeWhiteBoxKeyDetails This API is used to get the white-box key list.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxKeyWithContext ¶
func (c *Client) DescribeWhiteBoxKeyWithContext(ctx context.Context, request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)
DescribeWhiteBoxKey This API is used to display white-box key information.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxServiceStatus ¶
func (c *Client) DescribeWhiteBoxServiceStatus(request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)
DescribeWhiteBoxServiceStatus This API is used to get the white-box key service status.
error code that may be returned:
INTERNALERROR = "InternalError" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DescribeWhiteBoxServiceStatusWithContext ¶
func (c *Client) DescribeWhiteBoxServiceStatusWithContext(ctx context.Context, request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)
DescribeWhiteBoxServiceStatus This API is used to get the white-box key service status.
error code that may be returned:
INTERNALERROR = "InternalError" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DisableKey ¶
func (c *Client) DisableKey(request *DisableKeyRequest) (response *DisableKeyResponse, err error)
DisableKey This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) DisableKeyRotation ¶
func (c *Client) DisableKeyRotation(request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)
DisableKeyRotation Disabled key rotation for the specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DisableKeyRotationWithContext ¶
func (c *Client) DisableKeyRotationWithContext(ctx context.Context, request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)
DisableKeyRotation Disabled key rotation for the specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DisableKeyWithContext ¶
func (c *Client) DisableKeyWithContext(ctx context.Context, request *DisableKeyRequest) (response *DisableKeyResponse, err error)
DisableKey This API is used to disable a master key. The disabled key cannot be used for encryption and decryption operations.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) DisableKeys ¶
func (c *Client) DisableKeys(request *DisableKeysRequest) (response *DisableKeysResponse, err error)
DisableKeys This API is used to batch prohibit the use of CMK.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) DisableKeysWithContext ¶
func (c *Client) DisableKeysWithContext(ctx context.Context, request *DisableKeysRequest) (response *DisableKeysResponse, err error)
DisableKeys This API is used to batch prohibit the use of CMK.
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) DisableWhiteBoxKey ¶
func (c *Client) DisableWhiteBoxKey(request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)
DisableWhiteBoxKey This API is used to disable a white-box key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DisableWhiteBoxKeyWithContext ¶
func (c *Client) DisableWhiteBoxKeyWithContext(ctx context.Context, request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)
DisableWhiteBoxKey This API is used to disable a white-box key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DisableWhiteBoxKeys ¶
func (c *Client) DisableWhiteBoxKeys(request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)
DisableWhiteBoxKeys This API is used to disable white-box keys in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) DisableWhiteBoxKeysWithContext ¶
func (c *Client) DisableWhiteBoxKeysWithContext(ctx context.Context, request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)
DisableWhiteBoxKeys This API is used to disable white-box keys in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EnableKey ¶
func (c *Client) EnableKey(request *EnableKeyRequest) (response *EnableKeyResponse, err error)
EnableKey Enable a specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) EnableKeyRotation ¶
func (c *Client) EnableKeyRotation(request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)
EnableKeyRotation Turn on the key rotation function for the specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) EnableKeyRotationWithContext ¶
func (c *Client) EnableKeyRotationWithContext(ctx context.Context, request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)
EnableKeyRotation Turn on the key rotation function for the specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) EnableKeyWithContext ¶
func (c *Client) EnableKeyWithContext(ctx context.Context, request *EnableKeyRequest) (response *EnableKeyResponse, err error)
EnableKey Enable a specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) EnableKeys ¶
func (c *Client) EnableKeys(request *EnableKeysRequest) (response *EnableKeysResponse, err error)
EnableKeys This API is used to enable CMK in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) EnableKeysWithContext ¶
func (c *Client) EnableKeysWithContext(ctx context.Context, request *EnableKeysRequest) (response *EnableKeysResponse, err error)
EnableKeys This API is used to enable CMK in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) EnableWhiteBoxKey ¶
func (c *Client) EnableWhiteBoxKey(request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)
EnableWhiteBoxKey This API is used to enable a white-box key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EnableWhiteBoxKeyWithContext ¶
func (c *Client) EnableWhiteBoxKeyWithContext(ctx context.Context, request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)
EnableWhiteBoxKey This API is used to enable a white-box key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EnableWhiteBoxKeys ¶
func (c *Client) EnableWhiteBoxKeys(request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)
EnableWhiteBoxKeys This API is used to enable white-box keys in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EnableWhiteBoxKeysWithContext ¶
func (c *Client) EnableWhiteBoxKeysWithContext(ctx context.Context, request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)
EnableWhiteBoxKeys This API is used to enable white-box keys in batches.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) Encrypt ¶
func (c *Client) Encrypt(request *EncryptRequest) (response *EncryptResponse, err error)
Encrypt This API is used to encrypt any data up to 4KB. It can be used to encrypt database passwords, RSA Key, or other small sensitive information. For application data encryption, use the DataKey generated by GenerateDataKey to perform local data encryption and decryption operations
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext" RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EncryptByWhiteBox ¶
func (c *Client) EncryptByWhiteBox(request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)
EncryptByWhiteBox This API is used to encrypt data with a white-box key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EncryptByWhiteBoxWithContext ¶
func (c *Client) EncryptByWhiteBoxWithContext(ctx context.Context, request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)
EncryptByWhiteBox This API is used to encrypt data with a white-box key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) EncryptWithContext ¶
func (c *Client) EncryptWithContext(ctx context.Context, request *EncryptRequest) (response *EncryptResponse, err error)
Encrypt This API is used to encrypt any data up to 4KB. It can be used to encrypt database passwords, RSA Key, or other small sensitive information. For application data encryption, use the DataKey generated by GenerateDataKey to perform local data encryption and decryption operations
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext" RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GenerateDataKey ¶
func (c *Client) GenerateDataKey(request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)
GenerateDataKey This API generates a data key, which you can use to encrypt local data.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GenerateDataKeyWithContext ¶
func (c *Client) GenerateDataKeyWithContext(ctx context.Context, request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)
GenerateDataKey This API generates a data key, which you can use to encrypt local data.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GenerateRandom ¶
func (c *Client) GenerateRandom(request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)
GenerateRandom This API is used to generate a random number.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GenerateRandomWithContext ¶
func (c *Client) GenerateRandomWithContext(ctx context.Context, request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)
GenerateRandom This API is used to generate a random number.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GetKeyRotationStatus ¶
func (c *Client) GetKeyRotationStatus(request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)
GetKeyRotationStatus Query whether the specified CMK has the key rotation function.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GetKeyRotationStatusWithContext ¶
func (c *Client) GetKeyRotationStatusWithContext(ctx context.Context, request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)
GetKeyRotationStatus Query whether the specified CMK has the key rotation function.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GetParametersForImport ¶
func (c *Client) GetParametersForImport(request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)
GetParametersForImport This API is used to obtain the parameters of the material to be imported into a CMK. The returned `Token` is used as one of the parameters to execute `ImportKeyMaterial`, and the returned `PublicKey` is used to encrypt the key material. The `Token` and `PublicKey` are valid for 24 hours. If they are expired, you will need to call the API again to get a new `Token` and `PublicKey`.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) GetParametersForImportWithContext ¶
func (c *Client) GetParametersForImportWithContext(ctx context.Context, request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)
GetParametersForImport This API is used to obtain the parameters of the material to be imported into a CMK. The returned `Token` is used as one of the parameters to execute `ImportKeyMaterial`, and the returned `PublicKey` is used to encrypt the key material. The `Token` and `PublicKey` are valid for 24 hours. If they are expired, you will need to call the API again to get a new `Token` and `PublicKey`.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) GetPublicKey ¶
func (c *Client) GetPublicKey(request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)
GetPublicKey This API is used to get the information of the public key that is encrypted with the asymmetric cryptographic algorithm and of which the `KeyUsage` is `ASYMMETRIC_DECRYPT_RSA_2048` or `ASYMMETRIC_DECRYPT_SM2`. This public key can be used to encrypt data locally, and the data encrypted with it can only be decrypted with the corresponding private key through KMS. The public key can only be obtained from the asymmetric key in `Enabled` state.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GetPublicKeyWithContext ¶
func (c *Client) GetPublicKeyWithContext(ctx context.Context, request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)
GetPublicKey This API is used to get the information of the public key that is encrypted with the asymmetric cryptographic algorithm and of which the `KeyUsage` is `ASYMMETRIC_DECRYPT_RSA_2048` or `ASYMMETRIC_DECRYPT_SM2`. This public key can be used to encrypt data locally, and the data encrypted with it can only be decrypted with the corresponding private key through KMS. The public key can only be obtained from the asymmetric key in `Enabled` state.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GetRegions ¶
func (c *Client) GetRegions(request *GetRegionsRequest) (response *GetRegionsResponse, err error)
GetRegions This API is used to obtain the list of supported regions.
error code that may be returned:
INTERNALERROR = "InternalError"
func (*Client) GetRegionsWithContext ¶
func (c *Client) GetRegionsWithContext(ctx context.Context, request *GetRegionsRequest) (response *GetRegionsResponse, err error)
GetRegions This API is used to obtain the list of supported regions.
error code that may be returned:
INTERNALERROR = "InternalError"
func (*Client) GetServiceStatus ¶
func (c *Client) GetServiceStatus(request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)
GetServiceStatus Used to query whether the user has activated the KMS service.
error code that may be returned:
INTERNALERROR = "InternalError" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) GetServiceStatusWithContext ¶
func (c *Client) GetServiceStatusWithContext(ctx context.Context, request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)
GetServiceStatus Used to query whether the user has activated the KMS service.
error code that may be returned:
INTERNALERROR = "InternalError" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ImportKeyMaterial ¶
func (c *Client) ImportKeyMaterial(request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)
ImportKeyMaterial This API is used to import key material into an EXTERNAL CMK. The key obtained through the `GetParametersForImport` API is used to encrypt the key material. You can only reimport the same key material into the specified CMK and set a new expiration time. After the CMK key material is imported, it cannot be replaced. After the key material is expired or deleted, the CMK will remain unavailable until the same key material is reimported. CMKs are independent, which means that the same key material can be imported into different CMKs, but data encrypted by one CMK cannot be decrypted by another one.
Key material can only be imported into CMKs in `Enabled` and `PendingImport` status.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError" INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired" UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) ImportKeyMaterialWithContext ¶
func (c *Client) ImportKeyMaterialWithContext(ctx context.Context, request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)
ImportKeyMaterial This API is used to import key material into an EXTERNAL CMK. The key obtained through the `GetParametersForImport` API is used to encrypt the key material. You can only reimport the same key material into the specified CMK and set a new expiration time. After the CMK key material is imported, it cannot be replaced. After the key material is expired or deleted, the CMK will remain unavailable until the same key material is reimported. CMKs are independent, which means that the same key material can be imported into different CMKs, but data encrypted by one CMK cannot be decrypted by another one.
Key material can only be imported into CMKs in `Enabled` and `PendingImport` status.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError" INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired" UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) ListAlgorithms ¶
func (c *Client) ListAlgorithms(request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)
ListAlgorithms This API is used to list the encryption methods supported in the current region.
error code that may be returned:
INTERNALERROR = "InternalError" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ListAlgorithmsWithContext ¶
func (c *Client) ListAlgorithmsWithContext(ctx context.Context, request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)
ListAlgorithms This API is used to list the encryption methods supported in the current region.
error code that may be returned:
INTERNALERROR = "InternalError" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ListKeyDetail ¶
func (c *Client) ListKeyDetail(request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)
ListKeyDetail Get the master key list details according to the specified Offset and Limit.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ListKeyDetailWithContext ¶
func (c *Client) ListKeyDetailWithContext(ctx context.Context, request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)
ListKeyDetail Get the master key list details according to the specified Offset and Limit.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ListKeys ¶
func (c *Client) ListKeys(request *ListKeysRequest) (response *ListKeysResponse, err error)
ListKeys This API is used to list the KeyIds of CMKs in `Enabled`, `Disabled`, and `PendingImport` status under the account.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ListKeysWithContext ¶
func (c *Client) ListKeysWithContext(ctx context.Context, request *ListKeysRequest) (response *ListKeysResponse, err error)
ListKeys This API is used to list the KeyIds of CMKs in `Enabled`, `Disabled`, and `PendingImport` status under the account.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) OverwriteWhiteBoxDeviceFingerprints ¶
func (c *Client) OverwriteWhiteBoxDeviceFingerprints(request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)
OverwriteWhiteBoxDeviceFingerprints This API is used to overwrite the device fingerprint information of a specified key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) OverwriteWhiteBoxDeviceFingerprintsWithContext ¶
func (c *Client) OverwriteWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)
OverwriteWhiteBoxDeviceFingerprints This API is used to overwrite the device fingerprint information of a specified key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded" RESOURCENOTFOUND = "ResourceNotFound" RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ReEncrypt ¶
func (c *Client) ReEncrypt(request *ReEncryptRequest) (response *ReEncryptResponse, err error)
ReEncrypt Re-encrypt the ciphertext using the specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ReEncryptWithContext ¶
func (c *Client) ReEncryptWithContext(ctx context.Context, request *ReEncryptRequest) (response *ReEncryptResponse, err error)
ReEncrypt Re-encrypt the ciphertext using the specified CMK.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
func (*Client) ScheduleKeyDeletion ¶
func (c *Client) ScheduleKeyDeletion(request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)
ScheduleKeyDeletion CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) ScheduleKeyDeletionWithContext ¶
func (c *Client) ScheduleKeyDeletionWithContext(ctx context.Context, request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)
ScheduleKeyDeletion CMK planned deletion API, used to specify the time of CMK deletion, the optional time interval is [7,30] days
error code that may be returned:
FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct" INTERNALERROR = "InternalError" INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) SignByAsymmetricKey ¶
func (c *Client) SignByAsymmetricKey(request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)
SignByAsymmetricKey This API is used to generate a signature with an asymmetric key.
Note: only the keys with `KeyUsage= ASYMMETRIC_SIGN_VERIFY_SM2` can be used for signature generation.
error code that may be returned:
AUTHFAILURE = "AuthFailure" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
func (*Client) SignByAsymmetricKeyWithContext ¶
func (c *Client) SignByAsymmetricKeyWithContext(ctx context.Context, request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)
SignByAsymmetricKey This API is used to generate a signature with an asymmetric key.
Note: only the keys with `KeyUsage= ASYMMETRIC_SIGN_VERIFY_SM2` can be used for signature generation.
error code that may be returned:
AUTHFAILURE = "AuthFailure" INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
func (*Client) UnbindCloudResource ¶
func (c *Client) UnbindCloudResource(request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)
UnbindCloudResource This API is used to unbind a key with a Tencent Cloud resource, indicating that the Tencent Cloud resource will not use the key any longer.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) UnbindCloudResourceWithContext ¶
func (c *Client) UnbindCloudResourceWithContext(ctx context.Context, request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)
UnbindCloudResource This API is used to unbind a key with a Tencent Cloud resource, indicating that the Tencent Cloud resource will not use the key any longer.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) UpdateAlias ¶
func (c *Client) UpdateAlias(request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)
UpdateAlias This API is used to modify the alias of a CMK. CMKs in `PendingDelete` status cannot be modified.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) UpdateAliasWithContext ¶
func (c *Client) UpdateAliasWithContext(ctx context.Context, request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)
UpdateAlias This API is used to modify the alias of a CMK. CMKs in `PendingDelete` status cannot be modified.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists" INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) UpdateKeyDescription ¶
func (c *Client) UpdateKeyDescription(request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)
UpdateKeyDescription This API is used to modify the description of the specified CMK. CMKs in `PendingDelete` status cannot be modified.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) UpdateKeyDescriptionWithContext ¶
func (c *Client) UpdateKeyDescriptionWithContext(ctx context.Context, request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)
UpdateKeyDescription This API is used to modify the description of the specified CMK. CMKs in `PendingDelete` status cannot be modified.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound" UNAUTHORIZEDOPERATION = "UnauthorizedOperation" UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"
func (*Client) VerifyByAsymmetricKey ¶
func (c *Client) VerifyByAsymmetricKey(request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)
VerifyByAsymmetricKey This API is used to verify a signature with an asymmetric key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
func (*Client) VerifyByAsymmetricKeyWithContext ¶
func (c *Client) VerifyByAsymmetricKeyWithContext(ctx context.Context, request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)
VerifyByAsymmetricKey This API is used to verify a signature with an asymmetric key.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETERVALUE = "InvalidParameterValue" INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId" RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
type CreateKeyRequest ¶
type CreateKeyRequest struct { *tchttp.BaseRequest // Unique alias that makes a key more recognizable and understandable. This parameter cannot be empty, can contain 1-60 letters, digits, `-`, and `_`, and must begin with a letter or digit. The `kms-` prefix is used for Tencent Cloud products. Alias *string `json:"Alias,omitempty" name:"Alias"` // CMK description of up to 1,024 bytes in length Description *string `json:"Description,omitempty" name:"Description"` // Key purpose. Valid values: `ENCRYPT_DECRYPT` (default value; creating a symmetric key for encryption and decryption), `ASYMMETRIC_DECRYPT_RSA_2048` (creating an RSA2048 asymmetric key for encryption and decryption), `ASYMMETRIC_DECRYPT_SM2` (creating an SM2 asymmetric key for encryption and decryption), and `ASYMMETRIC_SIGN_VERIFY_SM2` (creating an SM2 asymmetric key for signature verification). KeyUsage *string `json:"KeyUsage,omitempty" name:"KeyUsage"` // Specifies the key type. Default value: 1. Valid value: 1 - default type, indicating that the CMK is created by KMS; 2 - EXTERNAL type, indicating that you need to import key material. For more information, please see the `GetParametersForImport` and `ImportKeyMaterial` API documents. Type *uint64 `json:"Type,omitempty" name:"Type"` // Tag list Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
func NewCreateKeyRequest ¶
func NewCreateKeyRequest() (request *CreateKeyRequest)
func (*CreateKeyRequest) FromJsonString ¶
func (r *CreateKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateKeyRequest) ToJsonString ¶
func (r *CreateKeyRequest) ToJsonString() string
type CreateKeyResponse ¶
type CreateKeyResponse struct { *tchttp.BaseResponse Response *struct { // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Alias that makes a key more recognizable and understandable Alias *string `json:"Alias,omitempty" name:"Alias"` // Key creation time in UNIX timestamp format CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"` // CMK description Description *string `json:"Description,omitempty" name:"Description"` // CMK status KeyState *string `json:"KeyState,omitempty" name:"KeyState"` // CMK usage KeyUsage *string `json:"KeyUsage,omitempty" name:"KeyUsage"` // Tag operation return code. 0: success; 1: internal error; 2: business processing error TagCode *uint64 `json:"TagCode,omitempty" name:"TagCode"` // Tag operation return information TagMsg *string `json:"TagMsg,omitempty" name:"TagMsg"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateKeyResponse ¶
func NewCreateKeyResponse() (response *CreateKeyResponse)
func (*CreateKeyResponse) FromJsonString ¶
func (r *CreateKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateKeyResponse) ToJsonString ¶
func (r *CreateKeyResponse) ToJsonString() string
type CreateWhiteBoxKeyRequest ¶
type CreateWhiteBoxKeyRequest struct { *tchttp.BaseRequest // 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. Alias *string `json:"Alias,omitempty" name:"Alias"` // All algorithm types for creating keys. Valid values: AES_256, SM4 Algorithm *string `json:"Algorithm,omitempty" name:"Algorithm"` // Key description of up to 1024 bytes Description *string `json:"Description,omitempty" name:"Description"` // Tag list Tags []*Tag `json:"Tags,omitempty" name:"Tags"` }
func NewCreateWhiteBoxKeyRequest ¶
func NewCreateWhiteBoxKeyRequest() (request *CreateWhiteBoxKeyRequest)
func (*CreateWhiteBoxKeyRequest) FromJsonString ¶
func (r *CreateWhiteBoxKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateWhiteBoxKeyRequest) ToJsonString ¶
func (r *CreateWhiteBoxKeyRequest) ToJsonString() string
type CreateWhiteBoxKeyResponse ¶
type CreateWhiteBoxKeyResponse struct { *tchttp.BaseResponse Response *struct { // Base64-encoded encryption key EncryptKey *string `json:"EncryptKey,omitempty" name:"EncryptKey"` // Base64-encoded decryption key DecryptKey *string `json:"DecryptKey,omitempty" name:"DecryptKey"` // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Tag operation return code. 0: success; 1: internal error; 2: business processing error TagCode *uint64 `json:"TagCode,omitempty" name:"TagCode"` // Tag operation return message TagMsg *string `json:"TagMsg,omitempty" name:"TagMsg"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewCreateWhiteBoxKeyResponse ¶
func NewCreateWhiteBoxKeyResponse() (response *CreateWhiteBoxKeyResponse)
func (*CreateWhiteBoxKeyResponse) FromJsonString ¶
func (r *CreateWhiteBoxKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateWhiteBoxKeyResponse) ToJsonString ¶
func (r *CreateWhiteBoxKeyResponse) ToJsonString() string
type DecryptRequest ¶
type DecryptRequest struct { *tchttp.BaseRequest // The ciphertext data to be decrypted. CiphertextBlob *string `json:"CiphertextBlob,omitempty" name:"CiphertextBlob"` // JSON string of key-value pair. If this parameter is specified for `Encrypt`, the same parameter needs to be provided when the `Decrypt` API is called. The maximum length is 1,024 bytes. EncryptionContext *string `json:"EncryptionContext,omitempty" name:"EncryptionContext"` }
func NewDecryptRequest ¶
func NewDecryptRequest() (request *DecryptRequest)
func (*DecryptRequest) FromJsonString ¶
func (r *DecryptRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DecryptRequest) ToJsonString ¶
func (r *DecryptRequest) ToJsonString() string
type DecryptResponse ¶
type DecryptResponse struct { *tchttp.BaseResponse Response *struct { // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Decrypted plaintext. This field is Base64-encoded. In order to get the original plaintext, the Base64-decoding is needed Plaintext *string `json:"Plaintext,omitempty" name:"Plaintext"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDecryptResponse ¶
func NewDecryptResponse() (response *DecryptResponse)
func (*DecryptResponse) FromJsonString ¶
func (r *DecryptResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DecryptResponse) ToJsonString ¶
func (r *DecryptResponse) ToJsonString() string
type DeleteImportedKeyMaterialRequest ¶
type DeleteImportedKeyMaterialRequest struct { *tchttp.BaseRequest // Specifies the EXTERNAL CMK for which to delete the key material. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDeleteImportedKeyMaterialRequest ¶
func NewDeleteImportedKeyMaterialRequest() (request *DeleteImportedKeyMaterialRequest)
func (*DeleteImportedKeyMaterialRequest) FromJsonString ¶
func (r *DeleteImportedKeyMaterialRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteImportedKeyMaterialRequest) ToJsonString ¶
func (r *DeleteImportedKeyMaterialRequest) ToJsonString() string
type DeleteImportedKeyMaterialResponse ¶
type DeleteImportedKeyMaterialResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteImportedKeyMaterialResponse ¶
func NewDeleteImportedKeyMaterialResponse() (response *DeleteImportedKeyMaterialResponse)
func (*DeleteImportedKeyMaterialResponse) FromJsonString ¶
func (r *DeleteImportedKeyMaterialResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteImportedKeyMaterialResponse) ToJsonString ¶
func (r *DeleteImportedKeyMaterialResponse) ToJsonString() string
type DeleteWhiteBoxKeyRequest ¶
type DeleteWhiteBoxKeyRequest struct { *tchttp.BaseRequest // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDeleteWhiteBoxKeyRequest ¶
func NewDeleteWhiteBoxKeyRequest() (request *DeleteWhiteBoxKeyRequest)
func (*DeleteWhiteBoxKeyRequest) FromJsonString ¶
func (r *DeleteWhiteBoxKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteWhiteBoxKeyRequest) ToJsonString ¶
func (r *DeleteWhiteBoxKeyRequest) ToJsonString() string
type DeleteWhiteBoxKeyResponse ¶
type DeleteWhiteBoxKeyResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDeleteWhiteBoxKeyResponse ¶
func NewDeleteWhiteBoxKeyResponse() (response *DeleteWhiteBoxKeyResponse)
func (*DeleteWhiteBoxKeyResponse) FromJsonString ¶
func (r *DeleteWhiteBoxKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DeleteWhiteBoxKeyResponse) ToJsonString ¶
func (r *DeleteWhiteBoxKeyResponse) ToJsonString() string
type DescribeKeyRequest ¶
type DescribeKeyRequest struct { *tchttp.BaseRequest // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDescribeKeyRequest ¶
func NewDescribeKeyRequest() (request *DescribeKeyRequest)
func (*DescribeKeyRequest) FromJsonString ¶
func (r *DescribeKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeKeyRequest) ToJsonString ¶
func (r *DescribeKeyRequest) ToJsonString() string
type DescribeKeyResponse ¶
type DescribeKeyResponse struct { *tchttp.BaseResponse Response *struct { // Key attribute information // Note: this field may return null, indicating that no valid values can be obtained. KeyMetadata *KeyMetadata `json:"KeyMetadata,omitempty" name:"KeyMetadata"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeKeyResponse ¶
func NewDescribeKeyResponse() (response *DescribeKeyResponse)
func (*DescribeKeyResponse) FromJsonString ¶
func (r *DescribeKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeKeyResponse) ToJsonString ¶
func (r *DescribeKeyResponse) ToJsonString() string
type DescribeKeysRequest ¶
type DescribeKeysRequest struct { *tchttp.BaseRequest // List of IDs of the CMKs to be queried in batches. Up to 100 `KeyId` values are supported in one query. KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds"` }
func NewDescribeKeysRequest ¶
func NewDescribeKeysRequest() (request *DescribeKeysRequest)
func (*DescribeKeysRequest) FromJsonString ¶
func (r *DescribeKeysRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeKeysRequest) ToJsonString ¶
func (r *DescribeKeysRequest) ToJsonString() string
type DescribeKeysResponse ¶
type DescribeKeysResponse struct { *tchttp.BaseResponse Response *struct { // List of returned attribute information // Note: this field may return null, indicating that no valid values can be obtained. KeyMetadatas []*KeyMetadata `json:"KeyMetadatas,omitempty" name:"KeyMetadatas"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeKeysResponse ¶
func NewDescribeKeysResponse() (response *DescribeKeysResponse)
func (*DescribeKeysResponse) FromJsonString ¶
func (r *DescribeKeysResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeKeysResponse) ToJsonString ¶
func (r *DescribeKeysResponse) ToJsonString() string
type DescribeWhiteBoxDecryptKeyRequest ¶
type DescribeWhiteBoxDecryptKeyRequest struct { *tchttp.BaseRequest // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDescribeWhiteBoxDecryptKeyRequest ¶
func NewDescribeWhiteBoxDecryptKeyRequest() (request *DescribeWhiteBoxDecryptKeyRequest)
func (*DescribeWhiteBoxDecryptKeyRequest) FromJsonString ¶
func (r *DescribeWhiteBoxDecryptKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxDecryptKeyRequest) ToJsonString ¶
func (r *DescribeWhiteBoxDecryptKeyRequest) ToJsonString() string
type DescribeWhiteBoxDecryptKeyResponse ¶
type DescribeWhiteBoxDecryptKeyResponse struct { *tchttp.BaseResponse Response *struct { // Base64-encoded white-box decryption key DecryptKey *string `json:"DecryptKey,omitempty" name:"DecryptKey"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeWhiteBoxDecryptKeyResponse ¶
func NewDescribeWhiteBoxDecryptKeyResponse() (response *DescribeWhiteBoxDecryptKeyResponse)
func (*DescribeWhiteBoxDecryptKeyResponse) FromJsonString ¶
func (r *DescribeWhiteBoxDecryptKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxDecryptKeyResponse) ToJsonString ¶
func (r *DescribeWhiteBoxDecryptKeyResponse) ToJsonString() string
type DescribeWhiteBoxDeviceFingerprintsRequest ¶
type DescribeWhiteBoxDeviceFingerprintsRequest struct { *tchttp.BaseRequest // White-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDescribeWhiteBoxDeviceFingerprintsRequest ¶
func NewDescribeWhiteBoxDeviceFingerprintsRequest() (request *DescribeWhiteBoxDeviceFingerprintsRequest)
func (*DescribeWhiteBoxDeviceFingerprintsRequest) FromJsonString ¶
func (r *DescribeWhiteBoxDeviceFingerprintsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxDeviceFingerprintsRequest) ToJsonString ¶
func (r *DescribeWhiteBoxDeviceFingerprintsRequest) ToJsonString() string
type DescribeWhiteBoxDeviceFingerprintsResponse ¶
type DescribeWhiteBoxDeviceFingerprintsResponse struct { *tchttp.BaseResponse Response *struct { // Device fingerprint list DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitempty" name:"DeviceFingerprints"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeWhiteBoxDeviceFingerprintsResponse ¶
func NewDescribeWhiteBoxDeviceFingerprintsResponse() (response *DescribeWhiteBoxDeviceFingerprintsResponse)
func (*DescribeWhiteBoxDeviceFingerprintsResponse) FromJsonString ¶
func (r *DescribeWhiteBoxDeviceFingerprintsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxDeviceFingerprintsResponse) ToJsonString ¶
func (r *DescribeWhiteBoxDeviceFingerprintsResponse) ToJsonString() string
type DescribeWhiteBoxKeyDetailsRequest ¶
type DescribeWhiteBoxKeyDetailsRequest struct { *tchttp.BaseRequest // Filter: key status. 0: disabled, 1: enabled KeyStatus *int64 `json:"KeyStatus,omitempty" name:"KeyStatus"` // This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 0, indicating not to paginate. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Tag filter condition TagFilters []*TagFilter `json:"TagFilters,omitempty" name:"TagFilters"` }
func NewDescribeWhiteBoxKeyDetailsRequest ¶
func NewDescribeWhiteBoxKeyDetailsRequest() (request *DescribeWhiteBoxKeyDetailsRequest)
func (*DescribeWhiteBoxKeyDetailsRequest) FromJsonString ¶
func (r *DescribeWhiteBoxKeyDetailsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxKeyDetailsRequest) ToJsonString ¶
func (r *DescribeWhiteBoxKeyDetailsRequest) ToJsonString() string
type DescribeWhiteBoxKeyDetailsResponse ¶
type DescribeWhiteBoxKeyDetailsResponse struct { *tchttp.BaseResponse Response *struct { // White-box key information list KeyInfos []*WhiteboxKeyInfo `json:"KeyInfos,omitempty" name:"KeyInfos"` // Total number of keys // Note: this field may return null, indicating that no valid values can be obtained. TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeWhiteBoxKeyDetailsResponse ¶
func NewDescribeWhiteBoxKeyDetailsResponse() (response *DescribeWhiteBoxKeyDetailsResponse)
func (*DescribeWhiteBoxKeyDetailsResponse) FromJsonString ¶
func (r *DescribeWhiteBoxKeyDetailsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxKeyDetailsResponse) ToJsonString ¶
func (r *DescribeWhiteBoxKeyDetailsResponse) ToJsonString() string
type DescribeWhiteBoxKeyRequest ¶
type DescribeWhiteBoxKeyRequest struct { *tchttp.BaseRequest // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDescribeWhiteBoxKeyRequest ¶
func NewDescribeWhiteBoxKeyRequest() (request *DescribeWhiteBoxKeyRequest)
func (*DescribeWhiteBoxKeyRequest) FromJsonString ¶
func (r *DescribeWhiteBoxKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxKeyRequest) ToJsonString ¶
func (r *DescribeWhiteBoxKeyRequest) ToJsonString() string
type DescribeWhiteBoxKeyResponse ¶
type DescribeWhiteBoxKeyResponse struct { *tchttp.BaseResponse Response *struct { // White-box key information KeyInfo *WhiteboxKeyInfo `json:"KeyInfo,omitempty" name:"KeyInfo"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeWhiteBoxKeyResponse ¶
func NewDescribeWhiteBoxKeyResponse() (response *DescribeWhiteBoxKeyResponse)
func (*DescribeWhiteBoxKeyResponse) FromJsonString ¶
func (r *DescribeWhiteBoxKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxKeyResponse) ToJsonString ¶
func (r *DescribeWhiteBoxKeyResponse) ToJsonString() string
type DescribeWhiteBoxServiceStatusRequest ¶
type DescribeWhiteBoxServiceStatusRequest struct {
*tchttp.BaseRequest
}
func NewDescribeWhiteBoxServiceStatusRequest ¶
func NewDescribeWhiteBoxServiceStatusRequest() (request *DescribeWhiteBoxServiceStatusRequest)
func (*DescribeWhiteBoxServiceStatusRequest) FromJsonString ¶
func (r *DescribeWhiteBoxServiceStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxServiceStatusRequest) ToJsonString ¶
func (r *DescribeWhiteBoxServiceStatusRequest) ToJsonString() string
type DescribeWhiteBoxServiceStatusResponse ¶
type DescribeWhiteBoxServiceStatusResponse struct { *tchttp.BaseResponse Response *struct { // Whether the user's white-box key service is available ServiceEnabled *bool `json:"ServiceEnabled,omitempty" name:"ServiceEnabled"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDescribeWhiteBoxServiceStatusResponse ¶
func NewDescribeWhiteBoxServiceStatusResponse() (response *DescribeWhiteBoxServiceStatusResponse)
func (*DescribeWhiteBoxServiceStatusResponse) FromJsonString ¶
func (r *DescribeWhiteBoxServiceStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeWhiteBoxServiceStatusResponse) ToJsonString ¶
func (r *DescribeWhiteBoxServiceStatusResponse) ToJsonString() string
type DeviceFingerprint ¶
type DeviceFingerprint struct { // 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}$ Identity *string `json:"Identity,omitempty" name:"Identity"` // 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. Description *string `json:"Description,omitempty" name:"Description"` }
type DisableKeyRequest ¶
type DisableKeyRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDisableKeyRequest ¶
func NewDisableKeyRequest() (request *DisableKeyRequest)
func (*DisableKeyRequest) FromJsonString ¶
func (r *DisableKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableKeyRequest) ToJsonString ¶
func (r *DisableKeyRequest) ToJsonString() string
type DisableKeyResponse ¶
type DisableKeyResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDisableKeyResponse ¶
func NewDisableKeyResponse() (response *DisableKeyResponse)
func (*DisableKeyResponse) FromJsonString ¶
func (r *DisableKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableKeyResponse) ToJsonString ¶
func (r *DisableKeyResponse) ToJsonString() string
type DisableKeyRotationRequest ¶
type DisableKeyRotationRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDisableKeyRotationRequest ¶
func NewDisableKeyRotationRequest() (request *DisableKeyRotationRequest)
func (*DisableKeyRotationRequest) FromJsonString ¶
func (r *DisableKeyRotationRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableKeyRotationRequest) ToJsonString ¶
func (r *DisableKeyRotationRequest) ToJsonString() string
type DisableKeyRotationResponse ¶
type DisableKeyRotationResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDisableKeyRotationResponse ¶
func NewDisableKeyRotationResponse() (response *DisableKeyRotationResponse)
func (*DisableKeyRotationResponse) FromJsonString ¶
func (r *DisableKeyRotationResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableKeyRotationResponse) ToJsonString ¶
func (r *DisableKeyRotationResponse) ToJsonString() string
type DisableKeysRequest ¶
type DisableKeysRequest struct { *tchttp.BaseRequest // List of IDs of the CMKs to be disabled in batches. Up to 100 CMKs are supported at a time KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds"` }
func NewDisableKeysRequest ¶
func NewDisableKeysRequest() (request *DisableKeysRequest)
func (*DisableKeysRequest) FromJsonString ¶
func (r *DisableKeysRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableKeysRequest) ToJsonString ¶
func (r *DisableKeysRequest) ToJsonString() string
type DisableKeysResponse ¶
type DisableKeysResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDisableKeysResponse ¶
func NewDisableKeysResponse() (response *DisableKeysResponse)
func (*DisableKeysResponse) FromJsonString ¶
func (r *DisableKeysResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableKeysResponse) ToJsonString ¶
func (r *DisableKeysResponse) ToJsonString() string
type DisableWhiteBoxKeyRequest ¶
type DisableWhiteBoxKeyRequest struct { *tchttp.BaseRequest // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewDisableWhiteBoxKeyRequest ¶
func NewDisableWhiteBoxKeyRequest() (request *DisableWhiteBoxKeyRequest)
func (*DisableWhiteBoxKeyRequest) FromJsonString ¶
func (r *DisableWhiteBoxKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableWhiteBoxKeyRequest) ToJsonString ¶
func (r *DisableWhiteBoxKeyRequest) ToJsonString() string
type DisableWhiteBoxKeyResponse ¶
type DisableWhiteBoxKeyResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDisableWhiteBoxKeyResponse ¶
func NewDisableWhiteBoxKeyResponse() (response *DisableWhiteBoxKeyResponse)
func (*DisableWhiteBoxKeyResponse) FromJsonString ¶
func (r *DisableWhiteBoxKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableWhiteBoxKeyResponse) ToJsonString ¶
func (r *DisableWhiteBoxKeyResponse) ToJsonString() string
type DisableWhiteBoxKeysRequest ¶
type DisableWhiteBoxKeysRequest struct { *tchttp.BaseRequest // List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed. KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds"` }
func NewDisableWhiteBoxKeysRequest ¶
func NewDisableWhiteBoxKeysRequest() (request *DisableWhiteBoxKeysRequest)
func (*DisableWhiteBoxKeysRequest) FromJsonString ¶
func (r *DisableWhiteBoxKeysRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableWhiteBoxKeysRequest) ToJsonString ¶
func (r *DisableWhiteBoxKeysRequest) ToJsonString() string
type DisableWhiteBoxKeysResponse ¶
type DisableWhiteBoxKeysResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewDisableWhiteBoxKeysResponse ¶
func NewDisableWhiteBoxKeysResponse() (response *DisableWhiteBoxKeysResponse)
func (*DisableWhiteBoxKeysResponse) FromJsonString ¶
func (r *DisableWhiteBoxKeysResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DisableWhiteBoxKeysResponse) ToJsonString ¶
func (r *DisableWhiteBoxKeysResponse) ToJsonString() string
type EnableKeyRequest ¶
type EnableKeyRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewEnableKeyRequest ¶
func NewEnableKeyRequest() (request *EnableKeyRequest)
func (*EnableKeyRequest) FromJsonString ¶
func (r *EnableKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableKeyRequest) ToJsonString ¶
func (r *EnableKeyRequest) ToJsonString() string
type EnableKeyResponse ¶
type EnableKeyResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEnableKeyResponse ¶
func NewEnableKeyResponse() (response *EnableKeyResponse)
func (*EnableKeyResponse) FromJsonString ¶
func (r *EnableKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableKeyResponse) ToJsonString ¶
func (r *EnableKeyResponse) ToJsonString() string
type EnableKeyRotationRequest ¶
type EnableKeyRotationRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewEnableKeyRotationRequest ¶
func NewEnableKeyRotationRequest() (request *EnableKeyRotationRequest)
func (*EnableKeyRotationRequest) FromJsonString ¶
func (r *EnableKeyRotationRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableKeyRotationRequest) ToJsonString ¶
func (r *EnableKeyRotationRequest) ToJsonString() string
type EnableKeyRotationResponse ¶
type EnableKeyRotationResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEnableKeyRotationResponse ¶
func NewEnableKeyRotationResponse() (response *EnableKeyRotationResponse)
func (*EnableKeyRotationResponse) FromJsonString ¶
func (r *EnableKeyRotationResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableKeyRotationResponse) ToJsonString ¶
func (r *EnableKeyRotationResponse) ToJsonString() string
type EnableKeysRequest ¶
type EnableKeysRequest struct { *tchttp.BaseRequest // List of IDs of the CMKs to be enabled in batches. Up to 100 CMKs are supported at a time KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds"` }
func NewEnableKeysRequest ¶
func NewEnableKeysRequest() (request *EnableKeysRequest)
func (*EnableKeysRequest) FromJsonString ¶
func (r *EnableKeysRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableKeysRequest) ToJsonString ¶
func (r *EnableKeysRequest) ToJsonString() string
type EnableKeysResponse ¶
type EnableKeysResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEnableKeysResponse ¶
func NewEnableKeysResponse() (response *EnableKeysResponse)
func (*EnableKeysResponse) FromJsonString ¶
func (r *EnableKeysResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableKeysResponse) ToJsonString ¶
func (r *EnableKeysResponse) ToJsonString() string
type EnableWhiteBoxKeyRequest ¶
type EnableWhiteBoxKeyRequest struct { *tchttp.BaseRequest // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewEnableWhiteBoxKeyRequest ¶
func NewEnableWhiteBoxKeyRequest() (request *EnableWhiteBoxKeyRequest)
func (*EnableWhiteBoxKeyRequest) FromJsonString ¶
func (r *EnableWhiteBoxKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableWhiteBoxKeyRequest) ToJsonString ¶
func (r *EnableWhiteBoxKeyRequest) ToJsonString() string
type EnableWhiteBoxKeyResponse ¶
type EnableWhiteBoxKeyResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEnableWhiteBoxKeyResponse ¶
func NewEnableWhiteBoxKeyResponse() (response *EnableWhiteBoxKeyResponse)
func (*EnableWhiteBoxKeyResponse) FromJsonString ¶
func (r *EnableWhiteBoxKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableWhiteBoxKeyResponse) ToJsonString ¶
func (r *EnableWhiteBoxKeyResponse) ToJsonString() string
type EnableWhiteBoxKeysRequest ¶
type EnableWhiteBoxKeysRequest struct { *tchttp.BaseRequest // List of globally unique white-box key IDs. Note: you should make sure that all provided `KeyId` values are in valid format, unique, and actually exist. Up to 50 ones are allowed. KeyIds []*string `json:"KeyIds,omitempty" name:"KeyIds"` }
func NewEnableWhiteBoxKeysRequest ¶
func NewEnableWhiteBoxKeysRequest() (request *EnableWhiteBoxKeysRequest)
func (*EnableWhiteBoxKeysRequest) FromJsonString ¶
func (r *EnableWhiteBoxKeysRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableWhiteBoxKeysRequest) ToJsonString ¶
func (r *EnableWhiteBoxKeysRequest) ToJsonString() string
type EnableWhiteBoxKeysResponse ¶
type EnableWhiteBoxKeysResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEnableWhiteBoxKeysResponse ¶
func NewEnableWhiteBoxKeysResponse() (response *EnableWhiteBoxKeysResponse)
func (*EnableWhiteBoxKeysResponse) FromJsonString ¶
func (r *EnableWhiteBoxKeysResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EnableWhiteBoxKeysResponse) ToJsonString ¶
func (r *EnableWhiteBoxKeysResponse) ToJsonString() string
type EncryptByWhiteBoxRequest ¶
type EncryptByWhiteBoxRequest struct { *tchttp.BaseRequest // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Base64-encoded text to be encrypted. The size of the original text cannot exceed 4 KB. PlainText *string `json:"PlainText,omitempty" name:"PlainText"` // Base64-encoded initialization vector of 16 bytes, which will be used by the encryption algorithm. If this parameter is not passed in, the backend service will generate a random one. You should save this value as a parameter for decryption. InitializationVector *string `json:"InitializationVector,omitempty" name:"InitializationVector"` }
func NewEncryptByWhiteBoxRequest ¶
func NewEncryptByWhiteBoxRequest() (request *EncryptByWhiteBoxRequest)
func (*EncryptByWhiteBoxRequest) FromJsonString ¶
func (r *EncryptByWhiteBoxRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EncryptByWhiteBoxRequest) ToJsonString ¶
func (r *EncryptByWhiteBoxRequest) ToJsonString() string
type EncryptByWhiteBoxResponse ¶
type EncryptByWhiteBoxResponse struct { *tchttp.BaseResponse Response *struct { // Base64-encoded initialization vector, which will be used by the encryption algorithm. If this parameter is passed in by the caller, it will be returned as-is; otherwise, the backend service will generate a random one and return it. InitializationVector *string `json:"InitializationVector,omitempty" name:"InitializationVector"` // Base64-encoded ciphertext after encryption CipherText *string `json:"CipherText,omitempty" name:"CipherText"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEncryptByWhiteBoxResponse ¶
func NewEncryptByWhiteBoxResponse() (response *EncryptByWhiteBoxResponse)
func (*EncryptByWhiteBoxResponse) FromJsonString ¶
func (r *EncryptByWhiteBoxResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EncryptByWhiteBoxResponse) ToJsonString ¶
func (r *EncryptByWhiteBoxResponse) ToJsonString() string
type EncryptRequest ¶
type EncryptRequest struct { *tchttp.BaseRequest // Globally unique ID of the CMK generated by calling the `CreateKey` API KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Encrypted plaintext data. This field must be Base64-encoded. The maximum size of the original data is 4 KB Plaintext *string `json:"Plaintext,omitempty" name:"Plaintext"` // JSON string of key-value pair. If this parameter is specified, the same parameter needs to be provided when the `Decrypt` API is called. It is up to 1,024 characters EncryptionContext *string `json:"EncryptionContext,omitempty" name:"EncryptionContext"` }
func NewEncryptRequest ¶
func NewEncryptRequest() (request *EncryptRequest)
func (*EncryptRequest) FromJsonString ¶
func (r *EncryptRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EncryptRequest) ToJsonString ¶
func (r *EncryptRequest) ToJsonString() string
type EncryptResponse ¶
type EncryptResponse struct { *tchttp.BaseResponse Response *struct { // Base64-encoded encrypted ciphertext CiphertextBlob *string `json:"CiphertextBlob,omitempty" name:"CiphertextBlob"` // Globally unique ID of the CMK used for encryption KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewEncryptResponse ¶
func NewEncryptResponse() (response *EncryptResponse)
func (*EncryptResponse) FromJsonString ¶
func (r *EncryptResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*EncryptResponse) ToJsonString ¶
func (r *EncryptResponse) ToJsonString() string
type GenerateDataKeyRequest ¶
type GenerateDataKeyRequest struct { *tchttp.BaseRequest // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Specifies the encryption algorithm and size of the `DataKey`. Valid values: AES_128, AES_256. Either `KeySpec` or `NumberOfBytes` must be specified. KeySpec *string `json:"KeySpec,omitempty" name:"KeySpec"` // Length of the `DataKey`. If both `NumberOfBytes` and `KeySpec` are specified, `NumberOfBytes` will prevail. Minimum value: 1; maximum value: 1024. Either `KeySpec` or `NumberOfBytes` must be specified. NumberOfBytes *uint64 `json:"NumberOfBytes,omitempty" name:"NumberOfBytes"` // JSON string of key-value pair. If this field is used, the same string should be entered when the returned `DataKey` is decrypted. EncryptionContext *string `json:"EncryptionContext,omitempty" name:"EncryptionContext"` }
func NewGenerateDataKeyRequest ¶
func NewGenerateDataKeyRequest() (request *GenerateDataKeyRequest)
func (*GenerateDataKeyRequest) FromJsonString ¶
func (r *GenerateDataKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateDataKeyRequest) ToJsonString ¶
func (r *GenerateDataKeyRequest) ToJsonString() string
type GenerateDataKeyResponse ¶
type GenerateDataKeyResponse struct { *tchttp.BaseResponse Response *struct { // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Plaintext of the generated data key. The plaintext is Base64-encoded and can be used locally after having it Base64-decoded. Plaintext *string `json:"Plaintext,omitempty" name:"Plaintext"` // Ciphertext of the data key, which should be kept by yourself. KMS does not host user data keys. You can call the `Decrypt` API to get the plaintext of the data key from `CiphertextBlob`. CiphertextBlob *string `json:"CiphertextBlob,omitempty" name:"CiphertextBlob"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGenerateDataKeyResponse ¶
func NewGenerateDataKeyResponse() (response *GenerateDataKeyResponse)
func (*GenerateDataKeyResponse) FromJsonString ¶
func (r *GenerateDataKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateDataKeyResponse) ToJsonString ¶
func (r *GenerateDataKeyResponse) ToJsonString() string
type GenerateRandomRequest ¶
type GenerateRandomRequest struct { *tchttp.BaseRequest // Length of the random number. Minimum value: 1. Maximum value: 1024 NumberOfBytes *uint64 `json:"NumberOfBytes,omitempty" name:"NumberOfBytes"` }
func NewGenerateRandomRequest ¶
func NewGenerateRandomRequest() (request *GenerateRandomRequest)
func (*GenerateRandomRequest) FromJsonString ¶
func (r *GenerateRandomRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateRandomRequest) ToJsonString ¶
func (r *GenerateRandomRequest) ToJsonString() string
type GenerateRandomResponse ¶
type GenerateRandomResponse struct { *tchttp.BaseResponse Response *struct { // Base64-encoded plaintext of the randomly generated number. You need to Base64-decode it to get the plaintext. Plaintext *string `json:"Plaintext,omitempty" name:"Plaintext"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGenerateRandomResponse ¶
func NewGenerateRandomResponse() (response *GenerateRandomResponse)
func (*GenerateRandomResponse) FromJsonString ¶
func (r *GenerateRandomResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GenerateRandomResponse) ToJsonString ¶
func (r *GenerateRandomResponse) ToJsonString() string
type GetKeyRotationStatusRequest ¶
type GetKeyRotationStatusRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewGetKeyRotationStatusRequest ¶
func NewGetKeyRotationStatusRequest() (request *GetKeyRotationStatusRequest)
func (*GetKeyRotationStatusRequest) FromJsonString ¶
func (r *GetKeyRotationStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetKeyRotationStatusRequest) ToJsonString ¶
func (r *GetKeyRotationStatusRequest) ToJsonString() string
type GetKeyRotationStatusResponse ¶
type GetKeyRotationStatusResponse struct { *tchttp.BaseResponse Response *struct { // Whether key rotation is enabled KeyRotationEnabled *bool `json:"KeyRotationEnabled,omitempty" name:"KeyRotationEnabled"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetKeyRotationStatusResponse ¶
func NewGetKeyRotationStatusResponse() (response *GetKeyRotationStatusResponse)
func (*GetKeyRotationStatusResponse) FromJsonString ¶
func (r *GetKeyRotationStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetKeyRotationStatusResponse) ToJsonString ¶
func (r *GetKeyRotationStatusResponse) ToJsonString() string
type GetParametersForImportRequest ¶
type GetParametersForImportRequest struct { *tchttp.BaseRequest // Unique ID of a CMK. The CMK for which to get the key parameters must be of the `EXTERNAL` type, i.e., Type = 2 when the CMK is created by the `CreateKey` API. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Specifies the algorithm for key material encryption. Currently, `RSAES_PKCS1_V1_5`, `RSAES_OAEP_SHA_1`, and `RSAES_OAEP_SHA_256` are supported. WrappingAlgorithm *string `json:"WrappingAlgorithm,omitempty" name:"WrappingAlgorithm"` // Specifies the type of wrapping key. Currently, only `RSA_2048` is supported. WrappingKeySpec *string `json:"WrappingKeySpec,omitempty" name:"WrappingKeySpec"` }
func NewGetParametersForImportRequest ¶
func NewGetParametersForImportRequest() (request *GetParametersForImportRequest)
func (*GetParametersForImportRequest) FromJsonString ¶
func (r *GetParametersForImportRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetParametersForImportRequest) ToJsonString ¶
func (r *GetParametersForImportRequest) ToJsonString() string
type GetParametersForImportResponse ¶
type GetParametersForImportResponse struct { *tchttp.BaseResponse Response *struct { // Unique ID of a CMK, which is used to specify the CMK into which to import key material. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // The token required for importing key material, which is used as a parameter for `ImportKeyMaterial`. ImportToken *string `json:"ImportToken,omitempty" name:"ImportToken"` // The Base64-encoded RSA public key used to encrypt key material before importing it with `ImportKeyMaterial`. PublicKey *string `json:"PublicKey,omitempty" name:"PublicKey"` // Validity period of the token and public key. A token and public key can only be imported when they are valid. If they are expired, you will need to call the `GetParametersForImport` API again to get a new token and public key. ParametersValidTo *uint64 `json:"ParametersValidTo,omitempty" name:"ParametersValidTo"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetParametersForImportResponse ¶
func NewGetParametersForImportResponse() (response *GetParametersForImportResponse)
func (*GetParametersForImportResponse) FromJsonString ¶
func (r *GetParametersForImportResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetParametersForImportResponse) ToJsonString ¶
func (r *GetParametersForImportResponse) ToJsonString() string
type GetPublicKeyRequest ¶
type GetPublicKeyRequest struct { *tchttp.BaseRequest // Unique CMK ID. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewGetPublicKeyRequest ¶
func NewGetPublicKeyRequest() (request *GetPublicKeyRequest)
func (*GetPublicKeyRequest) FromJsonString ¶
func (r *GetPublicKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPublicKeyRequest) ToJsonString ¶
func (r *GetPublicKeyRequest) ToJsonString() string
type GetPublicKeyResponse ¶
type GetPublicKeyResponse struct { *tchttp.BaseResponse Response *struct { // Unique CMK ID. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Base64-encoded public key content. PublicKey *string `json:"PublicKey,omitempty" name:"PublicKey"` // Public key content in PEM format. PublicKeyPem *string `json:"PublicKeyPem,omitempty" name:"PublicKeyPem"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetPublicKeyResponse ¶
func NewGetPublicKeyResponse() (response *GetPublicKeyResponse)
func (*GetPublicKeyResponse) FromJsonString ¶
func (r *GetPublicKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetPublicKeyResponse) ToJsonString ¶
func (r *GetPublicKeyResponse) ToJsonString() string
type GetRegionsRequest ¶
type GetRegionsRequest struct {
*tchttp.BaseRequest
}
func NewGetRegionsRequest ¶
func NewGetRegionsRequest() (request *GetRegionsRequest)
func (*GetRegionsRequest) FromJsonString ¶
func (r *GetRegionsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetRegionsRequest) ToJsonString ¶
func (r *GetRegionsRequest) ToJsonString() string
type GetRegionsResponse ¶
type GetRegionsResponse struct { *tchttp.BaseResponse Response *struct { // The list of supported regions // Note: this field may return null, indicating that no valid values can be obtained. Regions []*string `json:"Regions,omitempty" name:"Regions"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetRegionsResponse ¶
func NewGetRegionsResponse() (response *GetRegionsResponse)
func (*GetRegionsResponse) FromJsonString ¶
func (r *GetRegionsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetRegionsResponse) ToJsonString ¶
func (r *GetRegionsResponse) ToJsonString() string
type GetServiceStatusRequest ¶
type GetServiceStatusRequest struct {
*tchttp.BaseRequest
}
func NewGetServiceStatusRequest ¶
func NewGetServiceStatusRequest() (request *GetServiceStatusRequest)
func (*GetServiceStatusRequest) FromJsonString ¶
func (r *GetServiceStatusRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetServiceStatusRequest) ToJsonString ¶
func (r *GetServiceStatusRequest) ToJsonString() string
type GetServiceStatusResponse ¶
type GetServiceStatusResponse struct { *tchttp.BaseResponse Response *struct { // Whether the KMS service has been activated. true: activated ServiceEnabled *bool `json:"ServiceEnabled,omitempty" name:"ServiceEnabled"` // Service unavailability type. 0: not purchased; 1: normal; 2: suspended due to arrears; 3: resource released InvalidType *int64 `json:"InvalidType,omitempty" name:"InvalidType"` // 0: Basic Edition, 1: Ultimate Edition UserLevel *uint64 `json:"UserLevel,omitempty" name:"UserLevel"` // Ultimate Edition expiration time // Note: this field may return null, indicating that no valid values can be obtained. ProExpireTime *uint64 `json:"ProExpireTime,omitempty" name:"ProExpireTime"` // Whether to automatically renew Ultimate Edition. 0: no, 1: yes // Note: this field may return null, indicating that no valid values can be obtained. ProRenewFlag *uint64 `json:"ProRenewFlag,omitempty" name:"ProRenewFlag"` // Unique ID of the Ultimate Edition purchase record. If the Ultimate Edition is not activated, the returned value will be null. // Note: this field may return null, indicating that no valid values can be obtained. ProResourceId *string `json:"ProResourceId,omitempty" name:"ProResourceId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewGetServiceStatusResponse ¶
func NewGetServiceStatusResponse() (response *GetServiceStatusResponse)
func (*GetServiceStatusResponse) FromJsonString ¶
func (r *GetServiceStatusResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*GetServiceStatusResponse) ToJsonString ¶
func (r *GetServiceStatusResponse) ToJsonString() string
type ImportKeyMaterialRequest ¶
type ImportKeyMaterialRequest struct { *tchttp.BaseRequest // Base64-encoded key material that encrypted with the `PublicKey` returned by `GetParametersForImport`. For the KMS of SM-CRYPTO version, the length of the key material should be 128 bits, while for KMS of FIPS-compliant version, the length should be 256 bits. EncryptedKeyMaterial *string `json:"EncryptedKeyMaterial,omitempty" name:"EncryptedKeyMaterial"` // Import token obtained by calling `GetParametersForImport`. ImportToken *string `json:"ImportToken,omitempty" name:"ImportToken"` // Specifies the CMK into which to import key material, which must be the same as the one specified by `GetParametersForImport`. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Unix timestamp of the key material's expiration time. If this value is empty or 0, the key material will never expire. To specify the expiration time, it should be later than the current time. Maximum value: 2147443200. ValidTo *uint64 `json:"ValidTo,omitempty" name:"ValidTo"` }
func NewImportKeyMaterialRequest ¶
func NewImportKeyMaterialRequest() (request *ImportKeyMaterialRequest)
func (*ImportKeyMaterialRequest) FromJsonString ¶
func (r *ImportKeyMaterialRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ImportKeyMaterialRequest) ToJsonString ¶
func (r *ImportKeyMaterialRequest) ToJsonString() string
type ImportKeyMaterialResponse ¶
type ImportKeyMaterialResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewImportKeyMaterialResponse ¶
func NewImportKeyMaterialResponse() (response *ImportKeyMaterialResponse)
func (*ImportKeyMaterialResponse) FromJsonString ¶
func (r *ImportKeyMaterialResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ImportKeyMaterialResponse) ToJsonString ¶
func (r *ImportKeyMaterialResponse) ToJsonString() string
type Key ¶
type Key struct { // Globally unique CMK ID. KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
type KeyMetadata ¶
type KeyMetadata struct { // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Alias that makes a key more recognizable and understandable Alias *string `json:"Alias,omitempty" name:"Alias"` // Key creation time CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"` // CMK description Description *string `json:"Description,omitempty" name:"Description"` // CMK status. Valid values: Enabled, Disabled, PendingDelete, PendingImport, Archived. KeyState *string `json:"KeyState,omitempty" name:"KeyState"` // CMK purpose. Valid values: `ENCRYPT_DECRYPT`, `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, and `ASYMMETRIC_SIGN_VERIFY_SM2`. KeyUsage *string `json:"KeyUsage,omitempty" name:"KeyUsage"` // CMK type. 2: FIPS-compliant; 4: SM-CRYPTO Type *int64 `json:"Type,omitempty" name:"Type"` // Creator CreatorUin *uint64 `json:"CreatorUin,omitempty" name:"CreatorUin"` // Whether key rotation is enabled KeyRotationEnabled *bool `json:"KeyRotationEnabled,omitempty" name:"KeyRotationEnabled"` // 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. Owner *string `json:"Owner,omitempty" name:"Owner"` // Time of next rotation if key rotation is enabled NextRotateTime *uint64 `json:"NextRotateTime,omitempty" name:"NextRotateTime"` // Scheduled deletion time DeletionDate *uint64 `json:"DeletionDate,omitempty" name:"DeletionDate"` // 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. Origin *string `json:"Origin,omitempty" name:"Origin"` // 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. ValidTo *uint64 `json:"ValidTo,omitempty" name:"ValidTo"` // Resource ID in the format of `creatorUin/$creatorUin/$keyId`. ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"` }
type ListAlgorithmsRequest ¶
type ListAlgorithmsRequest struct {
*tchttp.BaseRequest
}
func NewListAlgorithmsRequest ¶
func NewListAlgorithmsRequest() (request *ListAlgorithmsRequest)
func (*ListAlgorithmsRequest) FromJsonString ¶
func (r *ListAlgorithmsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListAlgorithmsRequest) ToJsonString ¶
func (r *ListAlgorithmsRequest) ToJsonString() string
type ListAlgorithmsResponse ¶
type ListAlgorithmsResponse struct { *tchttp.BaseResponse Response *struct { // Symmetric encryption algorithms supported in this region SymmetricAlgorithms []*AlgorithmInfo `json:"SymmetricAlgorithms,omitempty" name:"SymmetricAlgorithms"` // Asymmetric encryption algorithms supported in this region AsymmetricAlgorithms []*AlgorithmInfo `json:"AsymmetricAlgorithms,omitempty" name:"AsymmetricAlgorithms"` // Asymmetric signature verification algorithms supported in the current region AsymmetricSignVerifyAlgorithms []*AlgorithmInfo `json:"AsymmetricSignVerifyAlgorithms,omitempty" name:"AsymmetricSignVerifyAlgorithms"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewListAlgorithmsResponse ¶
func NewListAlgorithmsResponse() (response *ListAlgorithmsResponse)
func (*ListAlgorithmsResponse) FromJsonString ¶
func (r *ListAlgorithmsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListAlgorithmsResponse) ToJsonString ¶
func (r *ListAlgorithmsResponse) ToJsonString() string
type ListKeyDetailRequest ¶
type ListKeyDetailRequest struct { *tchttp.BaseRequest // This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0. Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200. Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Filters by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service. Role *uint64 `json:"Role,omitempty" name:"Role"` // Sorts by CMK creation time. 0: descending; 1: ascending OrderType *uint64 `json:"OrderType,omitempty" name:"OrderType"` // Filters by CMK status. 0: all CMKs; 1: CMKs in `Enabled` status only; 2: CMKs in `Disabled` status only; 3: CMKs in `PendingDelete` status only (i.e., keys with schedule deletion enabled); 4: CMKs in `PendingImport` status only; 5: CMKs in `Archived` status only. KeyState *uint64 `json:"KeyState,omitempty" name:"KeyState"` // Performs a fuzzy query by `KeyId` or `Alias` SearchKeyAlias *string `json:"SearchKeyAlias,omitempty" name:"SearchKeyAlias"` // Filters by CMK type. "TENCENT_KMS" indicates to filter CMKs whose key materials are created by KMS; "EXTERNAL" indicates to filter CMKs of `EXTERNAL` type whose key materials are imported by users; "ALL" or empty indicates to filter CMKs of both types. This value is case-sensitive. Origin *string `json:"Origin,omitempty" name:"Origin"` // Filter by the `KeyUsage` field of CMKs. Valid values: `ALL` (filtering all CMKs), `ENCRYPT_DECRYPT` (it will be used when the parameter is left empty), `ASYMMETRIC_DECRYPT_RSA_2048`, `ASYMMETRIC_DECRYPT_SM2`, and `ASYMMETRIC_SIGN_VERIFY_SM2`. KeyUsage *string `json:"KeyUsage,omitempty" name:"KeyUsage"` // Tag filter condition TagFilters []*TagFilter `json:"TagFilters,omitempty" name:"TagFilters"` }
func NewListKeyDetailRequest ¶
func NewListKeyDetailRequest() (request *ListKeyDetailRequest)
func (*ListKeyDetailRequest) FromJsonString ¶
func (r *ListKeyDetailRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListKeyDetailRequest) ToJsonString ¶
func (r *ListKeyDetailRequest) ToJsonString() string
type ListKeyDetailResponse ¶
type ListKeyDetailResponse struct { *tchttp.BaseResponse Response *struct { // Total number of CMKs TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // List of returned attribute information. // Note: this field may return null, indicating that no valid values can be obtained. KeyMetadatas []*KeyMetadata `json:"KeyMetadatas,omitempty" name:"KeyMetadatas"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewListKeyDetailResponse ¶
func NewListKeyDetailResponse() (response *ListKeyDetailResponse)
func (*ListKeyDetailResponse) FromJsonString ¶
func (r *ListKeyDetailResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListKeyDetailResponse) ToJsonString ¶
func (r *ListKeyDetailResponse) ToJsonString() string
type ListKeysRequest ¶
type ListKeysRequest struct { *tchttp.BaseRequest // This parameter has the same meaning of the `Offset` in an SQL query, indicating that this acquisition starts from the "No. Offset value" element of the array arranged in a certain order. The default value is 0 Offset *uint64 `json:"Offset,omitempty" name:"Offset"` // This parameter has the same meaning of the `Limit` in an SQL query, indicating that up to `Limit` value elements can be obtained in this request. The default value is 10 and the maximum value is 200 Limit *uint64 `json:"Limit,omitempty" name:"Limit"` // Filter by creator role. 0 (default value): the CMK is created by the user; 1: the CMK is created automatically by an authorized Tencent Cloud service Role *uint64 `json:"Role,omitempty" name:"Role"` }
func NewListKeysRequest ¶
func NewListKeysRequest() (request *ListKeysRequest)
func (*ListKeysRequest) FromJsonString ¶
func (r *ListKeysRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListKeysRequest) ToJsonString ¶
func (r *ListKeysRequest) ToJsonString() string
type ListKeysResponse ¶
type ListKeysResponse struct { *tchttp.BaseResponse Response *struct { // CMK list array Keys []*Key `json:"Keys,omitempty" name:"Keys"` // Total number of CMKs TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewListKeysResponse ¶
func NewListKeysResponse() (response *ListKeysResponse)
func (*ListKeysResponse) FromJsonString ¶
func (r *ListKeysResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ListKeysResponse) ToJsonString ¶
func (r *ListKeysResponse) ToJsonString() string
type OverwriteWhiteBoxDeviceFingerprintsRequest ¶
type OverwriteWhiteBoxDeviceFingerprintsRequest struct { *tchttp.BaseRequest // White-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Device fingerprint list. If the list is empty, it means to delete all fingerprint information corresponding to the key. There can be up to 200 entries in the list. DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitempty" name:"DeviceFingerprints"` }
func NewOverwriteWhiteBoxDeviceFingerprintsRequest ¶
func NewOverwriteWhiteBoxDeviceFingerprintsRequest() (request *OverwriteWhiteBoxDeviceFingerprintsRequest)
func (*OverwriteWhiteBoxDeviceFingerprintsRequest) FromJsonString ¶
func (r *OverwriteWhiteBoxDeviceFingerprintsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*OverwriteWhiteBoxDeviceFingerprintsRequest) ToJsonString ¶
func (r *OverwriteWhiteBoxDeviceFingerprintsRequest) ToJsonString() string
type OverwriteWhiteBoxDeviceFingerprintsResponse ¶
type OverwriteWhiteBoxDeviceFingerprintsResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewOverwriteWhiteBoxDeviceFingerprintsResponse ¶
func NewOverwriteWhiteBoxDeviceFingerprintsResponse() (response *OverwriteWhiteBoxDeviceFingerprintsResponse)
func (*OverwriteWhiteBoxDeviceFingerprintsResponse) FromJsonString ¶
func (r *OverwriteWhiteBoxDeviceFingerprintsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*OverwriteWhiteBoxDeviceFingerprintsResponse) ToJsonString ¶
func (r *OverwriteWhiteBoxDeviceFingerprintsResponse) ToJsonString() string
type ReEncryptRequest ¶
type ReEncryptRequest struct { *tchttp.BaseRequest // Ciphertext to be re-encrypted CiphertextBlob *string `json:"CiphertextBlob,omitempty" name:"CiphertextBlob"` // CMK used for re-encryption. If this parameter is empty, the ciphertext will be re-encrypted by using the original CMK (as long as the key is not rotated, the ciphertext will not be refreshed) DestinationKeyId *string `json:"DestinationKeyId,omitempty" name:"DestinationKeyId"` // JSON string of the key-value pair used during ciphertext encryption by `CiphertextBlob`. If not used during encryption, this parameter will be empty SourceEncryptionContext *string `json:"SourceEncryptionContext,omitempty" name:"SourceEncryptionContext"` // JSON string of the key-value pair used during re-encryption. If this field is used, the same string should be entered when the returned new ciphertext is decrypted DestinationEncryptionContext *string `json:"DestinationEncryptionContext,omitempty" name:"DestinationEncryptionContext"` }
func NewReEncryptRequest ¶
func NewReEncryptRequest() (request *ReEncryptRequest)
func (*ReEncryptRequest) FromJsonString ¶
func (r *ReEncryptRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ReEncryptRequest) ToJsonString ¶
func (r *ReEncryptRequest) ToJsonString() string
type ReEncryptResponse ¶
type ReEncryptResponse struct { *tchttp.BaseResponse Response *struct { // Re-encrypted ciphertext CiphertextBlob *string `json:"CiphertextBlob,omitempty" name:"CiphertextBlob"` // CMK used for re-encryption KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // CMK used by ciphertext before re-encryption SourceKeyId *string `json:"SourceKeyId,omitempty" name:"SourceKeyId"` // `true` indicates that the ciphertext has been re-encrypted. When re-encryption is initiated by using the same CMK, as long as the CMK is not rotated, no actual re-encryption will be performed, and the original ciphertext will be returned ReEncrypted *bool `json:"ReEncrypted,omitempty" name:"ReEncrypted"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewReEncryptResponse ¶
func NewReEncryptResponse() (response *ReEncryptResponse)
func (*ReEncryptResponse) FromJsonString ¶
func (r *ReEncryptResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ReEncryptResponse) ToJsonString ¶
func (r *ReEncryptResponse) ToJsonString() string
type ScheduleKeyDeletionRequest ¶
type ScheduleKeyDeletionRequest struct { *tchttp.BaseRequest // Unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Schedule deletion time range. Value range: [7,30] PendingWindowInDays *uint64 `json:"PendingWindowInDays,omitempty" name:"PendingWindowInDays"` }
func NewScheduleKeyDeletionRequest ¶
func NewScheduleKeyDeletionRequest() (request *ScheduleKeyDeletionRequest)
func (*ScheduleKeyDeletionRequest) FromJsonString ¶
func (r *ScheduleKeyDeletionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ScheduleKeyDeletionRequest) ToJsonString ¶
func (r *ScheduleKeyDeletionRequest) ToJsonString() string
type ScheduleKeyDeletionResponse ¶
type ScheduleKeyDeletionResponse struct { *tchttp.BaseResponse Response *struct { // Schedule deletion execution time DeletionDate *uint64 `json:"DeletionDate,omitempty" name:"DeletionDate"` // Unique ID of the CMK scheduled for deletion KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewScheduleKeyDeletionResponse ¶
func NewScheduleKeyDeletionResponse() (response *ScheduleKeyDeletionResponse)
func (*ScheduleKeyDeletionResponse) FromJsonString ¶
func (r *ScheduleKeyDeletionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ScheduleKeyDeletionResponse) ToJsonString ¶
func (r *ScheduleKeyDeletionResponse) ToJsonString() string
type SignByAsymmetricKeyRequest ¶
type SignByAsymmetricKeyRequest struct { *tchttp.BaseRequest // Signature algorithm. Supported algorithm: SM2DSA. Algorithm *string `json:"Algorithm,omitempty" name:"Algorithm"` // The original message or message abstract. For an original message, the length before Base64 encoding can contain up to 4,096 bytes. For a message abstract, the SM2 signature algorithm only supports 32-byte (before Base64 encoding) message abstracts. Message *string `json:"Message,omitempty" name:"Message"` // Unique ID of a key KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`. MessageType *string `json:"MessageType,omitempty" name:"MessageType"` }
func NewSignByAsymmetricKeyRequest ¶
func NewSignByAsymmetricKeyRequest() (request *SignByAsymmetricKeyRequest)
func (*SignByAsymmetricKeyRequest) FromJsonString ¶
func (r *SignByAsymmetricKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SignByAsymmetricKeyRequest) ToJsonString ¶
func (r *SignByAsymmetricKeyRequest) ToJsonString() string
type SignByAsymmetricKeyResponse ¶
type SignByAsymmetricKeyResponse struct { *tchttp.BaseResponse Response *struct { // Base64-encoded signature Signature *string `json:"Signature,omitempty" name:"Signature"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewSignByAsymmetricKeyResponse ¶
func NewSignByAsymmetricKeyResponse() (response *SignByAsymmetricKeyResponse)
func (*SignByAsymmetricKeyResponse) FromJsonString ¶
func (r *SignByAsymmetricKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*SignByAsymmetricKeyResponse) ToJsonString ¶
func (r *SignByAsymmetricKeyResponse) ToJsonString() string
type UnbindCloudResourceRequest ¶
type UnbindCloudResourceRequest struct { *tchttp.BaseRequest // CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Unique ID of a Tencent Cloud service ProductId *string `json:"ProductId,omitempty" name:"ProductId"` // Resource/instance ID, which is stored as a string and defined by the caller based on the Tencent Cloud service’s features. ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"` }
func NewUnbindCloudResourceRequest ¶
func NewUnbindCloudResourceRequest() (request *UnbindCloudResourceRequest)
func (*UnbindCloudResourceRequest) FromJsonString ¶
func (r *UnbindCloudResourceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnbindCloudResourceRequest) ToJsonString ¶
func (r *UnbindCloudResourceRequest) ToJsonString() string
type UnbindCloudResourceResponse ¶
type UnbindCloudResourceResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUnbindCloudResourceResponse ¶
func NewUnbindCloudResourceResponse() (response *UnbindCloudResourceResponse)
func (*UnbindCloudResourceResponse) FromJsonString ¶
func (r *UnbindCloudResourceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UnbindCloudResourceResponse) ToJsonString ¶
func (r *UnbindCloudResourceResponse) ToJsonString() string
type UpdateAliasRequest ¶
type UpdateAliasRequest struct { *tchttp.BaseRequest // New alias containing 1-60 characters or digits Alias *string `json:"Alias,omitempty" name:"Alias"` // Globally unique CMK ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewUpdateAliasRequest ¶
func NewUpdateAliasRequest() (request *UpdateAliasRequest)
func (*UpdateAliasRequest) FromJsonString ¶
func (r *UpdateAliasRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateAliasRequest) ToJsonString ¶
func (r *UpdateAliasRequest) ToJsonString() string
type UpdateAliasResponse ¶
type UpdateAliasResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUpdateAliasResponse ¶
func NewUpdateAliasResponse() (response *UpdateAliasResponse)
func (*UpdateAliasResponse) FromJsonString ¶
func (r *UpdateAliasResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateAliasResponse) ToJsonString ¶
func (r *UpdateAliasResponse) ToJsonString() string
type UpdateKeyDescriptionRequest ¶
type UpdateKeyDescriptionRequest struct { *tchttp.BaseRequest // New description of up to 1,024 bytes in length Description *string `json:"Description,omitempty" name:"Description"` // ID of the CMK for which to modify the description KeyId *string `json:"KeyId,omitempty" name:"KeyId"` }
func NewUpdateKeyDescriptionRequest ¶
func NewUpdateKeyDescriptionRequest() (request *UpdateKeyDescriptionRequest)
func (*UpdateKeyDescriptionRequest) FromJsonString ¶
func (r *UpdateKeyDescriptionRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateKeyDescriptionRequest) ToJsonString ¶
func (r *UpdateKeyDescriptionRequest) ToJsonString() string
type UpdateKeyDescriptionResponse ¶
type UpdateKeyDescriptionResponse struct { *tchttp.BaseResponse Response *struct { // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewUpdateKeyDescriptionResponse ¶
func NewUpdateKeyDescriptionResponse() (response *UpdateKeyDescriptionResponse)
func (*UpdateKeyDescriptionResponse) FromJsonString ¶
func (r *UpdateKeyDescriptionResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*UpdateKeyDescriptionResponse) ToJsonString ¶
func (r *UpdateKeyDescriptionResponse) ToJsonString() string
type VerifyByAsymmetricKeyRequest ¶
type VerifyByAsymmetricKeyRequest struct { *tchttp.BaseRequest // Unique ID of a key KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // Signature value, which is generated by calling the KMS signature API. SignatureValue *string `json:"SignatureValue,omitempty" name:"SignatureValue"` // The original message or message abstract. For an original message, the length before Base64 encoding can contain up to 4,096 bytes. For a message abstract, the SM2 signature algorithm only supports 32-byte (before Base64 encoding) message abstracts. Message *string `json:"Message,omitempty" name:"Message"` // Signature algorithm. Supported algorithm: SM2DSA. Algorithm *string `json:"Algorithm,omitempty" name:"Algorithm"` // Message type. Valid values: `RAW` (indicating an original message; used by default if the parameter is not passed in) and `DIGEST`. MessageType *string `json:"MessageType,omitempty" name:"MessageType"` }
func NewVerifyByAsymmetricKeyRequest ¶
func NewVerifyByAsymmetricKeyRequest() (request *VerifyByAsymmetricKeyRequest)
func (*VerifyByAsymmetricKeyRequest) FromJsonString ¶
func (r *VerifyByAsymmetricKeyRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifyByAsymmetricKeyRequest) ToJsonString ¶
func (r *VerifyByAsymmetricKeyRequest) ToJsonString() string
type VerifyByAsymmetricKeyResponse ¶
type VerifyByAsymmetricKeyResponse struct { *tchttp.BaseResponse Response *struct { // Whether the signature is valid. SignatureValid *bool `json:"SignatureValid,omitempty" name:"SignatureValid"` // The unique request ID, which is returned for each request. RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitempty" name:"RequestId"` } `json:"Response"` }
func NewVerifyByAsymmetricKeyResponse ¶
func NewVerifyByAsymmetricKeyResponse() (response *VerifyByAsymmetricKeyResponse)
func (*VerifyByAsymmetricKeyResponse) FromJsonString ¶
func (r *VerifyByAsymmetricKeyResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*VerifyByAsymmetricKeyResponse) ToJsonString ¶
func (r *VerifyByAsymmetricKeyResponse) ToJsonString() string
type WhiteboxKeyInfo ¶
type WhiteboxKeyInfo struct { // Globally unique white-box key ID KeyId *string `json:"KeyId,omitempty" name:"KeyId"` // 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. Alias *string `json:"Alias,omitempty" name:"Alias"` // Creator CreatorUin *uint64 `json:"CreatorUin,omitempty" name:"CreatorUin"` // Key description information Description *string `json:"Description,omitempty" name:"Description"` // Key creation time in Unix timestamp CreateTime *uint64 `json:"CreateTime,omitempty" name:"CreateTime"` // White-box key status. Valid values: Enabled, Disabled Status *string `json:"Status,omitempty" name:"Status"` // Creator OwnerUin *uint64 `json:"OwnerUin,omitempty" name:"OwnerUin"` // Key algorithm type Algorithm *string `json:"Algorithm,omitempty" name:"Algorithm"` // Base64-encoded white-box encryption key EncryptKey *string `json:"EncryptKey,omitempty" name:"EncryptKey"` // Base64-encoded white-box decryption key DecryptKey *string `json:"DecryptKey,omitempty" name:"DecryptKey"` // Resource ID in the format of `creatorUin/$creatorUin/$keyId` ResourceId *string `json:"ResourceId,omitempty" name:"ResourceId"` // 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. DeviceFingerprintBind *bool `json:"DeviceFingerprintBind,omitempty" name:"DeviceFingerprintBind"` }