v1

package
v0.0.24-beta Latest Latest
Warning

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

Go to latest
Published: Dec 7, 2020 License: Apache-2.0, BSD-2-Clause, BSD-3-Clause Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GenReqDefForBatchCreateKmsTags

func GenReqDefForBatchCreateKmsTags() *def.HttpRequestDef

func GenReqDefForCancelGrant

func GenReqDefForCancelGrant() *def.HttpRequestDef

func GenReqDefForCancelKeyDeletion

func GenReqDefForCancelKeyDeletion() *def.HttpRequestDef

func GenReqDefForCancelSelfGrant

func GenReqDefForCancelSelfGrant() *def.HttpRequestDef

func GenReqDefForCreateDatakey

func GenReqDefForCreateDatakey() *def.HttpRequestDef

func GenReqDefForCreateDatakeyWithoutPlaintext

func GenReqDefForCreateDatakeyWithoutPlaintext() *def.HttpRequestDef

func GenReqDefForCreateGrant

func GenReqDefForCreateGrant() *def.HttpRequestDef

func GenReqDefForCreateKey

func GenReqDefForCreateKey() *def.HttpRequestDef

func GenReqDefForCreateKmsTag

func GenReqDefForCreateKmsTag() *def.HttpRequestDef

func GenReqDefForCreateParametersForImport

func GenReqDefForCreateParametersForImport() *def.HttpRequestDef

func GenReqDefForCreateRandom

func GenReqDefForCreateRandom() *def.HttpRequestDef

func GenReqDefForDecryptData

func GenReqDefForDecryptData() *def.HttpRequestDef

func GenReqDefForDecryptDatakey

func GenReqDefForDecryptDatakey() *def.HttpRequestDef

func GenReqDefForDeleteImportedKeyMaterial

func GenReqDefForDeleteImportedKeyMaterial() *def.HttpRequestDef

func GenReqDefForDeleteKey

func GenReqDefForDeleteKey() *def.HttpRequestDef

func GenReqDefForDeleteTag

func GenReqDefForDeleteTag() *def.HttpRequestDef

func GenReqDefForDisableKey

func GenReqDefForDisableKey() *def.HttpRequestDef

func GenReqDefForDisableKeyRotation

func GenReqDefForDisableKeyRotation() *def.HttpRequestDef

func GenReqDefForEnableKey

func GenReqDefForEnableKey() *def.HttpRequestDef

func GenReqDefForEnableKeyRotation

func GenReqDefForEnableKeyRotation() *def.HttpRequestDef

func GenReqDefForEncryptData

func GenReqDefForEncryptData() *def.HttpRequestDef

func GenReqDefForEncryptDatakey

func GenReqDefForEncryptDatakey() *def.HttpRequestDef

func GenReqDefForImportKeyMaterial

func GenReqDefForImportKeyMaterial() *def.HttpRequestDef

func GenReqDefForListGrants

func GenReqDefForListGrants() *def.HttpRequestDef

func GenReqDefForListKeyDetail

func GenReqDefForListKeyDetail() *def.HttpRequestDef

func GenReqDefForListKeys

func GenReqDefForListKeys() *def.HttpRequestDef

func GenReqDefForListKmsByTags

func GenReqDefForListKmsByTags() *def.HttpRequestDef

func GenReqDefForListKmsTags

func GenReqDefForListKmsTags() *def.HttpRequestDef

func GenReqDefForListRetirableGrants

func GenReqDefForListRetirableGrants() *def.HttpRequestDef

func GenReqDefForShowKeyRotationStatus

func GenReqDefForShowKeyRotationStatus() *def.HttpRequestDef

func GenReqDefForShowKmsTags

func GenReqDefForShowKmsTags() *def.HttpRequestDef

func GenReqDefForShowUserInstances

func GenReqDefForShowUserInstances() *def.HttpRequestDef

func GenReqDefForShowUserQuotas

func GenReqDefForShowUserQuotas() *def.HttpRequestDef

func GenReqDefForShowVersion

func GenReqDefForShowVersion() *def.HttpRequestDef

func GenReqDefForShowVersions

func GenReqDefForShowVersions() *def.HttpRequestDef

func GenReqDefForUpdateKeyAlias

func GenReqDefForUpdateKeyAlias() *def.HttpRequestDef

func GenReqDefForUpdateKeyDescription

func GenReqDefForUpdateKeyDescription() *def.HttpRequestDef

func GenReqDefForUpdateKeyRotationInterval

func GenReqDefForUpdateKeyRotationInterval() *def.HttpRequestDef

func KmsClientBuilder

func KmsClientBuilder() *http_client.HcHttpClientBuilder

Types

type KmsClient

type KmsClient struct {
	HcClient *http_client.HcHttpClient
}

func NewKmsClient

func NewKmsClient(hcClient *http_client.HcHttpClient) *KmsClient

func (*KmsClient) BatchCreateKmsTags

func (c *KmsClient) BatchCreateKmsTags(request *model.BatchCreateKmsTagsRequest) (*model.BatchCreateKmsTagsResponse, error)

- 功能介绍:批量添加删除密钥标签。

func (*KmsClient) CancelGrant

func (c *KmsClient) CancelGrant(request *model.CancelGrantRequest) (*model.CancelGrantResponse, error)

- 功能介绍:撤销授权,授权用户撤销被授权用户操作密钥的权限。 - 说明: - 创建密钥的用户才能撤销该密钥授权。

func (*KmsClient) CancelKeyDeletion

func (c *KmsClient) CancelKeyDeletion(request *model.CancelKeyDeletionRequest) (*model.CancelKeyDeletionResponse, error)

- 功能介绍:取消计划删除密钥。 - 说明:密钥处于“计划删除”状态才能取消计划删除密钥。

func (*KmsClient) CancelSelfGrant

func (c *KmsClient) CancelSelfGrant(request *model.CancelSelfGrantRequest) (*model.CancelSelfGrantResponse, error)

- 功能介绍:退役授权,表示被授权用户不再具有授权密钥的操作权。 例如:用户A授权用户B可以操作密钥A/key,同时授权用户C可以撤销该授权, 那么用户A、B、C均可退役该授权,退役授权后,用户B不再可以使用A/key。 - 须知: 可执行退役授权的主体包括: - 创建授权的用户; - 授权中retiring_principal指向的用户; - 当授权的操作列表中包含retire-grant时,grantee_principal指向的用户。

func (*KmsClient) CreateDatakey

func (c *KmsClient) CreateDatakey(request *model.CreateDatakeyRequest) (*model.CreateDatakeyResponse, error)

- 功能介绍:创建数据密钥,返回结果包含明文和密文。

func (*KmsClient) CreateDatakeyWithoutPlaintext

- 功能介绍:创建数据密钥,返回结果只包含密文。

func (*KmsClient) CreateGrant

func (c *KmsClient) CreateGrant(request *model.CreateGrantRequest) (*model.CreateGrantResponse, error)

- 功能介绍:创建授权,被授权用户可以对授权密钥进行操作。 - 说明: - 服务默认主密钥(密钥别名后缀为“/default”)不可以授权。

func (*KmsClient) CreateKey

func (c *KmsClient) CreateKey(request *model.CreateKeyRequest) (*model.CreateKeyResponse, error)

- 功能介绍:创建用户主密钥,可用来加密数据密钥。 - 说明: 别名“/default”为服务默认主密钥的后缀名,由服务自动创建。因此用户创建的主密钥别名不能与服务默认主密钥的别名相同,即后缀名不能为“/default”。对于开通企业项目的用户,服务默认主密钥属于且只能属于默认企业项目下,且不支持企业资源的迁入迁出。服务默认主密钥为用户提供基础的云上加密功能,满足合规要求。因此,在企业多项目下,其他非默认企业项目下的用户均可使用该密钥。若客户有企业管理资源诉求,请自行创建和使用密钥。

func (*KmsClient) CreateKmsTag

func (c *KmsClient) CreateKmsTag(request *model.CreateKmsTagRequest) (*model.CreateKmsTagResponse, error)

- 功能介绍:添加密钥标签。

func (*KmsClient) CreateParametersForImport

- 功能介绍:获取导入密钥的必要参数,包括密钥导入令牌和密钥加密公钥。 - 说明:返回的公钥类型默认为RSA_2048。

func (*KmsClient) CreateRandom

func (c *KmsClient) CreateRandom(request *model.CreateRandomRequest) (*model.CreateRandomResponse, error)

- 功能介绍: 生成8~8192bit范围内的随机数。 生成512bit的随机数。

func (*KmsClient) DecryptData

func (c *KmsClient) DecryptData(request *model.DecryptDataRequest) (*model.DecryptDataResponse, error)

- 功能介绍:解密数据。

func (*KmsClient) DecryptDatakey

func (c *KmsClient) DecryptDatakey(request *model.DecryptDatakeyRequest) (*model.DecryptDatakeyResponse, error)

- 功能介绍:解密数据密钥,用指定的主密钥解密数据密钥。

func (*KmsClient) DeleteImportedKeyMaterial

- 功能介绍:删除密钥材料信息。

func (*KmsClient) DeleteKey

func (c *KmsClient) DeleteKey(request *model.DeleteKeyRequest) (*model.DeleteKeyResponse, error)

- 功能介绍:计划多少天后删除密钥,可设置7天~1096天内删除密钥。

func (*KmsClient) DeleteTag

func (c *KmsClient) DeleteTag(request *model.DeleteTagRequest) (*model.DeleteTagResponse, error)

- 功能介绍:删除密钥标签。

func (*KmsClient) DisableKey

func (c *KmsClient) DisableKey(request *model.DisableKeyRequest) (*model.DisableKeyResponse, error)

- 功能介绍:禁用密钥,密钥禁用后不可以使用。 - 说明:密钥为启用状态才能禁用密钥。

func (*KmsClient) DisableKeyRotation

func (c *KmsClient) DisableKeyRotation(request *model.DisableKeyRotationRequest) (*model.DisableKeyRotationResponse, error)

- 功能介绍:关闭用户主密钥轮换。

func (*KmsClient) EnableKey

func (c *KmsClient) EnableKey(request *model.EnableKeyRequest) (*model.EnableKeyResponse, error)

- 功能介绍:启用密钥,密钥启用后才可以使用。 - 说明:密钥为禁用状态才能启用密钥。

func (*KmsClient) EnableKeyRotation

func (c *KmsClient) EnableKeyRotation(request *model.EnableKeyRotationRequest) (*model.EnableKeyRotationResponse, error)

- 功能介绍:开启用户主密钥轮换。 - 说明: - 开启密钥轮换后,默认轮询间隔时间为365天。 - 默认主密钥及外部导入密钥不支持轮换操作。

func (*KmsClient) EncryptData

func (c *KmsClient) EncryptData(request *model.EncryptDataRequest) (*model.EncryptDataResponse, error)

- 功能介绍:加密数据,用指定的用户主密钥加密数据。

func (*KmsClient) EncryptDatakey

func (c *KmsClient) EncryptDatakey(request *model.EncryptDatakeyRequest) (*model.EncryptDatakeyResponse, error)

- 功能介绍:加密数据密钥,用指定的主密钥加密数据密钥。

func (*KmsClient) ImportKeyMaterial

func (c *KmsClient) ImportKeyMaterial(request *model.ImportKeyMaterialRequest) (*model.ImportKeyMaterialResponse, error)

- 功能介绍:导入密钥材料。

func (*KmsClient) ListGrants

func (c *KmsClient) ListGrants(request *model.ListGrantsRequest) (*model.ListGrantsResponse, error)

- 功能介绍:查询密钥的授权列表。

func (*KmsClient) ListKeyDetail

func (c *KmsClient) ListKeyDetail(request *model.ListKeyDetailRequest) (*model.ListKeyDetailResponse, error)

- 功能介绍:查询密钥详细信息。

func (*KmsClient) ListKeys

func (c *KmsClient) ListKeys(request *model.ListKeysRequest) (*model.ListKeysResponse, error)

- 功能介绍:查询用户所有密钥列表。

func (*KmsClient) ListKmsByTags

func (c *KmsClient) ListKmsByTags(request *model.ListKmsByTagsRequest) (*model.ListKmsByTagsResponse, error)

- 功能介绍:查询密钥实例。通过标签过滤,查询指定用户主密钥的详细信息。

func (*KmsClient) ListKmsTags

func (c *KmsClient) ListKmsTags(request *model.ListKmsTagsRequest) (*model.ListKmsTagsResponse, error)

- 功能介绍:查询用户在指定项目下的所有标签集合。

func (*KmsClient) ListRetirableGrants

- 功能介绍:查询用户可以退役的授权列表。

func (*KmsClient) ShowKeyRotationStatus

- 功能介绍:查询用户主密钥轮换状态。

func (*KmsClient) ShowKmsTags

func (c *KmsClient) ShowKmsTags(request *model.ShowKmsTagsRequest) (*model.ShowKmsTagsResponse, error)

- 功能介绍:查询密钥标签。

func (*KmsClient) ShowUserInstances

func (c *KmsClient) ShowUserInstances(request *model.ShowUserInstancesRequest) (*model.ShowUserInstancesResponse, error)

- 功能介绍:查询实例数,获取用户已经创建的用户主密钥数量。

func (*KmsClient) ShowUserQuotas

func (c *KmsClient) ShowUserQuotas(request *model.ShowUserQuotasRequest) (*model.ShowUserQuotasResponse, error)

- 功能介绍:查询配额,查询用户可以创建的用户主密钥配额总数及当前使用量信息。

func (*KmsClient) ShowVersion

func (c *KmsClient) ShowVersion(request *model.ShowVersionRequest) (*model.ShowVersionResponse, error)

- 功能介绍:查指定API版本信息。

func (*KmsClient) ShowVersions

func (c *KmsClient) ShowVersions(request *model.ShowVersionsRequest) (*model.ShowVersionsResponse, error)

- 功能介绍:查询API版本信息列表。

func (*KmsClient) UpdateKeyAlias

func (c *KmsClient) UpdateKeyAlias(request *model.UpdateKeyAliasRequest) (*model.UpdateKeyAliasResponse, error)

- 功能介绍:修改用户主密钥别名。 - 说明: - 服务默认主密钥(密钥别名后缀为“/default”)不可以修改。 - 密钥处于“计划删除”状态,密钥别名不可以修改。

func (*KmsClient) UpdateKeyDescription

- 功能介绍:修改用户主密钥描述信息。 - 说明: - 服务默认主密钥(密钥别名后缀为“/default”)不可以修改。 - 密钥处于“计划删除”状态,密钥描述不可以修改。

func (*KmsClient) UpdateKeyRotationInterval

- 功能介绍:修改用户主密钥轮换周期。

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL