v20190923

package
v3.0.1071+incompatible Latest Latest
Warning

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

Go to latest
Published: Oct 29, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source
const (

	// Error with CAM signature/authentication.
	AUTHFAILURE = "AuthFailure"

	// `DryRun` Operation. It means that the request would have succeeded, but the `DryRun` parameter was used.
	DRYRUNOPERATION = "DryRunOperation"

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// KMS operation failed.
	FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"

	// The rotation is prohibited.
	FAILEDOPERATION_ROTATIONFORBIDDEN = "FailedOperation.RotationForbidden"

	// An internal error occurred.
	INTERNALERROR = "InternalError"

	// Incorrect parameter.
	INVALIDPARAMETER = "InvalidParameter"

	// The parameter value is invalid.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The tag keys are duplicated.
	INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"

	// The tag key or tag value does not exist.
	INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"

	// The quota limit is exceeded.
	LIMITEXCEEDED = "LimitExceeded"

	// Missing parameter.
	MISSINGPARAMETER = "MissingParameter"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// Reached the upper limit of access keys.
	OPERATIONDENIED_ACCESSKEYOVERLIMIT = "OperationDenied.AccessKeyOverLimit"

	// It is not allowed to manually update credentials with automatic rotation enabled.
	OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"

	// The role does not exist.
	OPERATIONDENIED_ROLENOTEXIST = "OperationDenied.RoleNotExist"

	// The secret is not owned by the current account.
	OPERATIONDENIED_UINNOTMATCH = "OperationDenied.UinNotMatch"

	// The number of requests exceeds the frequency limit.
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// The resource is in use.
	RESOURCEINUSE = "ResourceInUse"

	// The Secret name already exists.
	RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"

	// The Version ID already exists.
	RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"

	// Insufficient resource.
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

	// The resource does not exist.
	RESOURCENOTFOUND = "ResourceNotFound"

	// The secret does not exist.
	RESOURCENOTFOUND_SECRETNOTEXIST = "ResourceNotFound.SecretNotExist"

	// The resource is unavailable.
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// The service is not purchased.
	RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"

	// The Secret is disabled.
	RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"

	// The Secret is in `PendingDelete` status.
	RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"

	// The credential has not been initialized.
	RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"

	// The resources have been sold out.
	RESOURCESSOLDOUT = "ResourcesSoldOut"

	// The operation is unauthorized.
	UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

	// Failed to access KMS.
	UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"

	// Unknown parameter.
	UNKNOWNPARAMETER = "UnknownParameter"

	// Unsupported operation.
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source
const APIVersion = "2019-09-23"

Variables

This section is empty.

Functions

This section is empty.

Types

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) CreateProductSecret

func (c *Client) CreateProductSecret(request *CreateProductSecretRequest) (response *CreateProductSecretResponse, err error)

CreateProductSecret This API is used to create a Tencent Cloud service credential.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateProductSecretWithContext

func (c *Client) CreateProductSecretWithContext(ctx context.Context, request *CreateProductSecretRequest) (response *CreateProductSecretResponse, err error)

CreateProductSecret This API is used to create a Tencent Cloud service credential.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateSSHKeyPairSecret

func (c *Client) CreateSSHKeyPairSecret(request *CreateSSHKeyPairSecretRequest) (response *CreateSSHKeyPairSecretResponse, err error)

CreateSSHKeyPairSecret This API is used to create a secret that hosts SSH keys.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateSSHKeyPairSecretWithContext

func (c *Client) CreateSSHKeyPairSecretWithContext(ctx context.Context, request *CreateSSHKeyPairSecretRequest) (response *CreateSSHKeyPairSecretResponse, err error)

CreateSSHKeyPairSecret This API is used to create a secret that hosts SSH keys.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CreateSecret

func (c *Client) CreateSecret(request *CreateSecretRequest) (response *CreateSecretResponse, err error)

CreateSecret This API is used to create a KMS-encrypted Secret. You can create and store up to 1,000 Secrets in each region.

error code that may be returned:

FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) CreateSecretWithContext

func (c *Client) CreateSecretWithContext(ctx context.Context, request *CreateSecretRequest) (response *CreateSecretResponse, err error)

CreateSecret This API is used to create a KMS-encrypted Secret. You can create and store up to 1,000 Secrets in each region.

error code that may be returned:

FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteSecret

func (c *Client) DeleteSecret(request *DeleteSecretRequest) (response *DeleteSecretResponse, err error)

DeleteSecret This API is used to delete a Secret. You can set whether to delete the Secret immediately or on schedule using the `RecoveryWindowInDays` parameter. For a Secret to be deleted on schedule, its status will be `PendingDelete` before the scheduled deletion time. You can use `RestoreSecret` to restore a deleted Secret during this time. A deleted Secret will not be restorable after the scheduled deletion time. A Secret can only be deleted after being disabled using `DisableSecret`.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteSecretVersion

func (c *Client) DeleteSecretVersion(request *DeleteSecretVersionRequest) (response *DeleteSecretVersionResponse, err error)

DeleteSecretVersion This API is used to directly delete a single credential version under the specified credential. The deletion takes effect immediately, and the credential version in all status can be deleted.

This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteSecretVersionWithContext

func (c *Client) DeleteSecretVersionWithContext(ctx context.Context, request *DeleteSecretVersionRequest) (response *DeleteSecretVersionResponse, err error)

DeleteSecretVersion This API is used to directly delete a single credential version under the specified credential. The deletion takes effect immediately, and the credential version in all status can be deleted.

This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DeleteSecretWithContext

func (c *Client) DeleteSecretWithContext(ctx context.Context, request *DeleteSecretRequest) (response *DeleteSecretResponse, err error)

DeleteSecret This API is used to delete a Secret. You can set whether to delete the Secret immediately or on schedule using the `RecoveryWindowInDays` parameter. For a Secret to be deleted on schedule, its status will be `PendingDelete` before the scheduled deletion time. You can use `RestoreSecret` to restore a deleted Secret during this time. A deleted Secret will not be restorable after the scheduled deletion time. A Secret can only be deleted after being disabled using `DisableSecret`.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeAsyncRequestInfo

func (c *Client) DescribeAsyncRequestInfo(request *DescribeAsyncRequestInfoRequest) (response *DescribeAsyncRequestInfoResponse, err error)

DescribeAsyncRequestInfo This API is used to query the execution result of an async task.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAsyncRequestInfoWithContext

func (c *Client) DescribeAsyncRequestInfoWithContext(ctx context.Context, request *DescribeAsyncRequestInfoRequest) (response *DescribeAsyncRequestInfoResponse, err error)

DescribeAsyncRequestInfo This API is used to query the execution result of an async task.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRotationDetail

func (c *Client) DescribeRotationDetail(request *DescribeRotationDetailRequest) (response *DescribeRotationDetailResponse, err error)

DescribeRotationDetail This API is used to query the details of a credential rotation policy.

This API is only applicable to Tencent Cloud service credentials.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRotationDetailWithContext

func (c *Client) DescribeRotationDetailWithContext(ctx context.Context, request *DescribeRotationDetailRequest) (response *DescribeRotationDetailResponse, err error)

DescribeRotationDetail This API is used to query the details of a credential rotation policy.

This API is only applicable to Tencent Cloud service credentials.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRotationHistory

func (c *Client) DescribeRotationHistory(request *DescribeRotationHistoryRequest) (response *DescribeRotationHistoryResponse, err error)

DescribeRotationHistory This API is used to query the historical versions of a rotated credential.

This API is only applicable to Tencent Cloud service credentials.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRotationHistoryWithContext

func (c *Client) DescribeRotationHistoryWithContext(ctx context.Context, request *DescribeRotationHistoryRequest) (response *DescribeRotationHistoryResponse, err error)

DescribeRotationHistory This API is used to query the historical versions of a rotated credential.

This API is only applicable to Tencent Cloud service credentials.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSecret

func (c *Client) DescribeSecret(request *DescribeSecretRequest) (response *DescribeSecretResponse, err error)

DescribeSecret This API is used to obtain the detailed attribute information of a Secret.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED_ROLENOTEXIST = "OperationDenied.RoleNotExist"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeSecretWithContext

func (c *Client) DescribeSecretWithContext(ctx context.Context, request *DescribeSecretRequest) (response *DescribeSecretResponse, err error)

DescribeSecret This API is used to obtain the detailed attribute information of a Secret.

error code that may be returned:

INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED_ROLENOTEXIST = "OperationDenied.RoleNotExist"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DescribeSupportedProducts

func (c *Client) DescribeSupportedProducts(request *DescribeSupportedProductsRequest) (response *DescribeSupportedProductsResponse, err error)

DescribeSupportedProducts This API is used to query the list of supported Tencent Cloud services.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSupportedProductsWithContext

func (c *Client) DescribeSupportedProductsWithContext(ctx context.Context, request *DescribeSupportedProductsRequest) (response *DescribeSupportedProductsResponse, err error)

DescribeSupportedProducts This API is used to query the list of supported Tencent Cloud services.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DisableSecret

func (c *Client) DisableSecret(request *DisableSecretRequest) (response *DisableSecretResponse, err error)

DisableSecret This API is used to disable a Secret and will change its status to `Disabled`. The plaintext of a disabled Secret cannot be obtained through APIs.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) DisableSecretWithContext

func (c *Client) DisableSecretWithContext(ctx context.Context, request *DisableSecretRequest) (response *DisableSecretResponse, err error)

DisableSecret This API is used to disable a Secret and will change its status to `Disabled`. The plaintext of a disabled Secret cannot be obtained through APIs.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableSecret

func (c *Client) EnableSecret(request *EnableSecretRequest) (response *EnableSecretResponse, err error)

EnableSecret This API is used to enable a Secret and will change its status to `Enabled`. You can call the `GetSecretValue` API to obtain the plaintext of this Secret. Secrets in `PendingDelete` status can only be enabled after being restored by using `RestoreSecret`.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) EnableSecretWithContext

func (c *Client) EnableSecretWithContext(ctx context.Context, request *EnableSecretRequest) (response *EnableSecretResponse, err error)

EnableSecret This API is used to enable a Secret and will change its status to `Enabled`. You can call the `GetSecretValue` API to obtain the plaintext of this Secret. Secrets in `PendingDelete` status can only be enabled after being restored by using `RestoreSecret`.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetRegions

func (c *Client) GetRegions(request *GetRegionsRequest) (response *GetRegionsResponse, err error)

GetRegions This API is used to obtain the list of regions displayed on Console.

error code that may be returned:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetRegionsWithContext

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

GetRegions This API is used to obtain the list of regions displayed on Console.

error code that may be returned:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetSSHKeyPairValue

func (c *Client) GetSSHKeyPairValue(request *GetSSHKeyPairValueRequest) (response *GetSSHKeyPairValueResponse, err error)

GetSSHKeyPairValue This API is used to obtain the plaintext value of the SSH key secret.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetSSHKeyPairValueWithContext

func (c *Client) GetSSHKeyPairValueWithContext(ctx context.Context, request *GetSSHKeyPairValueRequest) (response *GetSSHKeyPairValueResponse, err error)

GetSSHKeyPairValue This API is used to obtain the plaintext value of the SSH key secret.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) GetSecretValue

func (c *Client) GetSecretValue(request *GetSecretValueRequest) (response *GetSecretValueResponse, err error)

GetSecretValue For user-defined credentials, this API is used to get the plaintext information of a credential by specifying the credential name and version.

For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as `SSM_Current`.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED_ROLENOTEXIST = "OperationDenied.RoleNotExist"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_SECRETNOTEXIST = "ResourceNotFound.SecretNotExist"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetSecretValueWithContext

func (c *Client) GetSecretValueWithContext(ctx context.Context, request *GetSecretValueRequest) (response *GetSecretValueResponse, err error)

GetSecretValue For user-defined credentials, this API is used to get the plaintext information of a credential by specifying the credential name and version.

For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as `SSM_Current`.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED_ROLENOTEXIST = "OperationDenied.RoleNotExist"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_SECRETNOTEXIST = "ResourceNotFound.SecretNotExist"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetServiceStatus

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

GetServiceStatus This API is used to obtain the SecretsManager service status of a user.

error code that may be returned:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetServiceStatusWithContext

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

GetServiceStatus This API is used to obtain the SecretsManager service status of a user.

error code that may be returned:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListSecretVersionIds

func (c *Client) ListSecretVersionIds(request *ListSecretVersionIdsRequest) (response *ListSecretVersionIdsResponse, err error)

ListSecretVersionIds This API is used to obtain list of versions of a Secret.

error code that may be returned:

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

func (*Client) ListSecretVersionIdsWithContext

func (c *Client) ListSecretVersionIdsWithContext(ctx context.Context, request *ListSecretVersionIdsRequest) (response *ListSecretVersionIdsResponse, err error)

ListSecretVersionIds This API is used to obtain list of versions of a Secret.

error code that may be returned:

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

func (*Client) ListSecrets

func (c *Client) ListSecrets(request *ListSecretsRequest) (response *ListSecretsResponse, err error)

ListSecrets This API is used to obtain the detailed information list of all Secrets. You can specify the filter fields and sorting order as needed.

error code that may be returned:

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

func (*Client) ListSecretsWithContext

func (c *Client) ListSecretsWithContext(ctx context.Context, request *ListSecretsRequest) (response *ListSecretsResponse, err error)

ListSecrets This API is used to obtain the detailed information list of all Secrets. You can specify the filter fields and sorting order as needed.

error code that may be returned:

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

func (*Client) PutSecretValue

func (c *Client) PutSecretValue(request *PutSecretValueRequest) (response *PutSecretValueResponse, err error)

PutSecretValue This API adds the new version of the credential content under the specified credential. One credential can have up to 10 versions. New versions can be added to credentials only in `Enabled` or `Disabled` status.

This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) PutSecretValueWithContext

func (c *Client) PutSecretValueWithContext(ctx context.Context, request *PutSecretValueRequest) (response *PutSecretValueResponse, err error)

PutSecretValue This API adds the new version of the credential content under the specified credential. One credential can have up to 10 versions. New versions can be added to credentials only in `Enabled` or `Disabled` status.

This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
LIMITEXCEEDED = "LimitExceeded"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) RestoreSecret

func (c *Client) RestoreSecret(request *RestoreSecretRequest) (response *RestoreSecretResponse, err error)

RestoreSecret This API is used to restore a `PendingDelete` Secret, canceling its scheduled deletion. The restored Secret will be in `Disabled` status. You can call the `EnableSecret` API to enable this Secret again.

error code that may be returned:

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

func (*Client) RestoreSecretWithContext

func (c *Client) RestoreSecretWithContext(ctx context.Context, request *RestoreSecretRequest) (response *RestoreSecretResponse, err error)

RestoreSecret This API is used to restore a `PendingDelete` Secret, canceling its scheduled deletion. The restored Secret will be in `Disabled` status. You can call the `EnableSecret` API to enable this Secret again.

error code that may be returned:

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

func (*Client) RotateProductSecret

func (c *Client) RotateProductSecret(request *RotateProductSecretRequest) (response *RotateProductSecretResponse, err error)

RotateProductSecret This API is used to rotate secrets for Tencent Cloud services or Tencent Cloud API key pairs.

Note that only the secrets with the "Enabled" status can be rotated.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
FAILEDOPERATION_ROTATIONFORBIDDEN = "FailedOperation.RotationForbidden"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_ACCESSKEYOVERLIMIT = "OperationDenied.AccessKeyOverLimit"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
OPERATIONDENIED_UINNOTMATCH = "OperationDenied.UinNotMatch"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) RotateProductSecretWithContext

func (c *Client) RotateProductSecretWithContext(ctx context.Context, request *RotateProductSecretRequest) (response *RotateProductSecretResponse, err error)

RotateProductSecret This API is used to rotate secrets for Tencent Cloud services or Tencent Cloud API key pairs.

Note that only the secrets with the "Enabled" status can be rotated.

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
FAILEDOPERATION_ROTATIONFORBIDDEN = "FailedOperation.RotationForbidden"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_ACCESSKEYOVERLIMIT = "OperationDenied.AccessKeyOverLimit"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
OPERATIONDENIED_UINNOTMATCH = "OperationDenied.UinNotMatch"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateDescription

func (c *Client) UpdateDescription(request *UpdateDescriptionRequest) (response *UpdateDescriptionResponse, err error)

UpdateDescription This API is used to update the description of a Secret. This API can only update Secrets in `Enabled` or `Disabled` status.

error code that may be returned:

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

func (*Client) UpdateDescriptionWithContext

func (c *Client) UpdateDescriptionWithContext(ctx context.Context, request *UpdateDescriptionRequest) (response *UpdateDescriptionResponse, err error)

UpdateDescription This API is used to update the description of a Secret. This API can only update Secrets in `Enabled` or `Disabled` status.

error code that may be returned:

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

func (*Client) UpdateRotationStatus

func (c *Client) UpdateRotationStatus(request *UpdateRotationStatusRequest) (response *UpdateRotationStatusResponse, err error)

UpdateRotationStatus This API is used to set a Tencent Cloud service credential rotation policy, including the following parameters:

Specifies whether to enable rotation

Rotation frequency

Rotation start time

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
FAILEDOPERATION_ROTATIONFORBIDDEN = "FailedOperation.RotationForbidden"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateRotationStatusWithContext

func (c *Client) UpdateRotationStatusWithContext(ctx context.Context, request *UpdateRotationStatusRequest) (response *UpdateRotationStatusResponse, err error)

UpdateRotationStatus This API is used to set a Tencent Cloud service credential rotation policy, including the following parameters:

Specifies whether to enable rotation

Rotation frequency

Rotation start time

error code that may be returned:

AUTHFAILURE = "AuthFailure"
DRYRUNOPERATION = "DryRunOperation"
FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
FAILEDOPERATION_ROTATIONFORBIDDEN = "FailedOperation.RotationForbidden"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
INVALIDPARAMETERVALUE_TAGKEYSDUPLICATED = "InvalidParameterValue.TagKeysDuplicated"
INVALIDPARAMETERVALUE_TAGSNOTEXISTED = "InvalidParameterValue.TagsNotExisted"
LIMITEXCEEDED = "LimitExceeded"
MISSINGPARAMETER = "MissingParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
REQUESTLIMITEXCEEDED = "RequestLimitExceeded"
RESOURCEINUSE = "ResourceInUse"
RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"
RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"
RESOURCEINSUFFICIENT = "ResourceInsufficient"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE = "ResourceUnavailable"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"
RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"
RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"
RESOURCESSOLDOUT = "ResourcesSoldOut"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"
UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"
UNKNOWNPARAMETER = "UnknownParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) UpdateSecret

func (c *Client) UpdateSecret(request *UpdateSecretRequest) (response *UpdateSecretResponse, err error)

UpdateSecret This API is used to update the credential content of the specified credential name and version number. Calling this API will encrypt the content of the new credential and overwrite the old content. Only credentials in `Enabled` or `Disabled` status can be updated.

This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) UpdateSecretWithContext

func (c *Client) UpdateSecretWithContext(ctx context.Context, request *UpdateSecretRequest) (response *UpdateSecretResponse, err error)

UpdateSecret This API is used to update the credential content of the specified credential name and version number. Calling this API will encrypt the content of the new credential and overwrite the old content. Only credentials in `Enabled` or `Disabled` status can be updated.

This API is only applicable to user-defined credentials but not Tencent Cloud service credentials.

error code that may be returned:

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_ACCESSKMSERROR = "FailedOperation.AccessKmsError"
INTERNALERROR = "InternalError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

type CreateProductSecretRequest

type CreateProductSecretRequest struct {
	*tchttp.BaseRequest

	// Credential name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens, and underscores and must begin with a letter or digit.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Prefix of the user account name, which is specified by you and can contain up to 8 characters.
	// Supported character sets include:
	// Digits: [0, 9].
	// Lowercase letters: [a, z].
	// Uppercase letters: [A, Z].
	// Special symbols: underscore.
	// The prefix must begin with a letter.
	UserNamePrefix *string `json:"UserNamePrefix,omitnil,omitempty" name:"UserNamePrefix"`

	// Name of the Tencent Cloud service bound to the credential, such as `Mysql`. The `DescribeSupportedProducts` API can be used to get the names of the supported Tencent Cloud services.
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// Tencent Cloud service instance ID.
	InstanceID *string `json:"InstanceID,omitnil,omitempty" name:"InstanceID"`

	// Domain name of the account in the form of IP. You can enter `%`.
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// List of permissions that need to be granted when the credential is bound to a Tencent Cloud service.
	PrivilegesList []*ProductPrivilegeUnit `json:"PrivilegesList,omitnil,omitempty" name:"PrivilegesList"`

	// Description, which is used to describe the purpose in detail and can contain up to 2,048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Specifies the KMS CMK that encrypts the credential.
	// If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.
	// You can also specify a custom KMS CMK created in the same region for encryption.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// List of tags.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// User-Defined rotation start time in the format of 2006-01-02 15:04:05.
	// When `EnableRotation` is `True`, this parameter is required.
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`

	// Specifies whether to enable rotation
	// True - enable
	// False - do not enable
	// If this parameter is not specified, `False` will be used by default.
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// Rotation frequency in days. Default value: 1 day.
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`
}

func NewCreateProductSecretRequest

func NewCreateProductSecretRequest() (request *CreateProductSecretRequest)

func (*CreateProductSecretRequest) FromJsonString

func (r *CreateProductSecretRequest) 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 (*CreateProductSecretRequest) ToJsonString

func (r *CreateProductSecretRequest) ToJsonString() string

type CreateProductSecretRequestParams

type CreateProductSecretRequestParams struct {
	// Credential name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens, and underscores and must begin with a letter or digit.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Prefix of the user account name, which is specified by you and can contain up to 8 characters.
	// Supported character sets include:
	// Digits: [0, 9].
	// Lowercase letters: [a, z].
	// Uppercase letters: [A, Z].
	// Special symbols: underscore.
	// The prefix must begin with a letter.
	UserNamePrefix *string `json:"UserNamePrefix,omitnil,omitempty" name:"UserNamePrefix"`

	// Name of the Tencent Cloud service bound to the credential, such as `Mysql`. The `DescribeSupportedProducts` API can be used to get the names of the supported Tencent Cloud services.
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// Tencent Cloud service instance ID.
	InstanceID *string `json:"InstanceID,omitnil,omitempty" name:"InstanceID"`

	// Domain name of the account in the form of IP. You can enter `%`.
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// List of permissions that need to be granted when the credential is bound to a Tencent Cloud service.
	PrivilegesList []*ProductPrivilegeUnit `json:"PrivilegesList,omitnil,omitempty" name:"PrivilegesList"`

	// Description, which is used to describe the purpose in detail and can contain up to 2,048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Specifies the KMS CMK that encrypts the credential.
	// If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.
	// You can also specify a custom KMS CMK created in the same region for encryption.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// List of tags.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// User-Defined rotation start time in the format of 2006-01-02 15:04:05.
	// When `EnableRotation` is `True`, this parameter is required.
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`

	// Specifies whether to enable rotation
	// True - enable
	// False - do not enable
	// If this parameter is not specified, `False` will be used by default.
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// Rotation frequency in days. Default value: 1 day.
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`
}

Predefined struct for user

type CreateProductSecretResponse

type CreateProductSecretResponse struct {
	*tchttp.BaseResponse
	Response *CreateProductSecretResponseParams `json:"Response"`
}

func NewCreateProductSecretResponse

func NewCreateProductSecretResponse() (response *CreateProductSecretResponse)

func (*CreateProductSecretResponse) FromJsonString

func (r *CreateProductSecretResponse) 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 (*CreateProductSecretResponse) ToJsonString

func (r *CreateProductSecretResponse) ToJsonString() string

type CreateProductSecretResponseParams

type CreateProductSecretResponseParams struct {
	// Name of the created credential.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Tag operation return code. 0: success; 1: internal error; 2: business processing error.
	// Note: this field may return null, indicating that no valid values can be obtained.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// Tag operation return message.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// ID of the created Tencent Cloud service credential async task.
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSSHKeyPairSecretRequest

type CreateSSHKeyPairSecretRequest struct {
	*tchttp.BaseRequest

	// Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the project to which the created SSH key belongs.
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Description, such as what it is used for. It contains up to 2,048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Specifies a KMS CMK to encrypt the secret.
	// If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.
	// You can also specify a custom KMS CMK created in the same region for encryption.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// List of tags.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`
}

func NewCreateSSHKeyPairSecretRequest

func NewCreateSSHKeyPairSecretRequest() (request *CreateSSHKeyPairSecretRequest)

func (*CreateSSHKeyPairSecretRequest) FromJsonString

func (r *CreateSSHKeyPairSecretRequest) 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 (*CreateSSHKeyPairSecretRequest) ToJsonString

func (r *CreateSSHKeyPairSecretRequest) ToJsonString() string

type CreateSSHKeyPairSecretRequestParams

type CreateSSHKeyPairSecretRequestParams struct {
	// Secret name, which must be unique in the same region. It can contain 128 bytes of letters, digits, hyphens and underscores and must begin with a letter or digit.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the project to which the created SSH key belongs.
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// Description, such as what it is used for. It contains up to 2,048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// Specifies a KMS CMK to encrypt the secret.
	// If this parameter is left empty, the CMK created by Secrets Manager by default will be used for encryption.
	// You can also specify a custom KMS CMK created in the same region for encryption.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// List of tags.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Name of the SSH key pair, which only contains digits, letters and underscores and must start with a digit or letter. The maximum length is 25 characters.
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`
}

Predefined struct for user

type CreateSSHKeyPairSecretResponse

type CreateSSHKeyPairSecretResponse struct {
	*tchttp.BaseResponse
	Response *CreateSSHKeyPairSecretResponseParams `json:"Response"`
}

func NewCreateSSHKeyPairSecretResponse

func NewCreateSSHKeyPairSecretResponse() (response *CreateSSHKeyPairSecretResponse)

func (*CreateSSHKeyPairSecretResponse) FromJsonString

func (r *CreateSSHKeyPairSecretResponse) 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 (*CreateSSHKeyPairSecretResponse) ToJsonString

func (r *CreateSSHKeyPairSecretResponse) ToJsonString() string

type CreateSSHKeyPairSecretResponseParams

type CreateSSHKeyPairSecretResponseParams struct {
	// Name of the created secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the created SSH key.
	SSHKeyID *string `json:"SSHKeyID,omitnil,omitempty" name:"SSHKeyID"`

	// Name of the created SSH key.
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`

	// Tag return code. `0`: success; `1`: internal error; `2`: business processing error.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// Tag return message.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type CreateSecretRequest

type CreateSecretRequest struct {
	*tchttp.BaseRequest

	// Secret name, which must be unique in the same region. It can contain 128 bytes ([a-z], [A-Z], [0-9], [-_]). It must begin with a letter or digit. Note that it cannot be modified once created.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Secret version. It can contain up to 64 bytes ([a-z], [A-Z], [0-9], [-_.]). It must begin with a letter or digit. `SecretName` and `VersionId` are used to query the Secret information. If it is left empty, the initial Secret version number is used by default.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// Description information, such as the detailed use cases. It can be up to 2048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// KMS CMK used for Secret encryption. If this parameter is left empty, SecretsManager will create a CMK by default. You can also specify a KMS CMK that is created in the same region.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// Secret type. It defaults to `custom`.
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// Base64-encoded plaintext of a binary Secret. Either `SecretBinary` or `SecretString` must be set. A maximum of 4096 bytes is supported.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// Plaintext of a Secret, in text format. Base64 encoding is not required. Either `SecretBinary` or `SecretString` must be set. A maximum of 4096 bytes is supported.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`

	// Additional configuration of the Secret in JSON format
	AdditionalConfig *string `json:"AdditionalConfig,omitnil,omitempty" name:"AdditionalConfig"`

	// List of tags.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewCreateSecretRequest

func NewCreateSecretRequest() (request *CreateSecretRequest)

func (*CreateSecretRequest) FromJsonString

func (r *CreateSecretRequest) 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 (*CreateSecretRequest) ToJsonString

func (r *CreateSecretRequest) ToJsonString() string

type CreateSecretRequestParams

type CreateSecretRequestParams struct {
	// Secret name, which must be unique in the same region. It can contain 128 bytes ([a-z], [A-Z], [0-9], [-_]). It must begin with a letter or digit. Note that it cannot be modified once created.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Secret version. It can contain up to 64 bytes ([a-z], [A-Z], [0-9], [-_.]). It must begin with a letter or digit. `SecretName` and `VersionId` are used to query the Secret information. If it is left empty, the initial Secret version number is used by default.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// Description information, such as the detailed use cases. It can be up to 2048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// KMS CMK used for Secret encryption. If this parameter is left empty, SecretsManager will create a CMK by default. You can also specify a KMS CMK that is created in the same region.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// Secret type. It defaults to `custom`.
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// Base64-encoded plaintext of a binary Secret. Either `SecretBinary` or `SecretString` must be set. A maximum of 4096 bytes is supported.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// Plaintext of a Secret, in text format. Base64 encoding is not required. Either `SecretBinary` or `SecretString` must be set. A maximum of 4096 bytes is supported.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`

	// Additional configuration of the Secret in JSON format
	AdditionalConfig *string `json:"AdditionalConfig,omitnil,omitempty" name:"AdditionalConfig"`

	// List of tags.
	Tags []*Tag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type CreateSecretResponse

type CreateSecretResponse struct {
	*tchttp.BaseResponse
	Response *CreateSecretResponseParams `json:"Response"`
}

func NewCreateSecretResponse

func NewCreateSecretResponse() (response *CreateSecretResponse)

func (*CreateSecretResponse) FromJsonString

func (r *CreateSecretResponse) 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 (*CreateSecretResponse) ToJsonString

func (r *CreateSecretResponse) ToJsonString() string

type CreateSecretResponseParams

type CreateSecretResponseParams struct {
	// Name of the new Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the new Secret version.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// Return code of tag operation. `0`: success; `1`: internal error; `2`: business processing error
	// Note: This field may return `null`, indicating that no valid value was found.
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// Return message of tag operation.
	// Note: This field may return `null`, indicating that no valid value was found.
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteSecretRequest

type DeleteSecretRequest struct {
	*tchttp.BaseRequest

	// Name of the Secret to be deleted.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Scheduled deletion time (in days), indicating the number of retention days for the secret. Value range: 0-30. If it is `0`, the secret is deleted immediately.
	// For an SSH key secret, this field can only be `0`.
	RecoveryWindowInDays *uint64 `json:"RecoveryWindowInDays,omitnil,omitempty" name:"RecoveryWindowInDays"`

	// Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only valid for SSH key secrets. Valid values:
	// `True`: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.
	// `False`: only deletes the SSH key information in the secret.
	CleanSSHKey *bool `json:"CleanSSHKey,omitnil,omitempty" name:"CleanSSHKey"`
}

func NewDeleteSecretRequest

func NewDeleteSecretRequest() (request *DeleteSecretRequest)

func (*DeleteSecretRequest) FromJsonString

func (r *DeleteSecretRequest) 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 (*DeleteSecretRequest) ToJsonString

func (r *DeleteSecretRequest) ToJsonString() string

type DeleteSecretRequestParams

type DeleteSecretRequestParams struct {
	// Name of the Secret to be deleted.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Scheduled deletion time (in days), indicating the number of retention days for the secret. Value range: 0-30. If it is `0`, the secret is deleted immediately.
	// For an SSH key secret, this field can only be `0`.
	RecoveryWindowInDays *uint64 `json:"RecoveryWindowInDays,omitnil,omitempty" name:"RecoveryWindowInDays"`

	// Specifies whether to delete the SSH key from both the secret and the SSH key list in the CVM console. This field is only valid for SSH key secrets. Valid values:
	// `True`: deletes SSH key from both the secret and SSH key list in the CVM console. Note that the deletion will fail if the SSH key is already bound to a CVM instance.
	// `False`: only deletes the SSH key information in the secret.
	CleanSSHKey *bool `json:"CleanSSHKey,omitnil,omitempty" name:"CleanSSHKey"`
}

Predefined struct for user

type DeleteSecretResponse

type DeleteSecretResponse struct {
	*tchttp.BaseResponse
	Response *DeleteSecretResponseParams `json:"Response"`
}

func NewDeleteSecretResponse

func NewDeleteSecretResponse() (response *DeleteSecretResponse)

func (*DeleteSecretResponse) FromJsonString

func (r *DeleteSecretResponse) 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 (*DeleteSecretResponse) ToJsonString

func (r *DeleteSecretResponse) ToJsonString() string

type DeleteSecretResponseParams

type DeleteSecretResponseParams struct {
	// Name of deleted Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Secret deletion time, formatted as a Unix timestamp.
	DeleteTime *int64 `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DeleteSecretVersionRequest

type DeleteSecretVersionRequest struct {
	*tchttp.BaseRequest

	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the Secret version to be deleted.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`
}

func NewDeleteSecretVersionRequest

func NewDeleteSecretVersionRequest() (request *DeleteSecretVersionRequest)

func (*DeleteSecretVersionRequest) FromJsonString

func (r *DeleteSecretVersionRequest) 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 (*DeleteSecretVersionRequest) ToJsonString

func (r *DeleteSecretVersionRequest) ToJsonString() string

type DeleteSecretVersionRequestParams

type DeleteSecretVersionRequestParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the Secret version to be deleted.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`
}

Predefined struct for user

type DeleteSecretVersionResponse

type DeleteSecretVersionResponse struct {
	*tchttp.BaseResponse
	Response *DeleteSecretVersionResponseParams `json:"Response"`
}

func NewDeleteSecretVersionResponse

func NewDeleteSecretVersionResponse() (response *DeleteSecretVersionResponse)

func (*DeleteSecretVersionResponse) FromJsonString

func (r *DeleteSecretVersionResponse) 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 (*DeleteSecretVersionResponse) ToJsonString

func (r *DeleteSecretVersionResponse) ToJsonString() string

type DeleteSecretVersionResponseParams

type DeleteSecretVersionResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Version ID of the Secret.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeAsyncRequestInfoRequest

type DescribeAsyncRequestInfoRequest struct {
	*tchttp.BaseRequest

	// Async task ID.
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`
}

func NewDescribeAsyncRequestInfoRequest

func NewDescribeAsyncRequestInfoRequest() (request *DescribeAsyncRequestInfoRequest)

func (*DescribeAsyncRequestInfoRequest) FromJsonString

func (r *DescribeAsyncRequestInfoRequest) 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 (*DescribeAsyncRequestInfoRequest) ToJsonString

func (r *DescribeAsyncRequestInfoRequest) ToJsonString() string

type DescribeAsyncRequestInfoRequestParams

type DescribeAsyncRequestInfoRequestParams struct {
	// Async task ID.
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`
}

Predefined struct for user

type DescribeAsyncRequestInfoResponse

type DescribeAsyncRequestInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAsyncRequestInfoResponseParams `json:"Response"`
}

func NewDescribeAsyncRequestInfoResponse

func NewDescribeAsyncRequestInfoResponse() (response *DescribeAsyncRequestInfoResponse)

func (*DescribeAsyncRequestInfoResponse) FromJsonString

func (r *DescribeAsyncRequestInfoResponse) 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 (*DescribeAsyncRequestInfoResponse) ToJsonString

func (r *DescribeAsyncRequestInfoResponse) ToJsonString() string

type DescribeAsyncRequestInfoResponseParams

type DescribeAsyncRequestInfoResponseParams struct {
	// 0: processing, 1: processing succeeded, 2: processing failed
	TaskStatus *int64 `json:"TaskStatus,omitnil,omitempty" name:"TaskStatus"`

	// Task description.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRotationDetailRequest

type DescribeRotationDetailRequest struct {
	*tchttp.BaseRequest

	// Specifies the name of the credential for which to get the credential rotation details.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewDescribeRotationDetailRequest

func NewDescribeRotationDetailRequest() (request *DescribeRotationDetailRequest)

func (*DescribeRotationDetailRequest) FromJsonString

func (r *DescribeRotationDetailRequest) 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 (*DescribeRotationDetailRequest) ToJsonString

func (r *DescribeRotationDetailRequest) ToJsonString() string

type DescribeRotationDetailRequestParams

type DescribeRotationDetailRequestParams struct {
	// Specifies the name of the credential for which to get the credential rotation details.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type DescribeRotationDetailResponse

type DescribeRotationDetailResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRotationDetailResponseParams `json:"Response"`
}

func NewDescribeRotationDetailResponse

func NewDescribeRotationDetailResponse() (response *DescribeRotationDetailResponse)

func (*DescribeRotationDetailResponse) FromJsonString

func (r *DescribeRotationDetailResponse) 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 (*DescribeRotationDetailResponse) ToJsonString

func (r *DescribeRotationDetailResponse) ToJsonString() string

type DescribeRotationDetailResponseParams

type DescribeRotationDetailResponseParams struct {
	// Whether to enable rotation. `true`: enabled; `false`: disabled.
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// Rotation frequency in days. Default value: 1 day.
	// Note: this field may return null, indicating that no valid values can be obtained.
	Frequency *int64 `json:"Frequency,omitnil,omitempty" name:"Frequency"`

	// Last rotation time, which is an explicitly visible time string in the format of 2006-01-02 15:04:05.
	// Note: this field may return null, indicating that no valid values can be obtained.
	LatestRotateTime *string `json:"LatestRotateTime,omitnil,omitempty" name:"LatestRotateTime"`

	// Next rotation start time, which is an explicitly visible time string in the format of 2006-01-02 15:04:05.
	// Note: this field may return null, indicating that no valid values can be obtained.
	NextRotateBeginTime *string `json:"NextRotateBeginTime,omitnil,omitempty" name:"NextRotateBeginTime"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeRotationHistoryRequest

type DescribeRotationHistoryRequest struct {
	*tchttp.BaseRequest

	// Specifies the name of the credential for which to get the credential rotation records.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewDescribeRotationHistoryRequest

func NewDescribeRotationHistoryRequest() (request *DescribeRotationHistoryRequest)

func (*DescribeRotationHistoryRequest) FromJsonString

func (r *DescribeRotationHistoryRequest) 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 (*DescribeRotationHistoryRequest) ToJsonString

func (r *DescribeRotationHistoryRequest) ToJsonString() string

type DescribeRotationHistoryRequestParams

type DescribeRotationHistoryRequestParams struct {
	// Specifies the name of the credential for which to get the credential rotation records.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type DescribeRotationHistoryResponse

type DescribeRotationHistoryResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRotationHistoryResponseParams `json:"Response"`
}

func NewDescribeRotationHistoryResponse

func NewDescribeRotationHistoryResponse() (response *DescribeRotationHistoryResponse)

func (*DescribeRotationHistoryResponse) FromJsonString

func (r *DescribeRotationHistoryResponse) 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 (*DescribeRotationHistoryResponse) ToJsonString

func (r *DescribeRotationHistoryResponse) ToJsonString() string

type DescribeRotationHistoryResponseParams

type DescribeRotationHistoryResponseParams struct {
	// List of version numbers.
	VersionIDs []*string `json:"VersionIDs,omitnil,omitempty" name:"VersionIDs"`

	// Number of version numbers. The maximum number of version numbers that can be shown to users is 10.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSecretRequest

type DescribeSecretRequest struct {
	*tchttp.BaseRequest

	// Name of a Secret whose detailed information is to be obtained.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewDescribeSecretRequest

func NewDescribeSecretRequest() (request *DescribeSecretRequest)

func (*DescribeSecretRequest) FromJsonString

func (r *DescribeSecretRequest) 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 (*DescribeSecretRequest) ToJsonString

func (r *DescribeSecretRequest) ToJsonString() string

type DescribeSecretRequestParams

type DescribeSecretRequestParams struct {
	// Name of a Secret whose detailed information is to be obtained.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type DescribeSecretResponse

type DescribeSecretResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSecretResponseParams `json:"Response"`
}

func NewDescribeSecretResponse

func NewDescribeSecretResponse() (response *DescribeSecretResponse)

func (*DescribeSecretResponse) FromJsonString

func (r *DescribeSecretResponse) 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 (*DescribeSecretResponse) ToJsonString

func (r *DescribeSecretResponse) ToJsonString() string

type DescribeSecretResponseParams

type DescribeSecretResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Description of the Secret.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// ID of the KMS CMK used for encryption.
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// Creator UIN.
	CreateUin *uint64 `json:"CreateUin,omitnil,omitempty" name:"CreateUin"`

	// Credential status: Enabled, Disabled, PendingDelete, Creating, Failed.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Deletion time, formatted as a Unix timestamp. For a Secret that is not in `PendingDelete` status, this value is 0.
	DeleteTime *uint64 `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"`

	// Creation time.
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// `0`: user-defined secret; `1`: database credential; `2`: SSH key secret.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SecretType *int64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// Tencent Cloud service name.
	// Note: this field may return null, indicating that no valid values can be obtained.
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// Tencent Cloud service instance ID.
	// Note: this field may return null, indicating that no valid values can be obtained.
	ResourceID *string `json:"ResourceID,omitnil,omitempty" name:"ResourceID"`

	// Whether to enable rotation. `True`: enable rotation; `False`: disable rotation.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	RotationStatus *bool `json:"RotationStatus,omitnil,omitempty" name:"RotationStatus"`

	// Rotation frequency in days by default.
	// Note: this field may return null, indicating that no valid values can be obtained.
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`

	// Secret name. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
	// Note: this field may return null, indicating that no valid values can be obtained.
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// Project ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
	// Note: this field may return null, indicating that no valid values can be obtained.
	ProjectID *int64 `json:"ProjectID,omitnil,omitempty" name:"ProjectID"`

	// ID of the CVM instance associated with the SSH key. ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
	// Note: this field may return null, indicating that no valid values can be obtained.
	AssociatedInstanceIDs []*string `json:"AssociatedInstanceIDs,omitnil,omitempty" name:"AssociatedInstanceIDs"`

	// UIN of the Tencent Cloud API key. This field is valid when the secret type is Tencent Cloud API key secret.
	// Note: this field may return null, indicating that no valid values can be obtained.
	TargetUin *uint64 `json:"TargetUin,omitnil,omitempty" name:"TargetUin"`

	// Additional configuration of the Secret
	// Note: This field may return null, indicating that no valid values can be obtained.
	AdditionalConfig *string `json:"AdditionalConfig,omitnil,omitempty" name:"AdditionalConfig"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DescribeSupportedProductsRequest

type DescribeSupportedProductsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeSupportedProductsRequest

func NewDescribeSupportedProductsRequest() (request *DescribeSupportedProductsRequest)

func (*DescribeSupportedProductsRequest) FromJsonString

func (r *DescribeSupportedProductsRequest) 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 (*DescribeSupportedProductsRequest) ToJsonString

func (r *DescribeSupportedProductsRequest) ToJsonString() string

type DescribeSupportedProductsRequestParams

type DescribeSupportedProductsRequestParams struct {
}

Predefined struct for user

type DescribeSupportedProductsResponse

type DescribeSupportedProductsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSupportedProductsResponseParams `json:"Response"`
}

func NewDescribeSupportedProductsResponse

func NewDescribeSupportedProductsResponse() (response *DescribeSupportedProductsResponse)

func (*DescribeSupportedProductsResponse) FromJsonString

func (r *DescribeSupportedProductsResponse) 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 (*DescribeSupportedProductsResponse) ToJsonString

func (r *DescribeSupportedProductsResponse) ToJsonString() string

type DescribeSupportedProductsResponseParams

type DescribeSupportedProductsResponseParams struct {
	// List of supported services.
	Products []*string `json:"Products,omitnil,omitempty" name:"Products"`

	// Number of supported services
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type DisableSecretRequest

type DisableSecretRequest struct {
	*tchttp.BaseRequest

	// Name of the Secret to be disabled.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewDisableSecretRequest

func NewDisableSecretRequest() (request *DisableSecretRequest)

func (*DisableSecretRequest) FromJsonString

func (r *DisableSecretRequest) 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 (*DisableSecretRequest) ToJsonString

func (r *DisableSecretRequest) ToJsonString() string

type DisableSecretRequestParams

type DisableSecretRequestParams struct {
	// Name of the Secret to be disabled.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type DisableSecretResponse

type DisableSecretResponse struct {
	*tchttp.BaseResponse
	Response *DisableSecretResponseParams `json:"Response"`
}

func NewDisableSecretResponse

func NewDisableSecretResponse() (response *DisableSecretResponse)

func (*DisableSecretResponse) FromJsonString

func (r *DisableSecretResponse) 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 (*DisableSecretResponse) ToJsonString

func (r *DisableSecretResponse) ToJsonString() string

type DisableSecretResponseParams

type DisableSecretResponseParams struct {
	// Name of the disabled Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type EnableSecretRequest

type EnableSecretRequest struct {
	*tchttp.BaseRequest

	// Name of the Secret to be enabled.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewEnableSecretRequest

func NewEnableSecretRequest() (request *EnableSecretRequest)

func (*EnableSecretRequest) FromJsonString

func (r *EnableSecretRequest) 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 (*EnableSecretRequest) ToJsonString

func (r *EnableSecretRequest) ToJsonString() string

type EnableSecretRequestParams

type EnableSecretRequestParams struct {
	// Name of the Secret to be enabled.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type EnableSecretResponse

type EnableSecretResponse struct {
	*tchttp.BaseResponse
	Response *EnableSecretResponseParams `json:"Response"`
}

func NewEnableSecretResponse

func NewEnableSecretResponse() (response *EnableSecretResponse)

func (*EnableSecretResponse) FromJsonString

func (r *EnableSecretResponse) 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 (*EnableSecretResponse) ToJsonString

func (r *EnableSecretResponse) ToJsonString() string

type EnableSecretResponseParams

type EnableSecretResponseParams struct {
	// Name of the enabled Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	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

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

type GetRegionsResponseParams struct {
	// List of regions.
	Regions []*string `json:"Regions,omitnil,omitempty" name:"Regions"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetSSHKeyPairValueRequest

type GetSSHKeyPairValueRequest struct {
	*tchttp.BaseRequest

	// Secret name. This field is only valid for SSH key secrets.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the key pair, which is the unique identifier of the key pair in the CVM.
	SSHKeyId *string `json:"SSHKeyId,omitnil,omitempty" name:"SSHKeyId"`
}

func NewGetSSHKeyPairValueRequest

func NewGetSSHKeyPairValueRequest() (request *GetSSHKeyPairValueRequest)

func (*GetSSHKeyPairValueRequest) FromJsonString

func (r *GetSSHKeyPairValueRequest) 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 (*GetSSHKeyPairValueRequest) ToJsonString

func (r *GetSSHKeyPairValueRequest) ToJsonString() string

type GetSSHKeyPairValueRequestParams

type GetSSHKeyPairValueRequestParams struct {
	// Secret name. This field is only valid for SSH key secrets.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the key pair, which is the unique identifier of the key pair in the CVM.
	SSHKeyId *string `json:"SSHKeyId,omitnil,omitempty" name:"SSHKeyId"`
}

Predefined struct for user

type GetSSHKeyPairValueResponse

type GetSSHKeyPairValueResponse struct {
	*tchttp.BaseResponse
	Response *GetSSHKeyPairValueResponseParams `json:"Response"`
}

func NewGetSSHKeyPairValueResponse

func NewGetSSHKeyPairValueResponse() (response *GetSSHKeyPairValueResponse)

func (*GetSSHKeyPairValueResponse) FromJsonString

func (r *GetSSHKeyPairValueResponse) 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 (*GetSSHKeyPairValueResponse) ToJsonString

func (r *GetSSHKeyPairValueResponse) ToJsonString() string

type GetSSHKeyPairValueResponseParams

type GetSSHKeyPairValueResponseParams struct {
	// ID of the SSH key.
	SSHKeyID *string `json:"SSHKeyID,omitnil,omitempty" name:"SSHKeyID"`

	// Plaintext value of the Base64-encoded public key.
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// Plaintext value of the Base64-encoded private key.
	PrivateKey *string `json:"PrivateKey,omitnil,omitempty" name:"PrivateKey"`

	// ID of the project to which the SSH key belongs.
	ProjectID *int64 `json:"ProjectID,omitnil,omitempty" name:"ProjectID"`

	// Description of the SSH key.
	// The description can be modified in the CVM console.
	SSHKeyDescription *string `json:"SSHKeyDescription,omitnil,omitempty" name:"SSHKeyDescription"`

	// Name of the SSH key.
	// The name can be modified in the CVM console.
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type GetSecretValueRequest

type GetSecretValueRequest struct {
	*tchttp.BaseRequest

	// Name of a Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Specifies the version number of the corresponding credential.
	// For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as `SSM_Current`.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`
}

func NewGetSecretValueRequest

func NewGetSecretValueRequest() (request *GetSecretValueRequest)

func (*GetSecretValueRequest) FromJsonString

func (r *GetSecretValueRequest) 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 (*GetSecretValueRequest) ToJsonString

func (r *GetSecretValueRequest) ToJsonString() string

type GetSecretValueRequestParams

type GetSecretValueRequestParams struct {
	// Name of a Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Specifies the version number of the corresponding credential.
	// For Tencent Cloud service credentials such as MySQL credentials, this API is used to get the plaintext information of a previously rotated credential by specifying the credential name and historical version number. If you want to get the plaintext of the credential version currently in use, you need to specify the version number as `SSM_Current`.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`
}

Predefined struct for user

type GetSecretValueResponse

type GetSecretValueResponse struct {
	*tchttp.BaseResponse
	Response *GetSecretValueResponseParams `json:"Response"`
}

func NewGetSecretValueResponse

func NewGetSecretValueResponse() (response *GetSecretValueResponse)

func (*GetSecretValueResponse) FromJsonString

func (r *GetSecretValueResponse) 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 (*GetSecretValueResponse) ToJsonString

func (r *GetSecretValueResponse) ToJsonString() string

type GetSecretValueResponseParams

type GetSecretValueResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the Secret version.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// When creating a credential (CreateSecret), if you specify binary data, this field will be the Base64-encoded returned result. The application needs to Base64-decode the result to get the original data.
	// Either `SecretBinary` or `SecretString` cannot be empty.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// When creating a credential (CreateSecret), if you specify general text data, this field will be the returned result.
	// Either `SecretBinary` or `SecretString` cannot be empty.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	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

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

type GetServiceStatusResponseParams struct {
	// `true`: The service is activated; `false`: The service is not activated.
	ServiceEnabled *bool `json:"ServiceEnabled,omitnil,omitempty" name:"ServiceEnabled"`

	// Invalid service type. `0`: not purchased; `1`: normal; `2`: suspended due to arrears; `3`: resource released
	InvalidType *int64 `json:"InvalidType,omitnil,omitempty" name:"InvalidType"`

	// `true`: Allow SSM to manage Tencent Cloud API key secrets.
	// `false`: Forbid SSM to manage Tencent Cloud API key secrets.
	AccessKeyEscrowEnabled *bool `json:"AccessKeyEscrowEnabled,omitnil,omitempty" name:"AccessKeyEscrowEnabled"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ListSecretVersionIdsRequest

type ListSecretVersionIdsRequest struct {
	*tchttp.BaseRequest

	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewListSecretVersionIdsRequest

func NewListSecretVersionIdsRequest() (request *ListSecretVersionIdsRequest)

func (*ListSecretVersionIdsRequest) FromJsonString

func (r *ListSecretVersionIdsRequest) 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 (*ListSecretVersionIdsRequest) ToJsonString

func (r *ListSecretVersionIdsRequest) ToJsonString() string

type ListSecretVersionIdsRequestParams

type ListSecretVersionIdsRequestParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type ListSecretVersionIdsResponse

type ListSecretVersionIdsResponse struct {
	*tchttp.BaseResponse
	Response *ListSecretVersionIdsResponseParams `json:"Response"`
}

func NewListSecretVersionIdsResponse

func NewListSecretVersionIdsResponse() (response *ListSecretVersionIdsResponse)

func (*ListSecretVersionIdsResponse) FromJsonString

func (r *ListSecretVersionIdsResponse) 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 (*ListSecretVersionIdsResponse) ToJsonString

func (r *ListSecretVersionIdsResponse) ToJsonString() string

type ListSecretVersionIdsResponseParams

type ListSecretVersionIdsResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// `VersionId` list.
	// Note: This field may return `null`, indicating that no valid value was found.
	Versions []*VersionInfo `json:"Versions,omitnil,omitempty" name:"Versions"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ListSecretsRequest

type ListSecretsRequest struct {
	*tchttp.BaseRequest

	// Starting position of the list, starting at 0. If not specified, 0 is used by default.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// Filter based on credential status.
	// The default value is 0, indicating to query all.
	// 1: query the list of credentials in `Enabled` status.
	// 2: query the list of credentials in `Disabled` status.
	// 3: query the list of credentials in `PendingDelete` status.
	// 4: query the list of credentials in `PendingCreate` status.
	// 5: query the list of credentials in `CreateFailed` status.
	// The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential
	State *uint64 `json:"State,omitnil,omitempty" name:"State"`

	// Filter according to Secret names. If left empty, this filter is not applied.
	SearchSecretName *string `json:"SearchSecretName,omitnil,omitempty" name:"SearchSecretName"`

	// Tag filter.
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// `0` (default): user-defined secret.
	// `1`: Tencent Cloud services secret.
	// `2`: SSH key secret.
	// `3`: Tencent Cloud API key secret.
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// This parameter is valid only when SecretType is `1`.
	//
	// An empty value indicates querying all types of Tencent Cloud service secrets.
	// `Mysql`: queries MySQL database credentials.
	// `Tdsql-mysql`: queries TDSQL MySQL database credentials.
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`
}

func NewListSecretsRequest

func NewListSecretsRequest() (request *ListSecretsRequest)

func (*ListSecretsRequest) FromJsonString

func (r *ListSecretsRequest) 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 (*ListSecretsRequest) ToJsonString

func (r *ListSecretsRequest) ToJsonString() string

type ListSecretsRequestParams

type ListSecretsRequestParams struct {
	// Starting position of the list, starting at 0. If not specified, 0 is used by default.
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Maximum number of returned Secrets in a query. If not set or set to 0, 20 is used by default.
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Sorting order according to the creation time. If not set or set to 0, descending order is used; if set to 1, ascending order is used.
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// Filter based on credential status.
	// The default value is 0, indicating to query all.
	// 1: query the list of credentials in `Enabled` status.
	// 2: query the list of credentials in `Disabled` status.
	// 3: query the list of credentials in `PendingDelete` status.
	// 4: query the list of credentials in `PendingCreate` status.
	// 5: query the list of credentials in `CreateFailed` status.
	// The `PendingCreate` and `CreateFailed` status only take effect when `SecretType` is Tencent Cloud service credential
	State *uint64 `json:"State,omitnil,omitempty" name:"State"`

	// Filter according to Secret names. If left empty, this filter is not applied.
	SearchSecretName *string `json:"SearchSecretName,omitnil,omitempty" name:"SearchSecretName"`

	// Tag filter.
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// `0` (default): user-defined secret.
	// `1`: Tencent Cloud services secret.
	// `2`: SSH key secret.
	// `3`: Tencent Cloud API key secret.
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// This parameter is valid only when SecretType is `1`.
	//
	// An empty value indicates querying all types of Tencent Cloud service secrets.
	// `Mysql`: queries MySQL database credentials.
	// `Tdsql-mysql`: queries TDSQL MySQL database credentials.
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`
}

Predefined struct for user

type ListSecretsResponse

type ListSecretsResponse struct {
	*tchttp.BaseResponse
	Response *ListSecretsResponseParams `json:"Response"`
}

func NewListSecretsResponse

func NewListSecretsResponse() (response *ListSecretsResponse)

func (*ListSecretsResponse) FromJsonString

func (r *ListSecretsResponse) 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 (*ListSecretsResponse) ToJsonString

func (r *ListSecretsResponse) ToJsonString() string

type ListSecretsResponseParams

type ListSecretsResponseParams struct {
	// Number of filtered Secrets according to `State` and `SearchSecretName`.
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// List of Secret information.
	SecretMetadatas []*SecretMetadata `json:"SecretMetadatas,omitnil,omitempty" name:"SecretMetadatas"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type ProductPrivilegeUnit

type ProductPrivilegeUnit struct {
	// Permission name. Valid values:
	// GlobalPrivileges
	// DatabasePrivileges
	// TablePrivileges
	// ColumnPrivileges
	//
	// When the permission is `DatabasePrivileges`, the database name must be specified by the `Database` parameter;
	//
	// When the permission is `TablePrivileges`, the database name and the table name in the database must be specified by the `Database` and `TableName` parameters;
	//
	// When the permission is `ColumnPrivileges`, the database name, table name in the database, and column name in the table must be specified by the `Database`, `TableName`, and `ColumnName` parameters.
	PrivilegeName *string `json:"PrivilegeName,omitnil,omitempty" name:"PrivilegeName"`

	// Permission list.
	// For the `Mysql` service, optional permission values are:
	//
	// 1. Valid values of `GlobalPrivileges`: "SELECT","INSERT","UPDATE","DELETE","CREATE", "PROCESS", "DROP","REFERENCES","INDEX","ALTER","SHOW DATABASES","CREATE TEMPORARY TABLES","LOCK TABLES","EXECUTE","CREATE VIEW","SHOW VIEW","CREATE ROUTINE","ALTER ROUTINE","EVENT","TRIGGER".
	// Note: if this parameter is not passed in, it means to clear the permission.
	//
	// 2. Valid values of `DatabasePrivileges`: "SELECT","INSERT","UPDATE","DELETE","CREATE", "DROP","REFERENCES","INDEX","ALTER","CREATE TEMPORARY TABLES","LOCK TABLES","EXECUTE","CREATE VIEW","SHOW VIEW","CREATE ROUTINE","ALTER ROUTINE","EVENT","TRIGGER".
	// Note: if this parameter is not passed in, it means to clear the permission.
	//
	// 3. Valid values of `TablePrivileges`: "SELECT","INSERT","UPDATE","DELETE","CREATE", "DROP","REFERENCES","INDEX","ALTER","CREATE VIEW","SHOW VIEW", "TRIGGER".
	// Note: if this parameter is not passed in, it means to clear the permission.
	//
	// 4. Valid values of `ColumnPrivileges`: "SELECT","INSERT","UPDATE","REFERENCES".
	// Note: if this parameter is not passed in, it means to clear the permission.
	Privileges []*string `json:"Privileges,omitnil,omitempty" name:"Privileges"`

	// This value takes effect only when `PrivilegeName` is `DatabasePrivileges`.
	Database *string `json:"Database,omitnil,omitempty" name:"Database"`

	// This value takes effect only when `PrivilegeName` is `TablePrivileges`, and the `Database` parameter is required in this case to explicitly indicate the database instance.
	TableName *string `json:"TableName,omitnil,omitempty" name:"TableName"`

	// This value takes effect only when `PrivilegeName` is `ColumnPrivileges`, and the following parameters are required in this case:
	// Database: explicitly indicate the database instance.
	// TableName: explicitly indicate the table
	ColumnName *string `json:"ColumnName,omitnil,omitempty" name:"ColumnName"`
}

type PutSecretValueRequest

type PutSecretValueRequest struct {
	*tchttp.BaseRequest

	// Name of a Secret where the version is added to.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the new Secret version. It can be up to 64 bytes, contain letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// Base64-encoded binary credential information.
	// Either `SecretBinary` or `SecretString` must be set.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// Secret information plaintext in text format, base64 encoding is not needed. Either `SecretBinary` or `SecretString` must be set.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`
}

func NewPutSecretValueRequest

func NewPutSecretValueRequest() (request *PutSecretValueRequest)

func (*PutSecretValueRequest) FromJsonString

func (r *PutSecretValueRequest) 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 (*PutSecretValueRequest) ToJsonString

func (r *PutSecretValueRequest) ToJsonString() string

type PutSecretValueRequestParams

type PutSecretValueRequestParams struct {
	// Name of a Secret where the version is added to.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the new Secret version. It can be up to 64 bytes, contain letters, digits, hyphens (-), and underscores (_), and must begin with a letter or digit.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// Base64-encoded binary credential information.
	// Either `SecretBinary` or `SecretString` must be set.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// Secret information plaintext in text format, base64 encoding is not needed. Either `SecretBinary` or `SecretString` must be set.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`
}

Predefined struct for user

type PutSecretValueResponse

type PutSecretValueResponse struct {
	*tchttp.BaseResponse
	Response *PutSecretValueResponseParams `json:"Response"`
}

func NewPutSecretValueResponse

func NewPutSecretValueResponse() (response *PutSecretValueResponse)

func (*PutSecretValueResponse) FromJsonString

func (r *PutSecretValueResponse) 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 (*PutSecretValueResponse) ToJsonString

func (r *PutSecretValueResponse) ToJsonString() string

type PutSecretValueResponseParams

type PutSecretValueResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Version ID that is newly added.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RestoreSecretRequest

type RestoreSecretRequest struct {
	*tchttp.BaseRequest

	// Name of the Secret to be restored.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewRestoreSecretRequest

func NewRestoreSecretRequest() (request *RestoreSecretRequest)

func (*RestoreSecretRequest) FromJsonString

func (r *RestoreSecretRequest) 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 (*RestoreSecretRequest) ToJsonString

func (r *RestoreSecretRequest) ToJsonString() string

type RestoreSecretRequestParams

type RestoreSecretRequestParams struct {
	// Name of the Secret to be restored.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type RestoreSecretResponse

type RestoreSecretResponse struct {
	*tchttp.BaseResponse
	Response *RestoreSecretResponseParams `json:"Response"`
}

func NewRestoreSecretResponse

func NewRestoreSecretResponse() (response *RestoreSecretResponse)

func (*RestoreSecretResponse) FromJsonString

func (r *RestoreSecretResponse) 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 (*RestoreSecretResponse) ToJsonString

func (r *RestoreSecretResponse) ToJsonString() string

type RestoreSecretResponseParams

type RestoreSecretResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type RotateProductSecretRequest

type RotateProductSecretRequest struct {
	*tchttp.BaseRequest

	// Name of the credential to be rotated.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewRotateProductSecretRequest

func NewRotateProductSecretRequest() (request *RotateProductSecretRequest)

func (*RotateProductSecretRequest) FromJsonString

func (r *RotateProductSecretRequest) 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 (*RotateProductSecretRequest) ToJsonString

func (r *RotateProductSecretRequest) ToJsonString() string

type RotateProductSecretRequestParams

type RotateProductSecretRequestParams struct {
	// Name of the credential to be rotated.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type RotateProductSecretResponse

type RotateProductSecretResponse struct {
	*tchttp.BaseResponse
	Response *RotateProductSecretResponseParams `json:"Response"`
}

func NewRotateProductSecretResponse

func NewRotateProductSecretResponse() (response *RotateProductSecretResponse)

func (*RotateProductSecretResponse) FromJsonString

func (r *RotateProductSecretResponse) 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 (*RotateProductSecretResponse) ToJsonString

func (r *RotateProductSecretResponse) ToJsonString() string

type RotateProductSecretResponseParams

type RotateProductSecretResponseParams struct {
	// Asynchronous rotation task ID. This field is valid when `SecretType` is `1` (i.e., the secret type is Tencent Cloud services secret, such as MySQL/TDSQL credentials).
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type SecretMetadata

type SecretMetadata struct {
	// Credential name
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Credential description
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// KMS `KeyId` used to encrypt the credential
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// Creator UIN
	CreateUin *uint64 `json:"CreateUin,omitnil,omitempty" name:"CreateUin"`

	// Credential status: Enabled, Disabled, PendingDelete, Creating, Failed.
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Credential deletion date, which takes effect for credentials in `PendingDelete` status and is in UNIX timestamp format
	DeleteTime *uint64 `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"`

	// Credential creation time in UNIX timestamp format
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Type of the KMS CMK used to encrypt the credential. `DEFAULT` represents the default key created by Secrets Manager, and `CUSTOMER` represents the user-specified key
	KmsKeyType *string `json:"KmsKeyType,omitnil,omitempty" name:"KmsKeyType"`

	// 1: enable rotation; 0: disable rotation
	// Note: this field may return null, indicating that no valid values can be obtained.
	RotationStatus *int64 `json:"RotationStatus,omitnil,omitempty" name:"RotationStatus"`

	// Start time of the next rotation in UNIX timestamp format
	// Note: this field may return null, indicating that no valid values can be obtained.
	NextRotationTime *uint64 `json:"NextRotationTime,omitnil,omitempty" name:"NextRotationTime"`

	// `0`: user-defined secret.
	// `1`: Tencent Cloud services secret.
	// `2`: SSH key secret.
	// `3`: Tencent Cloud API key secret.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SecretType *int64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// Tencent Cloud service name, which takes effect only when `SecretType` is 1 (Tencent Cloud service credential)
	// Note: this field may return null, indicating that no valid values can be obtained.
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// Secret name. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// Project ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	ProjectID *int64 `json:"ProjectID,omitnil,omitempty" name:"ProjectID"`

	// ID of the CVM instance associated with the SSH key. ID. This field is only valid when the `SecretType` is set to `2` (SSH key secret).
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	AssociatedInstanceIDs []*string `json:"AssociatedInstanceIDs,omitnil,omitempty" name:"AssociatedInstanceIDs"`

	// UIN of the Tencent Cloud API key. This field is valid when the secret type is Tencent Cloud API key secret.
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	TargetUin *uint64 `json:"TargetUin,omitnil,omitempty" name:"TargetUin"`

	// Rotation frequency in days. It takes effect when the rotation feature is enabled.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`

	// ID of Tencent Cloud resource corresponding with the Secret.
	// Note: This field may return null, indicating that no valid values can be obtained.
	ResourceID *string `json:"ResourceID,omitnil,omitempty" name:"ResourceID"`

	// The rotation start time.
	// Note: This field may return null, indicating that no valid values can be obtained.
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`
}

type Tag

type Tag struct {
	// Tag key
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type TagFilter

type TagFilter struct {
	// Tag key
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// Tag value
	TagValue []*string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type UpdateDescriptionRequest

type UpdateDescriptionRequest struct {
	*tchttp.BaseRequest

	// Name of a Secret whose description is to be updated.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// New description information, which can be up to 2048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

func NewUpdateDescriptionRequest

func NewUpdateDescriptionRequest() (request *UpdateDescriptionRequest)

func (*UpdateDescriptionRequest) FromJsonString

func (r *UpdateDescriptionRequest) 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 (*UpdateDescriptionRequest) ToJsonString

func (r *UpdateDescriptionRequest) ToJsonString() string

type UpdateDescriptionRequestParams

type UpdateDescriptionRequestParams struct {
	// Name of a Secret whose description is to be updated.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// New description information, which can be up to 2048 bytes.
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`
}

Predefined struct for user

type UpdateDescriptionResponse

type UpdateDescriptionResponse struct {
	*tchttp.BaseResponse
	Response *UpdateDescriptionResponseParams `json:"Response"`
}

func NewUpdateDescriptionResponse

func NewUpdateDescriptionResponse() (response *UpdateDescriptionResponse)

func (*UpdateDescriptionResponse) FromJsonString

func (r *UpdateDescriptionResponse) 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 (*UpdateDescriptionResponse) ToJsonString

func (r *UpdateDescriptionResponse) ToJsonString() string

type UpdateDescriptionResponseParams

type UpdateDescriptionResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateRotationStatusRequest

type UpdateRotationStatusRequest struct {
	*tchttp.BaseRequest

	// Tencent Cloud service credential name.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Specifies whether to enable rotation.
	// `true`: enables rotation.
	// `false`: disables rotation.
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// Rotation frequency in days. Value range: 30–365.
	Frequency *int64 `json:"Frequency,omitnil,omitempty" name:"Frequency"`

	// User-defined rotation start time in the format of 2006-01-02 15:04:05.
	// When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the current time will be entered by default.
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`
}

func NewUpdateRotationStatusRequest

func NewUpdateRotationStatusRequest() (request *UpdateRotationStatusRequest)

func (*UpdateRotationStatusRequest) FromJsonString

func (r *UpdateRotationStatusRequest) 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 (*UpdateRotationStatusRequest) ToJsonString

func (r *UpdateRotationStatusRequest) ToJsonString() string

type UpdateRotationStatusRequestParams

type UpdateRotationStatusRequestParams struct {
	// Tencent Cloud service credential name.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Specifies whether to enable rotation.
	// `true`: enables rotation.
	// `false`: disables rotation.
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// Rotation frequency in days. Value range: 30–365.
	Frequency *int64 `json:"Frequency,omitnil,omitempty" name:"Frequency"`

	// User-defined rotation start time in the format of 2006-01-02 15:04:05.
	// When `EnableRotation` is `true` and `RotationBeginTime` is left empty, the current time will be entered by default.
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`
}

Predefined struct for user

type UpdateRotationStatusResponse

type UpdateRotationStatusResponse struct {
	*tchttp.BaseResponse
	Response *UpdateRotationStatusResponseParams `json:"Response"`
}

func NewUpdateRotationStatusResponse

func NewUpdateRotationStatusResponse() (response *UpdateRotationStatusResponse)

func (*UpdateRotationStatusResponse) FromJsonString

func (r *UpdateRotationStatusResponse) 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 (*UpdateRotationStatusResponse) ToJsonString

func (r *UpdateRotationStatusResponse) ToJsonString() string

type UpdateRotationStatusResponseParams

type UpdateRotationStatusResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type UpdateSecretRequest

type UpdateSecretRequest struct {
	*tchttp.BaseRequest

	// Name of a Secret whose content is to be updated.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the Secret version whose content is to be updated.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// This field should be used and Base64-encoded if the content of the new credential is binary.
	// Either `SecretBinary` or `SecretString` cannot be empty.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// This field should be used without being Base64-encoded if the content of the new credential is text. Either `SecretBinary` or `SecretString` cannot be empty.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`
}

func NewUpdateSecretRequest

func NewUpdateSecretRequest() (request *UpdateSecretRequest)

func (*UpdateSecretRequest) FromJsonString

func (r *UpdateSecretRequest) 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 (*UpdateSecretRequest) ToJsonString

func (r *UpdateSecretRequest) ToJsonString() string

type UpdateSecretRequestParams

type UpdateSecretRequestParams struct {
	// Name of a Secret whose content is to be updated.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// ID of the Secret version whose content is to be updated.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// This field should be used and Base64-encoded if the content of the new credential is binary.
	// Either `SecretBinary` or `SecretString` cannot be empty.
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// This field should be used without being Base64-encoded if the content of the new credential is text. Either `SecretBinary` or `SecretString` cannot be empty.
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`
}

Predefined struct for user

type UpdateSecretResponse

type UpdateSecretResponse struct {
	*tchttp.BaseResponse
	Response *UpdateSecretResponseParams `json:"Response"`
}

func NewUpdateSecretResponse

func NewUpdateSecretResponse() (response *UpdateSecretResponse)

func (*UpdateSecretResponse) FromJsonString

func (r *UpdateSecretResponse) 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 (*UpdateSecretResponse) ToJsonString

func (r *UpdateSecretResponse) ToJsonString() string

type UpdateSecretResponseParams

type UpdateSecretResponseParams struct {
	// Name of the Secret.
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// Version ID of the Secret.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"`
}

Predefined struct for user

type VersionInfo

type VersionInfo struct {
	// Version ID.
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// Creation time, formatted as a Unix timestamp.
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`
}

Jump to

Keyboard shortcuts

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