v20190118

package
v1.0.1040 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 12, 2024 License: Apache-2.0 Imports: 7 Imported by: 18

Documentation

Index

Constants

View Source
const (

	// CAM签名/鉴权错误。
	AUTHFAILURE = "AuthFailure"

	// 操作失败。
	FAILEDOPERATION = "FailedOperation"

	// CMK正在被云产品使用。
	FAILEDOPERATION_CMKUSEDBYCLOUDPRODUCT = "FailedOperation.CmkUsedByCloudProduct"

	// 解密失败。
	FAILEDOPERATION_DECRYPTERROR = "FailedOperation.DecryptError"

	// 加密操作失败。
	FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"

	// 标签服务错误。
	FAILEDOPERATION_TAGGINGERROR = "FailedOperation.TaggingError"

	// 内部错误。
	INTERNALERROR = "InternalError"

	// 参数错误。
	INVALIDPARAMETER = "InvalidParameter"

	// 解密EncryptedKeyMaterial失败。
	INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError"

	// 计划删除时间参数非法。
	INVALIDPARAMETER_INVALIDPENDINGWINDOWINDAYS = "InvalidParameter.InvalidPendingWindowInDays"

	// 参数取值错误。
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// 别名已经存在。
	INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"

	// KeyId重复。
	INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"

	// 别名格式错误。
	INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"

	// 密文格式错误。
	INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"

	// 无效的 HSM 集群 ID。
	INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"

	// KeyId不合法。
	INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"

	// KeyUsage参数错误。
	INVALIDPARAMETERVALUE_INVALIDKEYUSAGE = "InvalidParameterValue.InvalidKeyUsage"

	// Plaintext不合法。
	INVALIDPARAMETERVALUE_INVALIDPLAINTEXT = "InvalidParameterValue.InvalidPlaintext"

	// Type参数错误。
	INVALIDPARAMETERVALUE_INVALIDTYPE = "InvalidParameterValue.InvalidType"

	// 导入的密钥材料和历史导入不同。
	INVALIDPARAMETERVALUE_MATERIALNOTMATCH = "InvalidParameterValue.MaterialNotMatch"

	// 标签键重复。
	INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"

	// 标签键或标签值不存在。
	INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"

	// CMK数量已达上限。
	LIMITEXCEEDED_CMKLIMITEXCEEDED = "LimitExceeded.CmkLimitExceeded"

	// 设备指纹个数超过限制。
	LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded"

	// 创建的密钥个数超过限制。
	LIMITEXCEEDED_KEYLIMITEXCEEDED = "LimitExceeded.KeyLimitExceeded"

	// 缺少参数错误。
	MISSINGPARAMETER = "MissingParameter"

	// 资源不存在。
	RESOURCENOTFOUND = "ResourceNotFound"

	// cmk和云资源的绑定关系不存在。
	RESOURCEUNAVAILABLE_CLOUDRESOURCEBINDINGNOTFOUND = "ResourceUnavailable.CloudResourceBindingNotFound"

	// CMK已存档。
	RESOURCEUNAVAILABLE_CMKARCHIVED = "ResourceUnavailable.CmkArchived"

	// CMK已被禁用。
	RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"

	// CMK不存在。
	RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"

	// CMK不是计划删除状态不能被执行取消计划删除。
	RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete"

	// 未被禁用的CMK不能被计划删除。
	RESOURCEUNAVAILABLE_CMKSHOULDBEDISABLED = "ResourceUnavailable.CmkShouldBeDisabled"

	// CMK 状态不支持该操作。
	RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

	// 密钥已被禁用。
	RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled"

	// 不可用密钥:密钥待删除。
	RESOURCEUNAVAILABLE_KEYPENDINGDELETE = "ResourceUnavailable.KeyPendingDelete"

	// 白盒密钥服务尚未开通。
	RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"

	// Token已过期。
	RESOURCEUNAVAILABLE_TOKENEXPIRED = "ResourceUnavailable.TokenExpired"

	// 未授权操作。
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// 操作不支持。
	UNSUPPORTEDOPERATION = "UnsupportedOperation"

	// 用户导入类型的CMK禁止轮换。
	UNSUPPORTEDOPERATION_EXTERNALCMKCANNOTROTATE = "UnsupportedOperation.ExternalCmkCanNotRotate"

	// CMK类型错误,仅支持External CMK。
	UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"

	// 仅支持对用户自己创建的CMK做更新。
	UNSUPPORTEDOPERATION_NOTUSERCREATEDCMK = "UnsupportedOperation.NotUserCreatedCmk"

	// 服务暂时不可用。
	UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

	// 加密方式在当前region不支持。
	UNSUPPORTEDOPERATION_UNSUPPORTEDKEYUSAGEINCURRENTREGION = "UnsupportedOperation.UnsupportedKeyUsageInCurrentRegion"
)
View Source
const APIVersion = "2019-01-18"

Variables

This section is empty.

Functions

This section is empty.

Types

type AlgorithmInfo

type AlgorithmInfo struct {
	// 算法的标识
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// 算法的名称
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`
}

type ArchiveKeyRequest

type ArchiveKeyRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 ArchiveKeyRequestParams added in v1.0.426

type ArchiveKeyRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type ArchiveKeyResponse

type ArchiveKeyResponse struct {
	*tchttp.BaseResponse
	Response *ArchiveKeyResponseParams `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 ArchiveKeyResponseParams added in v1.0.426

type ArchiveKeyResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AsymmetricRsaDecryptRequest

type AsymmetricRsaDecryptRequest struct {
	*tchttp.BaseRequest

	// CMK的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 使用PublicKey加密的密文,Base64编码
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`

	// 在使用公钥加密时对应的算法:当前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256
	Algorithm *string `json:"Algorithm,omitnil,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 AsymmetricRsaDecryptRequestParams added in v1.0.426

type AsymmetricRsaDecryptRequestParams struct {
	// CMK的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 使用PublicKey加密的密文,Base64编码
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`

	// 在使用公钥加密时对应的算法:当前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`
}

Predefined struct for user

type AsymmetricRsaDecryptResponse

type AsymmetricRsaDecryptResponse struct {
	*tchttp.BaseResponse
	Response *AsymmetricRsaDecryptResponseParams `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 AsymmetricRsaDecryptResponseParams added in v1.0.426

type AsymmetricRsaDecryptResponseParams struct {
	// CMK的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 解密后的明文,base64编码
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type AsymmetricSm2DecryptRequest

type AsymmetricSm2DecryptRequest struct {
	*tchttp.BaseRequest

	// CMK的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 使用PublicKey加密的密文,Base64编码,原始密文格式需要为C1C3C2_ASN1。原始密文长度不能超过256字节。
	Ciphertext *string `json:"Ciphertext,omitnil,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 AsymmetricSm2DecryptRequestParams added in v1.0.426

type AsymmetricSm2DecryptRequestParams struct {
	// CMK的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 使用PublicKey加密的密文,Base64编码,原始密文格式需要为C1C3C2_ASN1。原始密文长度不能超过256字节。
	Ciphertext *string `json:"Ciphertext,omitnil,omitempty" name:"Ciphertext"`
}

Predefined struct for user

type AsymmetricSm2DecryptResponse

type AsymmetricSm2DecryptResponse struct {
	*tchttp.BaseResponse
	Response *AsymmetricSm2DecryptResponseParams `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 AsymmetricSm2DecryptResponseParams added in v1.0.426

type AsymmetricSm2DecryptResponseParams struct {
	// CMK的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 解密后的明文,base64编码
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type BindCloudResourceRequest

type BindCloudResourceRequest struct {
	*tchttp.BaseRequest

	// cmk的ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 云产品的唯一性标识符
	ProductId *string `json:"ProductId,omitnil,omitempty" name:"ProductId"`

	// 资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。
	ResourceId *string `json:"ResourceId,omitnil,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 BindCloudResourceRequestParams added in v1.0.426

type BindCloudResourceRequestParams struct {
	// cmk的ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 云产品的唯一性标识符
	ProductId *string `json:"ProductId,omitnil,omitempty" name:"ProductId"`

	// 资源/实例ID,由调用方根据自己的云产品特征来定义,以字符串形式做存储。
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`
}

Predefined struct for user

type BindCloudResourceResponse

type BindCloudResourceResponse struct {
	*tchttp.BaseResponse
	Response *BindCloudResourceResponseParams `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 BindCloudResourceResponseParams added in v1.0.426

type BindCloudResourceResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CancelKeyArchiveRequest

type CancelKeyArchiveRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 CancelKeyArchiveRequestParams added in v1.0.426

type CancelKeyArchiveRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type CancelKeyArchiveResponse

type CancelKeyArchiveResponse struct {
	*tchttp.BaseResponse
	Response *CancelKeyArchiveResponseParams `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 CancelKeyArchiveResponseParams added in v1.0.426

type CancelKeyArchiveResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CancelKeyDeletionRequest

type CancelKeyDeletionRequest struct {
	*tchttp.BaseRequest

	// 需要被取消删除的CMK的唯一标志
	KeyId *string `json:"KeyId,omitnil,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 CancelKeyDeletionRequestParams added in v1.0.426

type CancelKeyDeletionRequestParams struct {
	// 需要被取消删除的CMK的唯一标志
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type CancelKeyDeletionResponse

type CancelKeyDeletionResponse struct {
	*tchttp.BaseResponse
	Response *CancelKeyDeletionResponseParams `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 CancelKeyDeletionResponseParams added in v1.0.426

type CancelKeyDeletionResponseParams struct {
	// 唯一标志被取消删除的CMK。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client

type Client struct {
	common.Client
}

func NewClient

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ArchiveKey

func (c *Client) ArchiveKey(request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)

ArchiveKey 对密钥进行归档,被归档的密钥只能用于解密,不能加密

可能返回的错误码:

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 added in v1.0.324

func (c *Client) ArchiveKeyWithContext(ctx context.Context, request *ArchiveKeyRequest) (response *ArchiveKeyResponse, err error)

ArchiveKey 对密钥进行归档,被归档的密钥只能用于解密,不能加密

可能返回的错误码:

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 使用指定的RSA非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) AsymmetricRsaDecryptWithContext(ctx context.Context, request *AsymmetricRsaDecryptRequest) (response *AsymmetricRsaDecryptResponse, err error)

AsymmetricRsaDecrypt 使用指定的RSA非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。

可能返回的错误码:

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 使用指定的SM2非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) AsymmetricSm2DecryptWithContext(ctx context.Context, request *AsymmetricSm2DecryptRequest) (response *AsymmetricSm2DecryptResponse, err error)

AsymmetricSm2Decrypt 使用指定的SM2非对称密钥的私钥进行数据解密,密文必须是使用对应公钥加密的。处于Enabled 状态的非对称密钥才能进行解密操作。传入的密文的长度不能超过256字节。

可能返回的错误码:

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 记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期,则取消该设置,确保当前key不会自动失效。如果当前关联关系已经创建,也返回成功。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) BindCloudResourceWithContext(ctx context.Context, request *BindCloudResourceRequest) (response *BindCloudResourceResponse, err error)

BindCloudResource 记录当前key被哪个云产品的那个资源所使用。如果当前key设置了自动过期,则取消该设置,确保当前key不会自动失效。如果当前关联关系已经创建,也返回成功。

可能返回的错误码:

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 取消密钥归档,取消后密钥的状态变为Enabled。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) CancelKeyArchiveWithContext(ctx context.Context, request *CancelKeyArchiveRequest) (response *CancelKeyArchiveResponse, err error)

CancelKeyArchive 取消密钥归档,取消后密钥的状态变为Enabled。

可能返回的错误码:

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 取消CMK的计划删除操作

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKNOTPENDINGDELETE = "ResourceUnavailable.CmkNotPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) CancelKeyDeletionWithContext added in v1.0.324

func (c *Client) CancelKeyDeletionWithContext(ctx context.Context, request *CancelKeyDeletionRequest) (response *CancelKeyDeletionResponse, err error)

CancelKeyDeletion 取消CMK的计划删除操作

可能返回的错误码:

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 创建用户管理数据密钥的主密钥CMK(Custom Master Key)。

可能返回的错误码:

FAILEDOPERATION_TAGGINGERROR = "FailedOperation.TaggingError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
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 added in v1.0.324

func (c *Client) CreateKeyWithContext(ctx context.Context, request *CreateKeyRequest) (response *CreateKeyResponse, err error)

CreateKey 创建用户管理数据密钥的主密钥CMK(Custom Master Key)。

可能返回的错误码:

FAILEDOPERATION_TAGGINGERROR = "FailedOperation.TaggingError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_ALIASALREADYEXISTS = "InvalidParameterValue.AliasAlreadyExists"
INVALIDPARAMETERVALUE_INVALIDALIAS = "InvalidParameterValue.InvalidAlias"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
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 创建白盒密钥。 密钥个数的上限为 50。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) CreateWhiteBoxKeyWithContext(ctx context.Context, request *CreateWhiteBoxKeyRequest) (response *CreateWhiteBoxKeyResponse, err error)

CreateWhiteBoxKey 创建白盒密钥。 密钥个数的上限为 50。

可能返回的错误码:

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 本接口用于解密密文,得到明文数据。

可能返回的错误码:

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DecryptWithContext added in v1.0.324

func (c *Client) DecryptWithContext(ctx context.Context, request *DecryptRequest) (response *DecryptResponse, err error)

Decrypt 本接口用于解密密文,得到明文数据。

可能返回的错误码:

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
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 用于删除导入的密钥材料,仅对EXTERNAL类型的CMK有效,该接口将CMK设置为PendingImport 状态,并不会删除CMK,在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) DeleteImportedKeyMaterialWithContext(ctx context.Context, request *DeleteImportedKeyMaterialRequest) (response *DeleteImportedKeyMaterialResponse, err error)

DeleteImportedKeyMaterial 用于删除导入的密钥材料,仅对EXTERNAL类型的CMK有效,该接口将CMK设置为PendingImport 状态,并不会删除CMK,在重新进行密钥导入后可继续使用。彻底删除CMK请使用 ScheduleKeyDeletion 接口。

可能返回的错误码:

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 删除白盒密钥, 注意:必须先禁用后,才可以删除。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteWhiteBoxKeyWithContext added in v1.0.324

func (c *Client) DeleteWhiteBoxKeyWithContext(ctx context.Context, request *DeleteWhiteBoxKeyRequest) (response *DeleteWhiteBoxKeyResponse, err error)

DeleteWhiteBoxKey 删除白盒密钥, 注意:必须先禁用后,才可以删除。

可能返回的错误码:

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 用于获取指定KeyId的主密钥属性详情信息。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeKeyWithContext added in v1.0.324

func (c *Client) DescribeKeyWithContext(ctx context.Context, request *DescribeKeyRequest) (response *DescribeKeyResponse, err error)

DescribeKey 用于获取指定KeyId的主密钥属性详情信息。

可能返回的错误码:

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 该接口用于批量获取主密钥属性信息。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeKeysWithContext added in v1.0.324

func (c *Client) DescribeKeysWithContext(ctx context.Context, request *DescribeKeysRequest) (response *DescribeKeysResponse, err error)

DescribeKeys 该接口用于批量获取主密钥属性信息。

可能返回的错误码:

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 获取白盒解密密钥

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxDecryptKeyWithContext added in v1.0.324

func (c *Client) DescribeWhiteBoxDecryptKeyWithContext(ctx context.Context, request *DescribeWhiteBoxDecryptKeyRequest) (response *DescribeWhiteBoxDecryptKeyResponse, err error)

DescribeWhiteBoxDecryptKey 获取白盒解密密钥

可能返回的错误码:

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 获取指定密钥的设备指纹列表

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxDeviceFingerprintsWithContext added in v1.0.324

func (c *Client) DescribeWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *DescribeWhiteBoxDeviceFingerprintsRequest) (response *DescribeWhiteBoxDeviceFingerprintsResponse, err error)

DescribeWhiteBoxDeviceFingerprints 获取指定密钥的设备指纹列表

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKey

func (c *Client) DescribeWhiteBoxKey(request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)

DescribeWhiteBoxKey 展示白盒密钥的信息

可能返回的错误码:

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 获取白盒密钥列表

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKeyDetailsWithContext added in v1.0.324

func (c *Client) DescribeWhiteBoxKeyDetailsWithContext(ctx context.Context, request *DescribeWhiteBoxKeyDetailsRequest) (response *DescribeWhiteBoxKeyDetailsResponse, err error)

DescribeWhiteBoxKeyDetails 获取白盒密钥列表

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxKeyWithContext added in v1.0.324

func (c *Client) DescribeWhiteBoxKeyWithContext(ctx context.Context, request *DescribeWhiteBoxKeyRequest) (response *DescribeWhiteBoxKeyResponse, err error)

DescribeWhiteBoxKey 展示白盒密钥的信息

可能返回的错误码:

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 获取白盒密钥服务状态

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeWhiteBoxServiceStatusWithContext added in v1.0.324

func (c *Client) DescribeWhiteBoxServiceStatusWithContext(ctx context.Context, request *DescribeWhiteBoxServiceStatusRequest) (response *DescribeWhiteBoxServiceStatusResponse, err error)

DescribeWhiteBoxServiceStatus 获取白盒密钥服务状态

可能返回的错误码:

INTERNALERROR = "InternalError"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableKey

func (c *Client) DisableKey(request *DisableKeyRequest) (response *DisableKeyResponse, err error)

DisableKey 本接口用于禁用一个主密钥,处于禁用状态的Key无法用于加密、解密操作。

可能返回的错误码:

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 对指定的CMK禁止密钥轮换功能。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableKeyRotationWithContext added in v1.0.324

func (c *Client) DisableKeyRotationWithContext(ctx context.Context, request *DisableKeyRotationRequest) (response *DisableKeyRotationResponse, err error)

DisableKeyRotation 对指定的CMK禁止密钥轮换功能。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableKeyWithContext added in v1.0.324

func (c *Client) DisableKeyWithContext(ctx context.Context, request *DisableKeyRequest) (response *DisableKeyResponse, err error)

DisableKey 本接口用于禁用一个主密钥,处于禁用状态的Key无法用于加密、解密操作。

可能返回的错误码:

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 该接口用于批量禁止CMK的使用。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) DisableKeysWithContext(ctx context.Context, request *DisableKeysRequest) (response *DisableKeysResponse, err error)

DisableKeys 该接口用于批量禁止CMK的使用。

可能返回的错误码:

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 禁用白盒密钥

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableWhiteBoxKeyWithContext added in v1.0.324

func (c *Client) DisableWhiteBoxKeyWithContext(ctx context.Context, request *DisableWhiteBoxKeyRequest) (response *DisableWhiteBoxKeyResponse, err error)

DisableWhiteBoxKey 禁用白盒密钥

可能返回的错误码:

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 批量禁用白盒密钥

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableWhiteBoxKeysWithContext added in v1.0.324

func (c *Client) DisableWhiteBoxKeysWithContext(ctx context.Context, request *DisableWhiteBoxKeysRequest) (response *DisableWhiteBoxKeysResponse, err error)

DisableWhiteBoxKeys 批量禁用白盒密钥

可能返回的错误码:

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 用于启用一个指定的CMK。

可能返回的错误码:

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 对指定的CMK开启密钥轮换功能。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
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 added in v1.0.324

func (c *Client) EnableKeyRotationWithContext(ctx context.Context, request *EnableKeyRotationRequest) (response *EnableKeyRotationResponse, err error)

EnableKeyRotation 对指定的CMK开启密钥轮换功能。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
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 added in v1.0.324

func (c *Client) EnableKeyWithContext(ctx context.Context, request *EnableKeyRequest) (response *EnableKeyResponse, err error)

EnableKey 用于启用一个指定的CMK。

可能返回的错误码:

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 该接口用于批量启用CMK。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) EnableKeysWithContext(ctx context.Context, request *EnableKeysRequest) (response *EnableKeysResponse, err error)

EnableKeys 该接口用于批量启用CMK。

可能返回的错误码:

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 启用白盒密钥

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableWhiteBoxKeyWithContext added in v1.0.324

func (c *Client) EnableWhiteBoxKeyWithContext(ctx context.Context, request *EnableWhiteBoxKeyRequest) (response *EnableWhiteBoxKeyResponse, err error)

EnableWhiteBoxKey 启用白盒密钥

可能返回的错误码:

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 批量启用白盒密钥

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_DUPLICATEDKEYID = "InvalidParameterValue.DuplicatedKeyId"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableWhiteBoxKeysWithContext added in v1.0.324

func (c *Client) EnableWhiteBoxKeysWithContext(ctx context.Context, request *EnableWhiteBoxKeysRequest) (response *EnableWhiteBoxKeysResponse, err error)

EnableWhiteBoxKeys 批量启用白盒密钥

可能返回的错误码:

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 本接口用于加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作

可能返回的错误码:

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 使用白盒密钥进行加密

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EncryptByWhiteBoxWithContext added in v1.0.324

func (c *Client) EncryptByWhiteBoxWithContext(ctx context.Context, request *EncryptByWhiteBoxRequest) (response *EncryptByWhiteBoxResponse, err error)

EncryptByWhiteBox 使用白盒密钥进行加密

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_KEYDISABLED = "ResourceUnavailable.KeyDisabled"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EncryptWithContext added in v1.0.324

func (c *Client) EncryptWithContext(ctx context.Context, request *EncryptRequest) (response *EncryptResponse, err error)

Encrypt 本接口用于加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作

可能返回的错误码:

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 本接口生成一个数据密钥,您可以用这个密钥进行本地数据的加密。

可能返回的错误码:

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_KEYPENDINGDELETE = "ResourceUnavailable.KeyPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateDataKeyWithContext added in v1.0.324

func (c *Client) GenerateDataKeyWithContext(ctx context.Context, request *GenerateDataKeyRequest) (response *GenerateDataKeyResponse, err error)

GenerateDataKey 本接口生成一个数据密钥,您可以用这个密钥进行本地数据的加密。

可能返回的错误码:

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_KEYPENDINGDELETE = "ResourceUnavailable.KeyPendingDelete"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateRandom

func (c *Client) GenerateRandom(request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)

GenerateRandom 随机数生成接口。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GenerateRandomWithContext added in v1.0.324

func (c *Client) GenerateRandomWithContext(ctx context.Context, request *GenerateRandomRequest) (response *GenerateRandomResponse, err error)

GenerateRandom 随机数生成接口。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetKeyRotationStatus

func (c *Client) GetKeyRotationStatus(request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)

GetKeyRotationStatus 查询指定的CMK是否开启了密钥轮换功能。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetKeyRotationStatusWithContext added in v1.0.324

func (c *Client) GetKeyRotationStatusWithContext(ctx context.Context, request *GetKeyRotationStatusRequest) (response *GetKeyRotationStatusResponse, err error)

GetKeyRotationStatus 查询指定的CMK是否开启了密钥轮换功能。

可能返回的错误码:

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 获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNSUPPORTEDOPERATION_NOTEXTERNALCMK = "UnsupportedOperation.NotExternalCmk"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) GetParametersForImportWithContext added in v1.0.324

func (c *Client) GetParametersForImportWithContext(ctx context.Context, request *GetParametersForImportRequest) (response *GetParametersForImportResponse, err error)

GetParametersForImport 获取导入主密钥(CMK)材料的参数,返回的Token作为执行ImportKeyMaterial的参数之一,返回的PublicKey用于对自主导入密钥材料进行加密。返回的Token和PublicKey 24小时后失效,失效后如需重新导入,需要再次调用该接口获取新的Token和PublicKey。

可能返回的错误码:

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 该接口用于获取非对称密钥的公钥信息,可用于本地数据加密或验签。只有处于Enabled状态的非对称密钥才可能获取公钥。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetPublicKeyWithContext added in v1.0.324

func (c *Client) GetPublicKeyWithContext(ctx context.Context, request *GetPublicKeyRequest) (response *GetPublicKeyResponse, err error)

GetPublicKey 该接口用于获取非对称密钥的公钥信息,可用于本地数据加密或验签。只有处于Enabled状态的非对称密钥才可能获取公钥。

可能返回的错误码:

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 获取可以提供KMS服务的地域列表

可能返回的错误码:

INTERNALERROR = "InternalError"

func (*Client) GetRegionsWithContext added in v1.0.324

func (c *Client) GetRegionsWithContext(ctx context.Context, request *GetRegionsRequest) (response *GetRegionsResponse, err error)

GetRegions 获取可以提供KMS服务的地域列表

可能返回的错误码:

INTERNALERROR = "InternalError"

func (*Client) GetServiceStatus

func (c *Client) GetServiceStatus(request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)

GetServiceStatus 用于查询该用户是否已开通KMS服务

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetServiceStatusWithContext added in v1.0.324

func (c *Client) GetServiceStatusWithContext(ctx context.Context, request *GetServiceStatusRequest) (response *GetServiceStatusResponse, err error)

GetServiceStatus 用于查询该用户是否已开通KMS服务

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ImportKeyMaterial

func (c *Client) ImportKeyMaterial(request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)

ImportKeyMaterial 用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。

只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
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 added in v1.0.324

func (c *Client) ImportKeyMaterialWithContext(ctx context.Context, request *ImportKeyMaterialRequest) (response *ImportKeyMaterialResponse, err error)

ImportKeyMaterial 用于导入密钥材料。只有类型为EXTERNAL 的CMK 才可以导入,导入的密钥材料使用 GetParametersForImport 获取的密钥进行加密。可以为指定的 CMK 重新导入密钥材料,并重新指定过期时间,但必须导入相同的密钥材料。CMK 密钥材料导入后不可以更换密钥材料。导入的密钥材料过期或者被删除后,指定的CMK将无法使用,需要再次导入相同的密钥材料才能正常使用。CMK是独立的,同样的密钥材料可导入不同的 CMK 中,但使用其中一个 CMK 加密的数据无法使用另一个 CMK解密。

只有Enabled 和 PendingImport状态的CMK可以导入密钥材料。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_DECRYPTMATERIALERROR = "InvalidParameter.DecryptMaterialError"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
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 列出当前Region支持的加密方式

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListAlgorithmsWithContext added in v1.0.324

func (c *Client) ListAlgorithmsWithContext(ctx context.Context, request *ListAlgorithmsRequest) (response *ListAlgorithmsResponse, err error)

ListAlgorithms 列出当前Region支持的加密方式

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeyDetail

func (c *Client) ListKeyDetail(request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)

ListKeyDetail 根据指定Offset和Limit获取主密钥列表详情。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeyDetailWithContext added in v1.0.324

func (c *Client) ListKeyDetailWithContext(ctx context.Context, request *ListKeyDetailRequest) (response *ListKeyDetailResponse, err error)

ListKeyDetail 根据指定Offset和Limit获取主密钥列表详情。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeys

func (c *Client) ListKeys(request *ListKeysRequest) (response *ListKeysResponse, err error)

ListKeys 列出账号下面状态为Enabled, Disabled 和 PendingImport 的CMK KeyId 列表

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListKeysWithContext added in v1.0.324

func (c *Client) ListKeysWithContext(ctx context.Context, request *ListKeysRequest) (response *ListKeysResponse, err error)

ListKeys 列出账号下面状态为Enabled, Disabled 和 PendingImport 的CMK KeyId 列表

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDHSMCLUSTERID = "InvalidParameterValue.InvalidHsmClusterId"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) OverwriteWhiteBoxDeviceFingerprints

func (c *Client) OverwriteWhiteBoxDeviceFingerprints(request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)

OverwriteWhiteBoxDeviceFingerprints 覆盖指定密钥的设备指纹信息

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) OverwriteWhiteBoxDeviceFingerprintsWithContext added in v1.0.324

func (c *Client) OverwriteWhiteBoxDeviceFingerprintsWithContext(ctx context.Context, request *OverwriteWhiteBoxDeviceFingerprintsRequest) (response *OverwriteWhiteBoxDeviceFingerprintsResponse, err error)

OverwriteWhiteBoxDeviceFingerprints 覆盖指定密钥的设备指纹信息

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
LIMITEXCEEDED_FINGERPRINTSLIMITEXCEEDED = "LimitExceeded.FingerprintsLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoDecrypt added in v1.0.649

func (c *Client) PostQuantumCryptoDecrypt(request *PostQuantumCryptoDecryptRequest) (response *PostQuantumCryptoDecryptResponse, err error)

PostQuantumCryptoDecrypt 本接口使用后量子密码算法密钥,解密密文,并得到明文数据。

可能返回的错误码:

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoDecryptWithContext added in v1.0.649

func (c *Client) PostQuantumCryptoDecryptWithContext(ctx context.Context, request *PostQuantumCryptoDecryptRequest) (response *PostQuantumCryptoDecryptResponse, err error)

PostQuantumCryptoDecrypt 本接口使用后量子密码算法密钥,解密密文,并得到明文数据。

可能返回的错误码:

FAILEDOPERATION_ENCRYPTIONERROR = "FailedOperation.EncryptionError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDCIPHERTEXT = "InvalidParameterValue.InvalidCiphertext"
RESOURCEUNAVAILABLE_CMKDISABLED = "ResourceUnavailable.CmkDisabled"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PostQuantumCryptoEncrypt added in v1.0.649

func (c *Client) PostQuantumCryptoEncrypt(request *PostQuantumCryptoEncryptRequest) (response *PostQuantumCryptoEncryptResponse, err error)

PostQuantumCryptoEncrypt 本接口使用后量子密码算法密钥,可加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作。

可能返回的错误码:

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) PostQuantumCryptoEncryptWithContext added in v1.0.649

func (c *Client) PostQuantumCryptoEncryptWithContext(ctx context.Context, request *PostQuantumCryptoEncryptRequest) (response *PostQuantumCryptoEncryptResponse, err error)

PostQuantumCryptoEncrypt 本接口使用后量子密码算法密钥,可加密最多为4KB任意数据,可用于加密数据库密码,RSA Key,或其它较小的敏感信息。对于应用的数据加密,使用GenerateDataKey生成的DataKey进行本地数据的加解密操作。

可能返回的错误码:

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) PostQuantumCryptoSign added in v1.0.649

func (c *Client) PostQuantumCryptoSign(request *PostQuantumCryptoSignRequest) (response *PostQuantumCryptoSignResponse, err error)

PostQuantumCryptoSign 使用后量子密码算法签名验签密钥进行签名。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) PostQuantumCryptoSignWithContext added in v1.0.649

func (c *Client) PostQuantumCryptoSignWithContext(ctx context.Context, request *PostQuantumCryptoSignRequest) (response *PostQuantumCryptoSignResponse, err error)

PostQuantumCryptoSign 使用后量子密码算法签名验签密钥进行签名。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) PostQuantumCryptoVerify added in v1.0.649

func (c *Client) PostQuantumCryptoVerify(request *PostQuantumCryptoVerifyRequest) (response *PostQuantumCryptoVerifyResponse, err error)

PostQuantumCryptoVerify 使用后量子密码算法密钥对签名进行验证。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) PostQuantumCryptoVerifyWithContext added in v1.0.649

func (c *Client) PostQuantumCryptoVerifyWithContext(ctx context.Context, request *PostQuantumCryptoVerifyRequest) (response *PostQuantumCryptoVerifyResponse, err error)

PostQuantumCryptoVerify 使用后量子密码算法密钥对签名进行验证。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) ReEncrypt

func (c *Client) ReEncrypt(request *ReEncryptRequest) (response *ReEncryptResponse, err error)

ReEncrypt 使用指定CMK对密文重新加密。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) ReEncryptWithContext(ctx context.Context, request *ReEncryptRequest) (response *ReEncryptResponse, err error)

ReEncrypt 使用指定CMK对密文重新加密。

可能返回的错误码:

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计划删除接口,用于指定CMK删除的时间,可选时间区间为[7,30]天

可能返回的错误码:

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 added in v1.0.324

func (c *Client) ScheduleKeyDeletionWithContext(ctx context.Context, request *ScheduleKeyDeletionRequest) (response *ScheduleKeyDeletionResponse, err error)

ScheduleKeyDeletion CMK计划删除接口,用于指定CMK删除的时间,可选时间区间为[7,30]天

可能返回的错误码:

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 非对称密钥签名。

注意:只有 KeyUsage 为 ASYMMETRIC_SIGN_VERIFY_SM2、ASYMMETRIC_SIGN_VERIFY_ECC 或其他支持的 ASYMMETRIC_SIGN_VERIFY_${ALGORITHM} 的密钥才可以使用签名功能。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) SignByAsymmetricKeyWithContext added in v1.0.324

func (c *Client) SignByAsymmetricKeyWithContext(ctx context.Context, request *SignByAsymmetricKeyRequest) (response *SignByAsymmetricKeyResponse, err error)

SignByAsymmetricKey 非对称密钥签名。

注意:只有 KeyUsage 为 ASYMMETRIC_SIGN_VERIFY_SM2、ASYMMETRIC_SIGN_VERIFY_ECC 或其他支持的 ASYMMETRIC_SIGN_VERIFY_${ALGORITHM} 的密钥才可以使用签名功能。

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
MISSINGPARAMETER = "MissingParameter"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) UnbindCloudResource

func (c *Client) UnbindCloudResource(request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)

UnbindCloudResource 删除指定(key, 资源,云产品)的记录,以表明:指定的云产品的资源已不再使用当前的key。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) UnbindCloudResourceWithContext(ctx context.Context, request *UnbindCloudResourceRequest) (response *UnbindCloudResourceResponse, err error)

UnbindCloudResource 删除指定(key, 资源,云产品)的记录,以表明:指定的云产品的资源已不再使用当前的key。

可能返回的错误码:

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 用于修改CMK的别名。对于处于PendingDelete状态的CMK禁止修改。

可能返回的错误码:

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 added in v1.0.324

func (c *Client) UpdateAliasWithContext(ctx context.Context, request *UpdateAliasRequest) (response *UpdateAliasResponse, err error)

UpdateAlias 用于修改CMK的别名。对于处于PendingDelete状态的CMK禁止修改。

可能返回的错误码:

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 该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNSUPPORTEDOPERATION_SERVICETEMPORARYUNAVAILABLE = "UnsupportedOperation.ServiceTemporaryUnavailable"

func (*Client) UpdateKeyDescriptionWithContext added in v1.0.324

func (c *Client) UpdateKeyDescriptionWithContext(ctx context.Context, request *UpdateKeyDescriptionRequest) (response *UpdateKeyDescriptionResponse, err error)

UpdateKeyDescription 该接口用于对指定的cmk修改描述信息。对于处于PendingDelete状态的CMK禁止修改。

可能返回的错误码:

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 使用非对称密钥验签

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

func (*Client) VerifyByAsymmetricKeyWithContext added in v1.0.324

func (c *Client) VerifyByAsymmetricKeyWithContext(ctx context.Context, request *VerifyByAsymmetricKeyRequest) (response *VerifyByAsymmetricKeyResponse, err error)

VerifyByAsymmetricKey 使用非对称密钥验签

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_INVALIDKEYID = "InvalidParameterValue.InvalidKeyId"
RESOURCEUNAVAILABLE_CMKNOTFOUND = "ResourceUnavailable.CmkNotFound"
RESOURCEUNAVAILABLE_CMKSTATENOTSUPPORT = "ResourceUnavailable.CmkStateNotSupport"

type CreateKeyRequest

type CreateKeyRequest struct {
	*tchttp.BaseRequest

	// 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。以 kms- 作为前缀的用于云产品使用,Alias 不可重复。
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// CMK 的描述,最大1024字节
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定key的用途,默认为  "ENCRYPT_DECRYPT" 表示创建对称加解密密钥,其它支持用途 “ASYMMETRIC_DECRYPT_RSA_2048” 表示创建用于加解密的RSA2048非对称密钥,“ASYMMETRIC_DECRYPT_SM2” 表示创建用于加解密的SM2非对称密钥,“ASYMMETRIC_SIGN_VERIFY_SM2” 表示创建用于签名验签的SM2非对称密钥,“ASYMMETRIC_SIGN_VERIFY_ECC” 表示创建用于签名验签的ECC非对称密钥,“ASYMMETRIC_SIGN_VERIFY_RSA_2048” 表示创建用于签名验签的RSA_2048非对称密钥,“ASYMMETRIC_SIGN_VERIFY_ECDSA384”表示创建用于签名验签的 ECDSA384 非对称秘钥。完整的秘钥用途与算法支持列表可通过 ListAlgorithms 接口获取。
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// 指定key类型,默认为1,1表示默认类型,由KMS创建CMK密钥,2 表示EXTERNAL 类型,该类型需要用户导入密钥材料,参考 GetParametersForImport 和 ImportKeyMaterial 接口
	Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`

	// 标签列表
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

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 CreateKeyRequestParams added in v1.0.426

type CreateKeyRequestParams struct {
	// 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。以 kms- 作为前缀的用于云产品使用,Alias 不可重复。
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// CMK 的描述,最大1024字节
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定key的用途,默认为  "ENCRYPT_DECRYPT" 表示创建对称加解密密钥,其它支持用途 “ASYMMETRIC_DECRYPT_RSA_2048” 表示创建用于加解密的RSA2048非对称密钥,“ASYMMETRIC_DECRYPT_SM2” 表示创建用于加解密的SM2非对称密钥,“ASYMMETRIC_SIGN_VERIFY_SM2” 表示创建用于签名验签的SM2非对称密钥,“ASYMMETRIC_SIGN_VERIFY_ECC” 表示创建用于签名验签的ECC非对称密钥,“ASYMMETRIC_SIGN_VERIFY_RSA_2048” 表示创建用于签名验签的RSA_2048非对称密钥,“ASYMMETRIC_SIGN_VERIFY_ECDSA384”表示创建用于签名验签的 ECDSA384 非对称秘钥。完整的秘钥用途与算法支持列表可通过 ListAlgorithms 接口获取。
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// 指定key类型,默认为1,1表示默认类型,由KMS创建CMK密钥,2 表示EXTERNAL 类型,该类型需要用户导入密钥材料,参考 GetParametersForImport 和 ImportKeyMaterial 接口
	Type *uint64 `json:"Type,omitnil,omitempty" name:"Type"`

	// 标签列表
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

Predefined struct for user

type CreateKeyResponse

type CreateKeyResponse struct {
	*tchttp.BaseResponse
	Response *CreateKeyResponseParams `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 CreateKeyResponseParams added in v1.0.426

type CreateKeyResponseParams struct {
	// CMK的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 作为密钥更容易辨识,更容易被人看懂的别名
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// 密钥创建时间,unix时间戳
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// CMK的描述
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// CMK的状态
	KeyState *string `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// CMK的用途
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// 标签操作的返回信息
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateWhiteBoxKeyRequest

type CreateWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。Alias不可重复。
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// 创建密钥所有的算法类型,支持的取值:AES_256,SM4
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// 密钥的描述,最大1024字节
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 标签列表
	Tags []*Tag `json:"Tags,omitnil,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 CreateWhiteBoxKeyRequestParams added in v1.0.426

type CreateWhiteBoxKeyRequestParams struct {
	// 作为密钥更容易辨识,更容易被人看懂的别名, 不可为空,1-60个字母数字 - _ 的组合,首字符必须为字母或者数字。Alias不可重复。
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// 创建密钥所有的算法类型,支持的取值:AES_256,SM4
	Algorithm *string `json:"Algorithm,omitnil,omitempty" name:"Algorithm"`

	// 密钥的描述,最大1024字节
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 标签列表
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateWhiteBoxKeyResponse

type CreateWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *CreateWhiteBoxKeyResponseParams `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 CreateWhiteBoxKeyResponseParams added in v1.0.426

type CreateWhiteBoxKeyResponseParams struct {
	// 用于加密的密钥,base64编码
	EncryptKey *string `json:"EncryptKey,omitnil,omitempty" name:"EncryptKey"`

	// 用于解密的密钥,base64编码
	DecryptKey *string `json:"DecryptKey,omitnil,omitempty" name:"DecryptKey"`

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// 标签操作的返回信息
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DecryptRequest

type DecryptRequest struct {
	*tchttp.BaseRequest

	// 待解密的密文数据
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// key/value对的json字符串,如果Encrypt指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024字符
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

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 DecryptRequestParams added in v1.0.426

type DecryptRequestParams struct {
	// 待解密的密文数据
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// key/value对的json字符串,如果Encrypt指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024字符
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

Predefined struct for user

type DecryptResponse

type DecryptResponse struct {
	*tchttp.BaseResponse
	Response *DecryptResponseParams `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 DecryptResponseParams added in v1.0.426

type DecryptResponseParams struct {
	// CMK的全局唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。
	// 若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteImportedKeyMaterialRequest

type DeleteImportedKeyMaterialRequest struct {
	*tchttp.BaseRequest

	// 指定需要删除密钥材料的EXTERNAL CMK。
	KeyId *string `json:"KeyId,omitnil,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 DeleteImportedKeyMaterialRequestParams added in v1.0.426

type DeleteImportedKeyMaterialRequestParams struct {
	// 指定需要删除密钥材料的EXTERNAL CMK。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DeleteImportedKeyMaterialResponse

type DeleteImportedKeyMaterialResponse struct {
	*tchttp.BaseResponse
	Response *DeleteImportedKeyMaterialResponseParams `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 DeleteImportedKeyMaterialResponseParams added in v1.0.426

type DeleteImportedKeyMaterialResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteWhiteBoxKeyRequest

type DeleteWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DeleteWhiteBoxKeyRequestParams added in v1.0.426

type DeleteWhiteBoxKeyRequestParams struct {
	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DeleteWhiteBoxKeyResponse

type DeleteWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *DeleteWhiteBoxKeyResponseParams `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 DeleteWhiteBoxKeyResponseParams added in v1.0.426

type DeleteWhiteBoxKeyResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeKeyRequest

type DescribeKeyRequest struct {
	*tchttp.BaseRequest

	// CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DescribeKeyRequestParams added in v1.0.426

type DescribeKeyRequestParams struct {
	// CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeKeyResponse

type DescribeKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKeyResponseParams `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 DescribeKeyResponseParams added in v1.0.426

type DescribeKeyResponseParams struct {
	// 密钥属性信息
	KeyMetadata *KeyMetadata `json:"KeyMetadata,omitnil,omitempty" name:"KeyMetadata"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeKeysRequest

type DescribeKeysRequest struct {
	*tchttp.BaseRequest

	// 查询CMK的ID列表,批量查询一次最多支持100个KeyId
	KeyIds []*string `json:"KeyIds,omitnil,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 DescribeKeysRequestParams added in v1.0.426

type DescribeKeysRequestParams struct {
	// 查询CMK的ID列表,批量查询一次最多支持100个KeyId
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type DescribeKeysResponse

type DescribeKeysResponse struct {
	*tchttp.BaseResponse
	Response *DescribeKeysResponseParams `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 DescribeKeysResponseParams added in v1.0.426

type DescribeKeysResponseParams struct {
	// 返回的属性信息列表
	KeyMetadatas []*KeyMetadata `json:"KeyMetadatas,omitnil,omitempty" name:"KeyMetadatas"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxDecryptKeyRequest

type DescribeWhiteBoxDecryptKeyRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DescribeWhiteBoxDecryptKeyRequestParams added in v1.0.426

type DescribeWhiteBoxDecryptKeyRequestParams struct {
	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeWhiteBoxDecryptKeyResponse

type DescribeWhiteBoxDecryptKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxDecryptKeyResponseParams `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 DescribeWhiteBoxDecryptKeyResponseParams added in v1.0.426

type DescribeWhiteBoxDecryptKeyResponseParams struct {
	// 白盒解密密钥,base64编码
	DecryptKey *string `json:"DecryptKey,omitnil,omitempty" name:"DecryptKey"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxDeviceFingerprintsRequest

type DescribeWhiteBoxDeviceFingerprintsRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewDescribeWhiteBoxDeviceFingerprintsRequest

func NewDescribeWhiteBoxDeviceFingerprintsRequest() (request *DescribeWhiteBoxDeviceFingerprintsRequest)

func (*DescribeWhiteBoxDeviceFingerprintsRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxDeviceFingerprintsRequest) ToJsonString

type DescribeWhiteBoxDeviceFingerprintsRequestParams added in v1.0.426

type DescribeWhiteBoxDeviceFingerprintsRequestParams struct {
	// 白盒密钥ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeWhiteBoxDeviceFingerprintsResponse

type DescribeWhiteBoxDeviceFingerprintsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxDeviceFingerprintsResponseParams `json:"Response"`
}

func NewDescribeWhiteBoxDeviceFingerprintsResponse

func NewDescribeWhiteBoxDeviceFingerprintsResponse() (response *DescribeWhiteBoxDeviceFingerprintsResponse)

func (*DescribeWhiteBoxDeviceFingerprintsResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DescribeWhiteBoxDeviceFingerprintsResponse) ToJsonString

type DescribeWhiteBoxDeviceFingerprintsResponseParams added in v1.0.426

type DescribeWhiteBoxDeviceFingerprintsResponseParams struct {
	// 设备指纹列表
	DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitnil,omitempty" name:"DeviceFingerprints"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxKeyDetailsRequest

type DescribeWhiteBoxKeyDetailsRequest struct {
	*tchttp.BaseRequest

	// 过滤条件:密钥的状态,0:disabled,1:enabled
	KeyStatus *int64 `json:"KeyStatus,omitnil,omitempty" name:"KeyStatus"`

	// 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为0, 表示不分页
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 标签过滤条件
	TagFilters []*TagFilter `json:"TagFilters,omitnil,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 DescribeWhiteBoxKeyDetailsRequestParams added in v1.0.426

type DescribeWhiteBoxKeyDetailsRequestParams struct {
	// 过滤条件:密钥的状态,0:disabled,1:enabled
	KeyStatus *int64 `json:"KeyStatus,omitnil,omitempty" name:"KeyStatus"`

	// 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为0, 表示不分页
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 标签过滤条件
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`
}

Predefined struct for user

type DescribeWhiteBoxKeyDetailsResponse

type DescribeWhiteBoxKeyDetailsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxKeyDetailsResponseParams `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 DescribeWhiteBoxKeyDetailsResponseParams added in v1.0.426

type DescribeWhiteBoxKeyDetailsResponseParams struct {
	// 白盒密钥信息列表。
	KeyInfos []*WhiteboxKeyInfo `json:"KeyInfos,omitnil,omitempty" name:"KeyInfos"`

	// 白盒密钥总数。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeWhiteBoxKeyRequest

type DescribeWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DescribeWhiteBoxKeyRequestParams added in v1.0.426

type DescribeWhiteBoxKeyRequestParams struct {
	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DescribeWhiteBoxKeyResponse

type DescribeWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxKeyResponseParams `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 DescribeWhiteBoxKeyResponseParams added in v1.0.426

type DescribeWhiteBoxKeyResponseParams struct {
	// 白盒密钥信息
	KeyInfo *WhiteboxKeyInfo `json:"KeyInfo,omitnil,omitempty" name:"KeyInfo"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

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 DescribeWhiteBoxServiceStatusRequestParams added in v1.0.426

type DescribeWhiteBoxServiceStatusRequestParams struct {
}

Predefined struct for user

type DescribeWhiteBoxServiceStatusResponse

type DescribeWhiteBoxServiceStatusResponse struct {
	*tchttp.BaseResponse
	Response *DescribeWhiteBoxServiceStatusResponseParams `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

type DescribeWhiteBoxServiceStatusResponseParams added in v1.0.426

type DescribeWhiteBoxServiceStatusResponseParams struct {
	// 用户的白盒密钥服务是否可用
	ServiceEnabled *bool `json:"ServiceEnabled,omitnil,omitempty" name:"ServiceEnabled"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeviceFingerprint

type DeviceFingerprint struct {
	// 指纹信息,由设备指纹采集工具采集获得,格式满足正则表达式:^[0-9a-f]{8}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{14}[\-][0-9a-f]{16}$
	Identity *string `json:"Identity,omitnil,omitempty" name:"Identity"`

	// 描述信息,如:IP,设备名称等,最大1024字节
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

type DisableKeyRequest

type DisableKeyRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DisableKeyRequestParams added in v1.0.426

type DisableKeyRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DisableKeyResponse

type DisableKeyResponse struct {
	*tchttp.BaseResponse
	Response *DisableKeyResponseParams `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 DisableKeyResponseParams added in v1.0.426

type DisableKeyResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableKeyRotationRequest

type DisableKeyRotationRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DisableKeyRotationRequestParams added in v1.0.426

type DisableKeyRotationRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DisableKeyRotationResponse

type DisableKeyRotationResponse struct {
	*tchttp.BaseResponse
	Response *DisableKeyRotationResponseParams `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 DisableKeyRotationResponseParams added in v1.0.426

type DisableKeyRotationResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableKeysRequest

type DisableKeysRequest struct {
	*tchttp.BaseRequest

	// 需要批量禁用的CMK Id 列表,CMK数量最大支持100
	KeyIds []*string `json:"KeyIds,omitnil,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 DisableKeysRequestParams added in v1.0.426

type DisableKeysRequestParams struct {
	// 需要批量禁用的CMK Id 列表,CMK数量最大支持100
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type DisableKeysResponse

type DisableKeysResponse struct {
	*tchttp.BaseResponse
	Response *DisableKeysResponseParams `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 DisableKeysResponseParams added in v1.0.426

type DisableKeysResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableWhiteBoxKeyRequest

type DisableWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 DisableWhiteBoxKeyRequestParams added in v1.0.426

type DisableWhiteBoxKeyRequestParams struct {
	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type DisableWhiteBoxKeyResponse

type DisableWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *DisableWhiteBoxKeyResponseParams `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 DisableWhiteBoxKeyResponseParams added in v1.0.426

type DisableWhiteBoxKeyResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableWhiteBoxKeysRequest

type DisableWhiteBoxKeysRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符列表。注意:要确保所有提供的KeyId是格式有效的,没有重复,个数不超过50个,并且都是有效存在的。
	KeyIds []*string `json:"KeyIds,omitnil,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 DisableWhiteBoxKeysRequestParams added in v1.0.426

type DisableWhiteBoxKeysRequestParams struct {
	// 白盒密钥的全局唯一标识符列表。注意:要确保所有提供的KeyId是格式有效的,没有重复,个数不超过50个,并且都是有效存在的。
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type DisableWhiteBoxKeysResponse

type DisableWhiteBoxKeysResponse struct {
	*tchttp.BaseResponse
	Response *DisableWhiteBoxKeysResponseParams `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 DisableWhiteBoxKeysResponseParams added in v1.0.426

type DisableWhiteBoxKeysResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableKeyRequest

type EnableKeyRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 EnableKeyRequestParams added in v1.0.426

type EnableKeyRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type EnableKeyResponse

type EnableKeyResponse struct {
	*tchttp.BaseResponse
	Response *EnableKeyResponseParams `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 EnableKeyResponseParams added in v1.0.426

type EnableKeyResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableKeyRotationRequest

type EnableKeyRotationRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 密钥轮转周期,单位天,允许范围 7 ~ 365,默认值 365。
	RotateDays *uint64 `json:"RotateDays,omitnil,omitempty" name:"RotateDays"`
}

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 EnableKeyRotationRequestParams added in v1.0.426

type EnableKeyRotationRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 密钥轮转周期,单位天,允许范围 7 ~ 365,默认值 365。
	RotateDays *uint64 `json:"RotateDays,omitnil,omitempty" name:"RotateDays"`
}

Predefined struct for user

type EnableKeyRotationResponse

type EnableKeyRotationResponse struct {
	*tchttp.BaseResponse
	Response *EnableKeyRotationResponseParams `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 EnableKeyRotationResponseParams added in v1.0.426

type EnableKeyRotationResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableKeysRequest

type EnableKeysRequest struct {
	*tchttp.BaseRequest

	// 需要批量启用的CMK Id 列表, CMK数量最大支持100
	KeyIds []*string `json:"KeyIds,omitnil,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 EnableKeysRequestParams added in v1.0.426

type EnableKeysRequestParams struct {
	// 需要批量启用的CMK Id 列表, CMK数量最大支持100
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type EnableKeysResponse

type EnableKeysResponse struct {
	*tchttp.BaseResponse
	Response *EnableKeysResponseParams `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 EnableKeysResponseParams added in v1.0.426

type EnableKeysResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableWhiteBoxKeyRequest

type EnableWhiteBoxKeyRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 EnableWhiteBoxKeyRequestParams added in v1.0.426

type EnableWhiteBoxKeyRequestParams struct {
	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type EnableWhiteBoxKeyResponse

type EnableWhiteBoxKeyResponse struct {
	*tchttp.BaseResponse
	Response *EnableWhiteBoxKeyResponseParams `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 EnableWhiteBoxKeyResponseParams added in v1.0.426

type EnableWhiteBoxKeyResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableWhiteBoxKeysRequest

type EnableWhiteBoxKeysRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符列表。注意:要确保所有提供的KeyId是格式有效的,没有重复,个数不超过50个,并且都是有效存在的。
	KeyIds []*string `json:"KeyIds,omitnil,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 EnableWhiteBoxKeysRequestParams added in v1.0.426

type EnableWhiteBoxKeysRequestParams struct {
	// 白盒密钥的全局唯一标识符列表。注意:要确保所有提供的KeyId是格式有效的,没有重复,个数不超过50个,并且都是有效存在的。
	KeyIds []*string `json:"KeyIds,omitnil,omitempty" name:"KeyIds"`
}

Predefined struct for user

type EnableWhiteBoxKeysResponse

type EnableWhiteBoxKeysResponse struct {
	*tchttp.BaseResponse
	Response *EnableWhiteBoxKeysResponseParams `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 EnableWhiteBoxKeysResponseParams added in v1.0.426

type EnableWhiteBoxKeysResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EncryptByWhiteBoxRequest

type EncryptByWhiteBoxRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 待加密的文本, base64编码,文本的原始长度最大不超过4KB
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`

	// 初始化向量,大小为 16 Bytes,加密算法会使用到, base64编码;如果不传,则由后端服务随机生成。用户需要自行保存该值,作为解密的参数。
	InitializationVector *string `json:"InitializationVector,omitnil,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 EncryptByWhiteBoxRequestParams added in v1.0.426

type EncryptByWhiteBoxRequestParams struct {
	// 白盒密钥的全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 待加密的文本, base64编码,文本的原始长度最大不超过4KB
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`

	// 初始化向量,大小为 16 Bytes,加密算法会使用到, base64编码;如果不传,则由后端服务随机生成。用户需要自行保存该值,作为解密的参数。
	InitializationVector *string `json:"InitializationVector,omitnil,omitempty" name:"InitializationVector"`
}

Predefined struct for user

type EncryptByWhiteBoxResponse

type EncryptByWhiteBoxResponse struct {
	*tchttp.BaseResponse
	Response *EncryptByWhiteBoxResponseParams `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 EncryptByWhiteBoxResponseParams added in v1.0.426

type EncryptByWhiteBoxResponseParams struct {
	// 初始化向量,加密算法会使用到, base64编码。如果由调用方在入参中传入,则原样返回。如果调用方没有传入,则后端服务随机生成,并返回
	InitializationVector *string `json:"InitializationVector,omitnil,omitempty" name:"InitializationVector"`

	// 加密后的密文,base64编码
	CipherText *string `json:"CipherText,omitnil,omitempty" name:"CipherText"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EncryptRequest

type EncryptRequest struct {
	*tchttp.BaseRequest

	// 调用CreateKey生成的CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// key/value对的json字符串,如果指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024个字符
	EncryptionContext *string `json:"EncryptionContext,omitnil,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 EncryptRequestParams added in v1.0.426

type EncryptRequestParams struct {
	// 调用CreateKey生成的CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// key/value对的json字符串,如果指定了该参数,则在调用Decrypt API时需要提供同样的参数,最大支持1024个字符
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`
}

Predefined struct for user

type EncryptResponse

type EncryptResponse struct {
	*tchttp.BaseResponse
	Response *EncryptResponseParams `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 EncryptResponseParams added in v1.0.426

type EncryptResponseParams struct {
	// 加密后的密文,base64编码。注意:本字段中打包了密文和密钥的相关信息,不是对明文的直接加密结果,只有将该字段作为Decrypt接口的输入参数,才可以解密出原文。
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// 加密使用的CMK的全局唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GenerateDataKeyRequest

type GenerateDataKeyRequest struct {
	*tchttp.BaseRequest

	// CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 指定生成Datakey的加密算法以及Datakey大小,AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
	KeySpec *string `json:"KeySpec,omitnil,omitempty" name:"KeySpec"`

	// 生成的DataKey的长度,同时指定NumberOfBytes和KeySpec时,以NumberOfBytes为准。最小值为1, 最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`

	// key/value对的json字符串,如果使用该字段,则返回的DataKey在解密时需要填入相同的字符串
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

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 GenerateDataKeyRequestParams added in v1.0.426

type GenerateDataKeyRequestParams struct {
	// CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 指定生成Datakey的加密算法以及Datakey大小,AES_128或者AES_256。KeySpec 和 NumberOfBytes 必须指定一个
	KeySpec *string `json:"KeySpec,omitnil,omitempty" name:"KeySpec"`

	// 生成的DataKey的长度,同时指定NumberOfBytes和KeySpec时,以NumberOfBytes为准。最小值为1, 最大值为1024。KeySpec 和 NumberOfBytes 必须指定一个
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`

	// key/value对的json字符串,如果使用该字段,则返回的DataKey在解密时需要填入相同的字符串
	EncryptionContext *string `json:"EncryptionContext,omitnil,omitempty" name:"EncryptionContext"`

	// PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

Predefined struct for user

type GenerateDataKeyResponse

type GenerateDataKeyResponse struct {
	*tchttp.BaseResponse
	Response *GenerateDataKeyResponseParams `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 GenerateDataKeyResponseParams added in v1.0.426

type GenerateDataKeyResponseParams struct {
	// CMK的全局唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 若调用时未提供 EncryptionPublicKey,该字段值为生成的数据密钥 DataKey 的 Base64 编码的明文,需进行 Base64 解码以获取 DataKey 明文。
	// 若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取 DataKey 明文。
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// 数据密钥DataKey加密后的密文,用户需要自行保存该密文,KMS不托管用户的数据密钥。可以通过Decrypt接口从CiphertextBlob中获取数据密钥DataKey明文
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GenerateRandomRequest

type GenerateRandomRequest struct {
	*tchttp.BaseRequest

	// 生成的随机数的长度。最小值为1, 最大值为1024。
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,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 GenerateRandomRequestParams added in v1.0.426

type GenerateRandomRequestParams struct {
	// 生成的随机数的长度。最小值为1, 最大值为1024。
	NumberOfBytes *uint64 `json:"NumberOfBytes,omitnil,omitempty" name:"NumberOfBytes"`
}

Predefined struct for user

type GenerateRandomResponse

type GenerateRandomResponse struct {
	*tchttp.BaseResponse
	Response *GenerateRandomResponseParams `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 GenerateRandomResponseParams added in v1.0.426

type GenerateRandomResponseParams struct {
	// 生成的随机数的明文,该明文使用base64编码,用户需要使用base64解码得到明文。
	Plaintext *string `json:"Plaintext,omitnil,omitempty" name:"Plaintext"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetKeyRotationStatusRequest

type GetKeyRotationStatusRequest struct {
	*tchttp.BaseRequest

	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,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 GetKeyRotationStatusRequestParams added in v1.0.426

type GetKeyRotationStatusRequestParams struct {
	// CMK唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type GetKeyRotationStatusResponse

type GetKeyRotationStatusResponse struct {
	*tchttp.BaseResponse
	Response *GetKeyRotationStatusResponseParams `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 GetKeyRotationStatusResponseParams added in v1.0.426

type GetKeyRotationStatusResponseParams struct {
	// 密钥轮换是否开启
	KeyRotationEnabled *bool `json:"KeyRotationEnabled,omitnil,omitempty" name:"KeyRotationEnabled"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetParametersForImportRequest

type GetParametersForImportRequest struct {
	*tchttp.BaseRequest

	// CMK的唯一标识,获取密钥参数的CMK必须是EXTERNAL类型,即在CreateKey时指定Type=2 类型的CMK。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 指定加密密钥材料的算法,目前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256
	WrappingAlgorithm *string `json:"WrappingAlgorithm,omitnil,omitempty" name:"WrappingAlgorithm"`

	// 指定加密密钥材料的类型,目前只支持RSA_2048
	WrappingKeySpec *string `json:"WrappingKeySpec,omitnil,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 GetParametersForImportRequestParams added in v1.0.426

type GetParametersForImportRequestParams struct {
	// CMK的唯一标识,获取密钥参数的CMK必须是EXTERNAL类型,即在CreateKey时指定Type=2 类型的CMK。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 指定加密密钥材料的算法,目前支持RSAES_PKCS1_V1_5、RSAES_OAEP_SHA_1、RSAES_OAEP_SHA_256
	WrappingAlgorithm *string `json:"WrappingAlgorithm,omitnil,omitempty" name:"WrappingAlgorithm"`

	// 指定加密密钥材料的类型,目前只支持RSA_2048
	WrappingKeySpec *string `json:"WrappingKeySpec,omitnil,omitempty" name:"WrappingKeySpec"`
}

Predefined struct for user

type GetParametersForImportResponse

type GetParametersForImportResponse struct {
	*tchttp.BaseResponse
	Response *GetParametersForImportResponseParams `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 GetParametersForImportResponseParams added in v1.0.426

type GetParametersForImportResponseParams struct {
	// CMK的唯一标识,用于指定目标导入密钥材料的CMK。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 导入密钥材料需要的token,用于作为 ImportKeyMaterial 的参数。
	ImportToken *string `json:"ImportToken,omitnil,omitempty" name:"ImportToken"`

	// 用于加密密钥材料的RSA公钥,base64编码。使用PublicKey base64解码后的公钥将导入密钥进行加密后作为 ImportKeyMaterial 的参数。
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// 该导出token和公钥的有效期,超过该时间后无法导入,需要重新调用GetParametersForImport获取。
	ParametersValidTo *uint64 `json:"ParametersValidTo,omitnil,omitempty" name:"ParametersValidTo"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetPublicKeyRequest

type GetPublicKeyRequest struct {
	*tchttp.BaseRequest

	// CMK的唯一标识。
	KeyId *string `json:"KeyId,omitnil,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 GetPublicKeyRequestParams added in v1.0.426

type GetPublicKeyRequestParams struct {
	// CMK的唯一标识。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type GetPublicKeyResponse

type GetPublicKeyResponse struct {
	*tchttp.BaseResponse
	Response *GetPublicKeyResponseParams `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 GetPublicKeyResponseParams added in v1.0.426

type GetPublicKeyResponseParams struct {
	// CMK的唯一标识。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 经过base64编码的公钥内容。
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// PEM格式的公钥内容。
	PublicKeyPem *string `json:"PublicKeyPem,omitnil,omitempty" name:"PublicKeyPem"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

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 GetRegionsRequestParams added in v1.0.426

type GetRegionsRequestParams struct {
}

Predefined struct for user

type GetRegionsResponse

type GetRegionsResponse struct {
	*tchttp.BaseResponse
	Response *GetRegionsResponseParams `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 GetRegionsResponseParams added in v1.0.426

type GetRegionsResponseParams struct {
	// 可用region列表
	Regions []*string `json:"Regions,omitnil,omitempty" name:"Regions"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

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 GetServiceStatusRequestParams added in v1.0.426

type GetServiceStatusRequestParams struct {
}

Predefined struct for user

type GetServiceStatusResponse

type GetServiceStatusResponse struct {
	*tchttp.BaseResponse
	Response *GetServiceStatusResponseParams `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 GetServiceStatusResponseParams added in v1.0.426

type GetServiceStatusResponseParams struct {
	// KMS服务是否开通, true 表示已开通
	ServiceEnabled *bool `json:"ServiceEnabled,omitnil,omitempty" name:"ServiceEnabled"`

	// 服务不可用类型: 0-未购买,1-正常, 2-欠费停服, 3-资源释放
	InvalidType *int64 `json:"InvalidType,omitnil,omitempty" name:"InvalidType"`

	// 0-普通版,1-旗舰版
	UserLevel *uint64 `json:"UserLevel,omitnil,omitempty" name:"UserLevel"`

	// 旗舰版到期时间(Epoch Unix Timestamp)。
	ProExpireTime *uint64 `json:"ProExpireTime,omitnil,omitempty" name:"ProExpireTime"`

	// 旗舰版是否自动续费:0-不自动续费,1-自动续费
	ProRenewFlag *uint64 `json:"ProRenewFlag,omitnil,omitempty" name:"ProRenewFlag"`

	// 旗舰版购买记录的唯一性标识。如果为开通旗舰版,则返回值为空
	ProResourceId *string `json:"ProResourceId,omitnil,omitempty" name:"ProResourceId"`

	// 是否开通 KMS 托管版
	ExclusiveVSMEnabled *bool `json:"ExclusiveVSMEnabled,omitnil,omitempty" name:"ExclusiveVSMEnabled"`

	// 是否开通 KMS 独享版
	ExclusiveHSMEnabled *bool `json:"ExclusiveHSMEnabled,omitnil,omitempty" name:"ExclusiveHSMEnabled"`

	// KMS 订阅信息。
	SubscriptionInfo *string `json:"SubscriptionInfo,omitnil,omitempty" name:"SubscriptionInfo"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ImportKeyMaterialRequest

type ImportKeyMaterialRequest struct {
	*tchttp.BaseRequest

	// 使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。
	EncryptedKeyMaterial *string `json:"EncryptedKeyMaterial,omitnil,omitempty" name:"EncryptedKeyMaterial"`

	// 通过调用GetParametersForImport获得的导入令牌。
	ImportToken *string `json:"ImportToken,omitnil,omitempty" name:"ImportToken"`

	// 指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。
	ValidTo *uint64 `json:"ValidTo,omitnil,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 ImportKeyMaterialRequestParams added in v1.0.426

type ImportKeyMaterialRequestParams struct {
	// 使用GetParametersForImport 返回的PublicKey加密后的密钥材料base64编码。对于国密版本region的KMS,导入的密钥材料长度要求为 128 bit,FIPS版本region的KMS, 导入的密钥材料长度要求为 256 bit。
	EncryptedKeyMaterial *string `json:"EncryptedKeyMaterial,omitnil,omitempty" name:"EncryptedKeyMaterial"`

	// 通过调用GetParametersForImport获得的导入令牌。
	ImportToken *string `json:"ImportToken,omitnil,omitempty" name:"ImportToken"`

	// 指定导入密钥材料的CMK,需要和GetParametersForImport 指定的CMK相同。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 密钥材料过期时间 unix 时间戳,不指定或者 0 表示密钥材料不会过期,若指定过期时间,需要大于当前时间点,最大支持 2147443200。
	ValidTo *uint64 `json:"ValidTo,omitnil,omitempty" name:"ValidTo"`
}

Predefined struct for user

type ImportKeyMaterialResponse

type ImportKeyMaterialResponse struct {
	*tchttp.BaseResponse
	Response *ImportKeyMaterialResponseParams `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 ImportKeyMaterialResponseParams added in v1.0.426

type ImportKeyMaterialResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type Key

type Key struct {
	// CMK的全局唯一标识。
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

type KeyMetadata

type KeyMetadata struct {
	// CMK的全局唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 作为密钥更容易辨识,更容易被人看懂的别名
	Alias *string `json:"Alias,omitnil,omitempty" name:"Alias"`

	// 密钥创建时间
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// CMK的描述
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// CMK的状态, 取值为:Enabled | Disabled | PendingDelete | PendingImport | Archived
	KeyState *string `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// CMK用途,取值为: ENCRYPT_DECRYPT | ASYMMETRIC_DECRYPT_RSA_2048 | ASYMMETRIC_DECRYPT_SM2 | ASYMMETRIC_SIGN_VERIFY_SM2 | ASYMMETRIC_SIGN_VERIFY_RSA_2048 | ASYMMETRIC_SIGN_VERIFY_ECC
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// CMK类型,2 表示符合FIPS标准,4表示符合国密标准
	Type *int64 `json:"Type,omitnil,omitempty" name:"Type"`

	// 创建者
	CreatorUin *uint64 `json:"CreatorUin,omitnil,omitempty" name:"CreatorUin"`

	// 是否开启了密钥轮换功能
	KeyRotationEnabled *bool `json:"KeyRotationEnabled,omitnil,omitempty" name:"KeyRotationEnabled"`

	// CMK的创建者,用户创建的为 user,授权各云产品自动创建的为对应的产品名
	Owner *string `json:"Owner,omitnil,omitempty" name:"Owner"`

	// 在密钥轮换开启状态下,下次轮换的时间
	NextRotateTime *uint64 `json:"NextRotateTime,omitnil,omitempty" name:"NextRotateTime"`

	// 计划删除的时间
	DeletionDate *uint64 `json:"DeletionDate,omitnil,omitempty" name:"DeletionDate"`

	// CMK 密钥材料类型,由KMS创建的为: TENCENT_KMS, 由用户导入的类型为:EXTERNAL
	Origin *string `json:"Origin,omitnil,omitempty" name:"Origin"`

	// 在Origin为  EXTERNAL 时有效,表示密钥材料的有效日期, 0 表示不过期
	ValidTo *uint64 `json:"ValidTo,omitnil,omitempty" name:"ValidTo"`

	// 资源ID,格式:creatorUin/$creatorUin/$keyId
	ResourceId *string `json:"ResourceId,omitnil,omitempty" name:"ResourceId"`

	// HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`

	// 密钥轮转周期(天)
	RotateDays *uint64 `json:"RotateDays,omitnil,omitempty" name:"RotateDays"`

	// 上次乱转时间(Unix timestamp)
	LastRotateTime *uint64 `json:"LastRotateTime,omitnil,omitempty" name:"LastRotateTime"`
}

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 ListAlgorithmsRequestParams added in v1.0.426

type ListAlgorithmsRequestParams struct {
}

Predefined struct for user

type ListAlgorithmsResponse

type ListAlgorithmsResponse struct {
	*tchttp.BaseResponse
	Response *ListAlgorithmsResponseParams `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 ListAlgorithmsResponseParams added in v1.0.426

type ListAlgorithmsResponseParams struct {
	// 本地区支持的对称加密算法
	SymmetricAlgorithms []*AlgorithmInfo `json:"SymmetricAlgorithms,omitnil,omitempty" name:"SymmetricAlgorithms"`

	// 本地区支持的非对称加密算法
	AsymmetricAlgorithms []*AlgorithmInfo `json:"AsymmetricAlgorithms,omitnil,omitempty" name:"AsymmetricAlgorithms"`

	// 本地区支持的非对称签名验签算法
	AsymmetricSignVerifyAlgorithms []*AlgorithmInfo `json:"AsymmetricSignVerifyAlgorithms,omitnil,omitempty" name:"AsymmetricSignVerifyAlgorithms"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ListKeyDetailRequest

type ListKeyDetailRequest struct {
	*tchttp.BaseRequest

	// 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为10,最大值为200
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// 根据CMK创建时间排序, 0 表示按照降序排序,1表示按照升序排序
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// 根据CMK状态筛选, 0表示全部CMK, 1 表示仅查询Enabled CMK, 2 表示仅查询Disabled CMK,3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key),4 表示查询 PendingImport 状态的CMK,5 表示查询 Archived 状态的 CMK
	KeyState *uint64 `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// 根据KeyId或者Alias进行模糊匹配查询
	SearchKeyAlias *string `json:"SearchKeyAlias,omitnil,omitempty" name:"SearchKeyAlias"`

	// 根据CMK类型筛选, "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK, "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK,"ALL" 或者不设置表示两种类型都查询,大小写敏感。
	Origin *string `json:"Origin,omitnil,omitempty" name:"Origin"`

	// 根据CMK的KeyUsage筛选,ALL表示筛选全部,可使用的参数为:ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC,为空则默认筛选ENCRYPT_DECRYPT类型
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// 标签过滤条件
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

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 ListKeyDetailRequestParams added in v1.0.426

type ListKeyDetailRequestParams struct {
	// 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 含义跟 SQL 查询的 Limit 一致,表示本次最多获取 Limit 个元素。缺省值为10,最大值为200
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// 根据CMK创建时间排序, 0 表示按照降序排序,1表示按照升序排序
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// 根据CMK状态筛选, 0表示全部CMK, 1 表示仅查询Enabled CMK, 2 表示仅查询Disabled CMK,3 表示查询PendingDelete 状态的CMK(处于计划删除状态的Key),4 表示查询 PendingImport 状态的CMK,5 表示查询 Archived 状态的 CMK
	KeyState *uint64 `json:"KeyState,omitnil,omitempty" name:"KeyState"`

	// 根据KeyId或者Alias进行模糊匹配查询
	SearchKeyAlias *string `json:"SearchKeyAlias,omitnil,omitempty" name:"SearchKeyAlias"`

	// 根据CMK类型筛选, "TENCENT_KMS" 表示筛选密钥材料由KMS创建的CMK, "EXTERNAL" 表示筛选密钥材料需要用户导入的 EXTERNAL类型CMK,"ALL" 或者不设置表示两种类型都查询,大小写敏感。
	Origin *string `json:"Origin,omitnil,omitempty" name:"Origin"`

	// 根据CMK的KeyUsage筛选,ALL表示筛选全部,可使用的参数为:ALL 或 ENCRYPT_DECRYPT 或 ASYMMETRIC_DECRYPT_RSA_2048 或 ASYMMETRIC_DECRYPT_SM2 或 ASYMMETRIC_SIGN_VERIFY_SM2 或 ASYMMETRIC_SIGN_VERIFY_RSA_2048 或 ASYMMETRIC_SIGN_VERIFY_ECC,为空则默认筛选ENCRYPT_DECRYPT类型
	KeyUsage *string `json:"KeyUsage,omitnil,omitempty" name:"KeyUsage"`

	// 标签过滤条件
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

Predefined struct for user

type ListKeyDetailResponse

type ListKeyDetailResponse struct {
	*tchttp.BaseResponse
	Response *ListKeyDetailResponseParams `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 ListKeyDetailResponseParams added in v1.0.426

type ListKeyDetailResponseParams struct {
	// CMK的总数量
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 返回的属性信息列表。
	KeyMetadatas []*KeyMetadata `json:"KeyMetadatas,omitnil,omitempty" name:"KeyMetadatas"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ListKeysRequest

type ListKeysRequest struct {
	*tchttp.BaseRequest

	// 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

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 ListKeysRequestParams added in v1.0.426

type ListKeysRequestParams struct {
	// 含义跟 SQL 查询的 Offset 一致,表示本次获取从按一定顺序排列数组的第 Offset 个元素开始,缺省为0
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 含义跟 SQL 查询的 Limit 一致,表示本次获最多获取 Limit 个元素。缺省值为10,最大值为200
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据创建者角色筛选,默认 0 表示用户自己创建的cmk, 1 表示授权其它云产品自动创建的cmk
	Role *uint64 `json:"Role,omitnil,omitempty" name:"Role"`

	// KMS 高级版对应的 HSM 集群 ID(仅对 KMS 独占版/托管版服务实例有效)。
	HsmClusterId *string `json:"HsmClusterId,omitnil,omitempty" name:"HsmClusterId"`
}

Predefined struct for user

type ListKeysResponse

type ListKeysResponse struct {
	*tchttp.BaseResponse
	Response *ListKeysResponseParams `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 ListKeysResponseParams added in v1.0.426

type ListKeysResponseParams struct {
	// CMK列表数组
	Keys []*Key `json:"Keys,omitnil,omitempty" name:"Keys"`

	// CMK的总数量
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type OverwriteWhiteBoxDeviceFingerprintsRequest

type OverwriteWhiteBoxDeviceFingerprintsRequest struct {
	*tchttp.BaseRequest

	// 白盒密钥ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 设备指纹列表,如果列表为空,则表示删除该密钥对应的所有指纹信息。列表最大长度不超过200。
	DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitnil,omitempty" name:"DeviceFingerprints"`
}

func NewOverwriteWhiteBoxDeviceFingerprintsRequest

func NewOverwriteWhiteBoxDeviceFingerprintsRequest() (request *OverwriteWhiteBoxDeviceFingerprintsRequest)

func (*OverwriteWhiteBoxDeviceFingerprintsRequest) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OverwriteWhiteBoxDeviceFingerprintsRequest) ToJsonString

type OverwriteWhiteBoxDeviceFingerprintsRequestParams added in v1.0.426

type OverwriteWhiteBoxDeviceFingerprintsRequestParams struct {
	// 白盒密钥ID
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 设备指纹列表,如果列表为空,则表示删除该密钥对应的所有指纹信息。列表最大长度不超过200。
	DeviceFingerprints []*DeviceFingerprint `json:"DeviceFingerprints,omitnil,omitempty" name:"DeviceFingerprints"`
}

Predefined struct for user

type OverwriteWhiteBoxDeviceFingerprintsResponse

type OverwriteWhiteBoxDeviceFingerprintsResponse struct {
	*tchttp.BaseResponse
	Response *OverwriteWhiteBoxDeviceFingerprintsResponseParams `json:"Response"`
}

func NewOverwriteWhiteBoxDeviceFingerprintsResponse

func NewOverwriteWhiteBoxDeviceFingerprintsResponse() (response *OverwriteWhiteBoxDeviceFingerprintsResponse)

func (*OverwriteWhiteBoxDeviceFingerprintsResponse) FromJsonString

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*OverwriteWhiteBoxDeviceFingerprintsResponse) ToJsonString

type OverwriteWhiteBoxDeviceFingerprintsResponseParams added in v1.0.426

type OverwriteWhiteBoxDeviceFingerprintsResponseParams struct {
	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoDecryptRequest added in v1.0.649

type PostQuantumCryptoDecryptRequest struct {
	*tchttp.BaseRequest

	// 待解密的密文数据
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

func NewPostQuantumCryptoDecryptRequest added in v1.0.649

func NewPostQuantumCryptoDecryptRequest() (request *PostQuantumCryptoDecryptRequest)

func (*PostQuantumCryptoDecryptRequest) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoDecryptRequest) 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 (*PostQuantumCryptoDecryptRequest) ToJsonString added in v1.0.649

func (r *PostQuantumCryptoDecryptRequest) ToJsonString() string

type PostQuantumCryptoDecryptRequestParams added in v1.0.649

type PostQuantumCryptoDecryptRequestParams struct {
	// 待解密的密文数据
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// PEM 格式公钥字符串,支持 RSA2048 和 SM2 公钥,用于对返回数据中的 Plaintext 值进行加密。若为空,则不对 Plaintext 值加密。
	EncryptionPublicKey *string `json:"EncryptionPublicKey,omitnil,omitempty" name:"EncryptionPublicKey"`

	// 非对称加密算法,配合 EncryptionPublicKey 对返回数据进行加密。目前支持:SM2(以 C1C3C2 格式返回密文),SM2_C1C3C2_ASN1 (以 C1C3C2 ASN1 格式返回密文),RSAES_PKCS1_V1_5,RSAES_OAEP_SHA_1,RSAES_OAEP_SHA_256。若为空,则默认为 SM2。
	EncryptionAlgorithm *string `json:"EncryptionAlgorithm,omitnil,omitempty" name:"EncryptionAlgorithm"`
}

Predefined struct for user

type PostQuantumCryptoDecryptResponse added in v1.0.649

type PostQuantumCryptoDecryptResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoDecryptResponseParams `json:"Response"`
}

func NewPostQuantumCryptoDecryptResponse added in v1.0.649

func NewPostQuantumCryptoDecryptResponse() (response *PostQuantumCryptoDecryptResponse)

func (*PostQuantumCryptoDecryptResponse) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoDecryptResponse) 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 (*PostQuantumCryptoDecryptResponse) ToJsonString added in v1.0.649

func (r *PostQuantumCryptoDecryptResponse) ToJsonString() string

type PostQuantumCryptoDecryptResponseParams added in v1.0.649

type PostQuantumCryptoDecryptResponseParams struct {
	// CMK的全局唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 若调用时未提供 EncryptionPublicKey,该字段值为 Base64 编码的明文,需进行 Base64 解码以获取明文。
	// 若调用时提供了 EncryptionPublicKey,则该字段值为使用 EncryptionPublicKey 公钥进行非对称加密后的 Base64 编码的密文。需在 Base64 解码后,使用用户上传的公钥对应的私钥进行进一步解密,以获取明文。
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoEncryptRequest added in v1.0.649

type PostQuantumCryptoEncryptRequest struct {
	*tchttp.BaseRequest

	// 调用CreateKey生成的CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`
}

func NewPostQuantumCryptoEncryptRequest added in v1.0.649

func NewPostQuantumCryptoEncryptRequest() (request *PostQuantumCryptoEncryptRequest)

func (*PostQuantumCryptoEncryptRequest) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoEncryptRequest) 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 (*PostQuantumCryptoEncryptRequest) ToJsonString added in v1.0.649

func (r *PostQuantumCryptoEncryptRequest) ToJsonString() string

type PostQuantumCryptoEncryptRequestParams added in v1.0.649

type PostQuantumCryptoEncryptRequestParams struct {
	// 调用CreateKey生成的CMK全局唯一标识符
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 被加密的明文数据,该字段必须使用base64编码,原文最大长度支持4K
	PlainText *string `json:"PlainText,omitnil,omitempty" name:"PlainText"`
}

Predefined struct for user

type PostQuantumCryptoEncryptResponse added in v1.0.649

type PostQuantumCryptoEncryptResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoEncryptResponseParams `json:"Response"`
}

func NewPostQuantumCryptoEncryptResponse added in v1.0.649

func NewPostQuantumCryptoEncryptResponse() (response *PostQuantumCryptoEncryptResponse)

func (*PostQuantumCryptoEncryptResponse) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoEncryptResponse) 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 (*PostQuantumCryptoEncryptResponse) ToJsonString added in v1.0.649

func (r *PostQuantumCryptoEncryptResponse) ToJsonString() string

type PostQuantumCryptoEncryptResponseParams added in v1.0.649

type PostQuantumCryptoEncryptResponseParams struct {
	// 加密后的密文,base64编码。注意:本字段中打包了密文和密钥的相关信息,不是对明文的直接加密结果,只有将该字段作为PostQuantumCryptoDecrypt接口的输入参数,才可以解密出原文。
	CiphertextBlob *string `json:"CiphertextBlob,omitnil,omitempty" name:"CiphertextBlob"`

	// 加密使用的CMK的全局唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoSignRequest added in v1.0.649

type PostQuantumCryptoSignRequest struct {
	*tchttp.BaseRequest

	// Base64 编码的消息原文。消息原文的长度(Base64编码前的长度)不超过4096字节。
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// 密钥的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

func NewPostQuantumCryptoSignRequest added in v1.0.649

func NewPostQuantumCryptoSignRequest() (request *PostQuantumCryptoSignRequest)

func (*PostQuantumCryptoSignRequest) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoSignRequest) 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 (*PostQuantumCryptoSignRequest) ToJsonString added in v1.0.649

func (r *PostQuantumCryptoSignRequest) ToJsonString() string

type PostQuantumCryptoSignRequestParams added in v1.0.649

type PostQuantumCryptoSignRequestParams struct {
	// Base64 编码的消息原文。消息原文的长度(Base64编码前的长度)不超过4096字节。
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`

	// 密钥的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`
}

Predefined struct for user

type PostQuantumCryptoSignResponse added in v1.0.649

type PostQuantumCryptoSignResponse struct {
	*tchttp.BaseResponse
	Response *PostQuantumCryptoSignResponseParams `json:"Response"`
}

func NewPostQuantumCryptoSignResponse added in v1.0.649

func NewPostQuantumCryptoSignResponse() (response *PostQuantumCryptoSignResponse)

func (*PostQuantumCryptoSignResponse) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoSignResponse) 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 (*PostQuantumCryptoSignResponse) ToJsonString added in v1.0.649

func (r *PostQuantumCryptoSignResponse) ToJsonString() string

type PostQuantumCryptoSignResponseParams added in v1.0.649

type PostQuantumCryptoSignResponseParams struct {
	// 签名值,Base64编码。可使用 PostQuantumCryptoVerify接口对签名值进行验证。
	Signature *string `json:"Signature,omitnil,omitempty" name:"Signature"`

	// 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type PostQuantumCryptoVerifyRequest added in v1.0.649

type PostQuantumCryptoVerifyRequest struct {
	*tchttp.BaseRequest

	// 密钥的唯一标识
	KeyId *string `json:"KeyId,omitnil,omitempty" name:"KeyId"`

	// 签名值,通过调用KMS PostQuantumCryptoSign签名接口生成
	SignatureValue *string `json:"SignatureValue,omitnil,omitempty" name:"SignatureValue"`

	// Base64 编码的消息原文,消息原文的长度(Base64编码前的长度)不超过4096字节。
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`
}

func NewPostQuantumCryptoVerifyRequest added in v1.0.649

func NewPostQuantumCryptoVerifyRequest() (request *PostQuantumCryptoVerifyRequest)

func (*PostQuantumCryptoVerifyRequest) FromJsonString added in v1.0.649

func (r *PostQuantumCryptoVerifyRequest) FromJsonString(s string)