v20190923

package
v1.0.923 Latest Latest
Warning

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

Go to latest
Published: May 16, 2024 License: Apache-2.0 Imports: 7 Imported by: 6

Documentation

Index

Constants

View Source
const (

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

	// DryRun 操作,代表请求将会是成功的,只是多传了 DryRun 参数。
	DRYRUNOPERATION = "DryRunOperation"

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

	// KMS操作失败。
	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"

	// AccessKey已经达到上限。
	OPERATIONDENIED_ACCESSKEYOVERLIMIT = "OperationDenied.AccessKeyOverLimit"

	// 不允许手动更新具有自动轮换功能的凭据。
	OPERATIONDENIED_AUTOROTATEDRESOURCE = "OperationDenied.AutoRotatedResource"

	// 角色不存在。
	OPERATIONDENIED_ROLENOTEXIST = "OperationDenied.RoleNotExist"

	// 被操作密钥与账号不匹配。
	OPERATIONDENIED_UINNOTMATCH = "OperationDenied.UinNotMatch"

	// 请求的次数超过了频率限制。
	REQUESTLIMITEXCEEDED = "RequestLimitExceeded"

	// 资源被占用。
	RESOURCEINUSE = "ResourceInUse"

	// 凭据名已存在。
	RESOURCEINUSE_SECRETEXISTS = "ResourceInUse.SecretExists"

	// 版本号已存在。
	RESOURCEINUSE_VERSIONIDEXISTS = "ResourceInUse.VersionIdExists"

	// 资源不足。
	RESOURCEINSUFFICIENT = "ResourceInsufficient"

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

	// 凭据不存在。
	RESOURCENOTFOUND_SECRETNOTEXIST = "ResourceNotFound.SecretNotExist"

	// 资源不可用。
	RESOURCEUNAVAILABLE = "ResourceUnavailable"

	// 服务未购买。
	RESOURCEUNAVAILABLE_NOTPURCHASED = "ResourceUnavailable.NotPurchased"

	// 凭据被禁用。
	RESOURCEUNAVAILABLE_RESOURCEDISABLED = "ResourceUnavailable.ResourceDisabled"

	// 凭据处于计划删除状态。
	RESOURCEUNAVAILABLE_RESOURCEPENDINGDELETED = "ResourceUnavailable.ResourcePendingDeleted"

	// 凭据未完成初始化。
	RESOURCEUNAVAILABLE_RESOURCEUNINITIALIZED = "ResourceUnavailable.ResourceUninitialized"

	// 资源售罄。
	RESOURCESSOLDOUT = "ResourcesSoldOut"

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

	// 访问KMS失败。
	UNAUTHORIZEDOPERATION_ACCESSKMSERROR = "UnauthorizedOperation.AccessKmsError"

	// 未知参数错误。
	UNKNOWNPARAMETER = "UnknownParameter"

	// 操作不支持。
	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 added in v1.0.204

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

CreateProductSecret 创建云产品凭据

可能返回的错误码:

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

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

CreateProductSecret 创建云产品凭据

可能返回的错误码:

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

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

CreateSSHKeyPairSecret 创建用于托管SSH密钥对的凭据

可能返回的错误码:

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

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

CreateSSHKeyPairSecret 创建用于托管SSH密钥对的凭据

可能返回的错误码:

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 创建新的凭据信息,通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。

可能返回的错误码:

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

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

CreateSecret 创建新的凭据信息,通过KMS进行加密保护。每个Region最多可创建存储1000个凭据信息。

可能返回的错误码:

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 删除指定的凭据信息,可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据,在删除日期到达之前状态为 PendingDelete,并可以通过RestoreSecret 进行恢复,超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行(计划)删除操作。

可能返回的错误码:

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 该接口用于直接删除指定凭据下的单个版本凭据,删除操作立即生效,对所有状态下的凭据版本都可以删除。

本接口仅适用于用户自定义凭据,本接口不能对云产品凭据进行操作。

可能返回的错误码:

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

func (*Client) DeleteSecretVersionWithContext added in v1.0.324

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

DeleteSecretVersion 该接口用于直接删除指定凭据下的单个版本凭据,删除操作立即生效,对所有状态下的凭据版本都可以删除。

本接口仅适用于用户自定义凭据,本接口不能对云产品凭据进行操作。

可能返回的错误码:

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

func (*Client) DeleteSecretWithContext added in v1.0.324

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

DeleteSecret 删除指定的凭据信息,可以通过RecoveryWindowInDays参数设置立即删除或者计划删除。对于计划删除的凭据,在删除日期到达之前状态为 PendingDelete,并可以通过RestoreSecret 进行恢复,超出指定删除日期之后会被彻底删除。您必须先通过 DisableSecret 停用凭据后才可以进行(计划)删除操作。

可能返回的错误码:

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

func (*Client) DescribeAsyncRequestInfo added in v1.0.204

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

DescribeAsyncRequestInfo 查询异步任务的执行结果

可能返回的错误码:

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

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

DescribeAsyncRequestInfo 查询异步任务的执行结果

可能返回的错误码:

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

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

DescribeRotationDetail 查询凭据轮转策略详情。

本接口只适用于云产品凭据。

可能返回的错误码:

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

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

DescribeRotationDetail 查询凭据轮转策略详情。

本接口只适用于云产品凭据。

可能返回的错误码:

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

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

DescribeRotationHistory 查询凭据轮转历史版本。

本接口仅适用于云产品凭据。

可能返回的错误码:

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

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

DescribeRotationHistory 查询凭据轮转历史版本。

本接口仅适用于云产品凭据。

可能返回的错误码:

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 获取凭据的详细属性信息。

可能返回的错误码:

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

func (*Client) DescribeSecretWithContext added in v1.0.324

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

DescribeSecret 获取凭据的详细属性信息。

可能返回的错误码:

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

func (*Client) DescribeSupportedProducts added in v1.0.204

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

DescribeSupportedProducts 查询支持的云产品列表

可能返回的错误码:

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

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

DescribeSupportedProducts 查询支持的云产品列表

可能返回的错误码:

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 停用指定的凭据,停用后状态为 Disabled,无法通过接口获取该凭据的明文。

可能返回的错误码:

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

func (*Client) DisableSecretWithContext added in v1.0.324

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

DisableSecret 停用指定的凭据,停用后状态为 Disabled,无法通过接口获取该凭据的明文。

可能返回的错误码:

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 该接口用于开启凭据,状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启,需要通过RestoreSecret 恢复后再开启使用。

可能返回的错误码:

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

func (*Client) EnableSecretWithContext added in v1.0.324

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

EnableSecret 该接口用于开启凭据,状态为Enabled。可以通过 GetSecretValue 接口获取凭据明文。处于PendingDelete状态的凭据不能直接开启,需要通过RestoreSecret 恢复后再开启使用。

可能返回的错误码:

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 获取控制台展示region列表

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetRegionsWithContext added in v1.0.324

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

GetRegions 获取控制台展示region列表

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetSSHKeyPairValue added in v1.0.229

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

GetSSHKeyPairValue 获取SSH密钥对凭据明文信息。

可能返回的错误码:

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

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

GetSSHKeyPairValue 获取SSH密钥对凭据明文信息。

可能返回的错误码:

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 对于用户自定义凭据,通过指定凭据名称和版本来获取凭据的明文信息;

对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为:SSM_Current。

可能返回的错误码:

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

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

GetSecretValue 对于用户自定义凭据,通过指定凭据名称和版本来获取凭据的明文信息;

对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为:SSM_Current。

可能返回的错误码:

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 该接口用户获取用户SecretsManager服务开通状态。

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) GetServiceStatusWithContext added in v1.0.324

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

GetServiceStatus 该接口用户获取用户SecretsManager服务开通状态。

可能返回的错误码:

INTERNALERROR = "InternalError"
UNAUTHORIZEDOPERATION = "UnauthorizedOperation"

func (*Client) ListSecretVersionIds

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

ListSecretVersionIds 该接口用于获取指定凭据下的版本列表信息

可能返回的错误码:

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

func (*Client) ListSecretVersionIdsWithContext added in v1.0.324

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

ListSecretVersionIds 该接口用于获取指定凭据下的版本列表信息

可能返回的错误码:

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 该接口用于获取所有凭据的详细列表,可以指定过滤字段、排序方式等。

可能返回的错误码:

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

func (*Client) ListSecretsWithContext added in v1.0.324

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

ListSecrets 该接口用于获取所有凭据的详细列表,可以指定过滤字段、排序方式等。

可能返回的错误码:

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

func (*Client) PutSecretValue

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

PutSecretValue 该接口在指定名称的凭据下增加新版本的凭据内容,一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。

本接口仅适用于用户自定义凭据,对云产品凭据不能操作。

可能返回的错误码:

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

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

PutSecretValue 该接口在指定名称的凭据下增加新版本的凭据内容,一个凭据下最多可以支持10个版本。只能对处于Enabled 和 Disabled 状态的凭据添加新的版本。

本接口仅适用于用户自定义凭据,对云产品凭据不能操作。

可能返回的错误码:

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 该接口用于恢复计划删除(PendingDelete状态)中的凭据,取消计划删除。取消计划删除的凭据将处于Disabled 状态,如需恢复使用,通过EnableSecret 接口开启凭据。

可能返回的错误码:

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

func (*Client) RestoreSecretWithContext added in v1.0.324

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

RestoreSecret 该接口用于恢复计划删除(PendingDelete状态)中的凭据,取消计划删除。取消计划删除的凭据将处于Disabled 状态,如需恢复使用,通过EnableSecret 接口开启凭据。

可能返回的错误码:

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

func (*Client) RotateProductSecret added in v1.0.204

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

RotateProductSecret 轮转云产品凭据或云API密钥对凭据。

该接口仅适用于处于Enabled状态的云产品凭据或处于Enable状态的云API密钥对凭据,对于其他状态的云产品凭据或云API密钥对凭据或用户自定义凭据不适用。

可能返回的错误码:

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

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

RotateProductSecret 轮转云产品凭据或云API密钥对凭据。

该接口仅适用于处于Enabled状态的云产品凭据或处于Enable状态的云API密钥对凭据,对于其他状态的云产品凭据或云API密钥对凭据或用户自定义凭据不适用。

可能返回的错误码:

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 该接口用于修改指定凭据的描述信息,仅能修改Enabled 和 Disabled 状态的凭据。

可能返回的错误码:

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

func (*Client) UpdateDescriptionWithContext added in v1.0.324

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

UpdateDescription 该接口用于修改指定凭据的描述信息,仅能修改Enabled 和 Disabled 状态的凭据。

可能返回的错误码:

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

func (*Client) UpdateRotationStatus added in v1.0.204

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

UpdateRotationStatus 设置云产品凭据轮转策略,可以设置:

是否开启轮转

轮转周期

轮转开始时间

可能返回的错误码:

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

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

UpdateRotationStatus 设置云产品凭据轮转策略,可以设置:

是否开启轮转

轮转周期

轮转开始时间

可能返回的错误码:

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 该接口用于更新指定凭据名称和版本号的内容,调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。

本接口仅适用于用户自定义凭据,不能对云产品凭据操作。

可能返回的错误码:

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

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

UpdateSecret 该接口用于更新指定凭据名称和版本号的内容,调用该接口会对新的凭据内容加密后覆盖旧的内容。仅允许更新Enabled 和 Disabled 状态的凭据。

本接口仅适用于用户自定义凭据,不能对云产品凭据操作。

可能返回的错误码:

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

type CreateProductSecretRequest added in v1.0.204

type CreateProductSecretRequest struct {
	*tchttp.BaseRequest

	// 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 用户账号名前缀,由用户自行指定,长度限定在8个字符以内,
	// 可选字符集包括:
	// 数字字符:[0, 9],
	// 小写字符:[a, z],
	// 大写字符:[A, Z],
	// 特殊字符(全英文符号):下划线(_),
	// 前缀必须以大写或小写字母开头。
	UserNamePrefix *string `json:"UserNamePrefix,omitnil,omitempty" name:"UserNamePrefix"`

	// 凭据所绑定的云产品名称,如Mysql,可以通过DescribeSupportedProducts接口获取所支持的云产品名称。
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// 云产品实例ID。
	InstanceID *string `json:"InstanceID,omitnil,omitempty" name:"InstanceID"`

	// 账号的域名,IP形式,支持填入%。
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// 将凭据与云产品实例绑定时,需要授予的权限列表。
	PrivilegesList []*ProductPrivilegeUnit `json:"PrivilegesList,omitnil,omitempty" name:"PrivilegesList"`

	// 描述信息,用于详细描述用途等,最大支持2048字节。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。
	// 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。
	// 您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

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

	// 用户自定义的开始轮转时间,格式:2006-01-02 15:04:05。
	// 当EnableRotation为True时,此参数必填。
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`

	// 是否开启轮转
	// True -- 开启
	// False -- 不开启
	// 如果不指定,默认为False。
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// 轮转周期,以天为单位,默认为1天。
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`
}

func NewCreateProductSecretRequest added in v1.0.204

func NewCreateProductSecretRequest() (request *CreateProductSecretRequest)

func (*CreateProductSecretRequest) FromJsonString added in v1.0.204

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

func (r *CreateProductSecretRequest) ToJsonString() string

type CreateProductSecretRequestParams added in v1.0.426

type CreateProductSecretRequestParams struct {
	// 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 用户账号名前缀,由用户自行指定,长度限定在8个字符以内,
	// 可选字符集包括:
	// 数字字符:[0, 9],
	// 小写字符:[a, z],
	// 大写字符:[A, Z],
	// 特殊字符(全英文符号):下划线(_),
	// 前缀必须以大写或小写字母开头。
	UserNamePrefix *string `json:"UserNamePrefix,omitnil,omitempty" name:"UserNamePrefix"`

	// 凭据所绑定的云产品名称,如Mysql,可以通过DescribeSupportedProducts接口获取所支持的云产品名称。
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// 云产品实例ID。
	InstanceID *string `json:"InstanceID,omitnil,omitempty" name:"InstanceID"`

	// 账号的域名,IP形式,支持填入%。
	Domains []*string `json:"Domains,omitnil,omitempty" name:"Domains"`

	// 将凭据与云产品实例绑定时,需要授予的权限列表。
	PrivilegesList []*ProductPrivilegeUnit `json:"PrivilegesList,omitnil,omitempty" name:"PrivilegesList"`

	// 描述信息,用于详细描述用途等,最大支持2048字节。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。
	// 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。
	// 您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

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

	// 用户自定义的开始轮转时间,格式:2006-01-02 15:04:05。
	// 当EnableRotation为True时,此参数必填。
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`

	// 是否开启轮转
	// True -- 开启
	// False -- 不开启
	// 如果不指定,默认为False。
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// 轮转周期,以天为单位,默认为1天。
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`
}

Predefined struct for user

type CreateProductSecretResponse added in v1.0.204

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

func NewCreateProductSecretResponse added in v1.0.204

func NewCreateProductSecretResponse() (response *CreateProductSecretResponse)

func (*CreateProductSecretResponse) FromJsonString added in v1.0.204

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

func (r *CreateProductSecretResponse) ToJsonString() string

type CreateProductSecretResponseParams added in v1.0.426

type CreateProductSecretResponseParams struct {
	// 创建的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误。
	// 注意:此字段可能返回 null,表示取不到有效值。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// 标签操作的返回信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

	// 创建云产品凭据异步任务ID号。
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`

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

Predefined struct for user

type CreateSSHKeyPairSecretRequest added in v1.0.229

type CreateSSHKeyPairSecretRequest struct {
	*tchttp.BaseRequest

	// 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥对创建后所属的项目ID。
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 描述信息,用于详细描述用途等,最大支持2048字节。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。
	// 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。
	// 您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

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

	// 用户自定义输入的SSH密钥对的名称,可由数字,字母和下划线组成,只能以数字和字母开头,长度不超过25个字符。
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`
}

func NewCreateSSHKeyPairSecretRequest added in v1.0.229

func NewCreateSSHKeyPairSecretRequest() (request *CreateSSHKeyPairSecretRequest)

func (*CreateSSHKeyPairSecretRequest) FromJsonString added in v1.0.229

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

func (r *CreateSSHKeyPairSecretRequest) ToJsonString() string

type CreateSSHKeyPairSecretRequestParams added in v1.0.426

type CreateSSHKeyPairSecretRequestParams struct {
	// 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥对创建后所属的项目ID。
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 描述信息,用于详细描述用途等,最大支持2048字节。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。
	// 如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。
	// 您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

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

	// 用户自定义输入的SSH密钥对的名称,可由数字,字母和下划线组成,只能以数字和字母开头,长度不超过25个字符。
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`
}

Predefined struct for user

type CreateSSHKeyPairSecretResponse added in v1.0.229

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

func NewCreateSSHKeyPairSecretResponse added in v1.0.229

func NewCreateSSHKeyPairSecretResponse() (response *CreateSSHKeyPairSecretResponse)

func (*CreateSSHKeyPairSecretResponse) FromJsonString added in v1.0.229

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

func (r *CreateSSHKeyPairSecretResponse) ToJsonString() string

type CreateSSHKeyPairSecretResponseParams added in v1.0.426

type CreateSSHKeyPairSecretResponseParams struct {
	// 创建的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 创建的SSH密钥ID。
	SSHKeyID *string `json:"SSHKeyID,omitnil,omitempty" name:"SSHKeyID"`

	// 创建的SSH密钥名称。
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`

	// 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// 标签操作的返回信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

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

Predefined struct for user

type CreateSecretRequest

type CreateSecretRequest struct {
	*tchttp.BaseRequest

	// 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。一旦创建不可修改。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据版本,查询凭据信息时需要根据SecretName 和 VersionId进行查询,最长64 字节,使用字母、数字或者 - _ . 的组合并且以字母或数字开头。若为空,则使用默认的初始凭据版本号。可选,若为空或该凭据为云产品类凭据,则该版本号默认为 SSM_Current。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 描述信息,用于详细描述用途等,最大支持2048字节。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// 凭据类型,默认为自定义凭据。
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// 二进制凭据信息base64编码后的明文。SecretBinary 和 SecretString 必须且只能设置一个,最大支持32KB字节。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 文本类型凭据信息明文(不需要进行base64编码)。SecretBinary 和 SecretString 必须且只能设置一个,最大支持32KB字节。
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`

	// JSON 格式字符串,用于指定特定凭据类型的额外配置。
	AdditionalConfig *string `json:"AdditionalConfig,omitnil,omitempty" name:"AdditionalConfig"`

	// 标签列表
	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 added in v1.0.426

type CreateSecretRequestParams struct {
	// 凭据名称,同一region内不可重复,最长128字节,使用字母、数字或者 - _ 的组合,第一个字符必须为字母或者数字。一旦创建不可修改。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据版本,查询凭据信息时需要根据SecretName 和 VersionId进行查询,最长64 字节,使用字母、数字或者 - _ . 的组合并且以字母或数字开头。若为空,则使用默认的初始凭据版本号。可选,若为空或该凭据为云产品类凭据,则该版本号默认为 SSM_Current。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 描述信息,用于详细描述用途等,最大支持2048字节。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 指定对凭据进行加密的KMS CMK。如果为空则表示使用Secrets Manager为您默认创建的CMK进行加密。您也可以指定在同region 下自行创建的KMS CMK进行加密。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// 凭据类型,默认为自定义凭据。
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// 二进制凭据信息base64编码后的明文。SecretBinary 和 SecretString 必须且只能设置一个,最大支持32KB字节。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 文本类型凭据信息明文(不需要进行base64编码)。SecretBinary 和 SecretString 必须且只能设置一个,最大支持32KB字节。
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`

	// JSON 格式字符串,用于指定特定凭据类型的额外配置。
	AdditionalConfig *string `json:"AdditionalConfig,omitnil,omitempty" name:"AdditionalConfig"`

	// 标签列表
	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 added in v1.0.426

type CreateSecretResponseParams struct {
	// 新创建的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 新创建的凭据版本。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 标签操作的返回码. 0: 成功;1: 内部错误;2: 业务处理错误
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagCode *uint64 `json:"TagCode,omitnil,omitempty" name:"TagCode"`

	// 标签操作的返回信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagMsg *string `json:"TagMsg,omitnil,omitempty" name:"TagMsg"`

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

Predefined struct for user

type DeleteSecretRequest

type DeleteSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要删除的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定计划删除日期,单位(天),0(默认)表示立即删除, 1-30 表示预留的天数,超出该日期之后彻底删除。
	// 当凭据类型为SSH密钥对凭据时,此字段只能取值只能为0。
	RecoveryWindowInDays *uint64 `json:"RecoveryWindowInDays,omitnil,omitempty" name:"RecoveryWindowInDays"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,取值:
	// True -- 表示不仅仅清理此凭据中存储的SSH密钥信息,还会将SSH密钥对从CVM侧进行清理。注意,如果SSH密钥此时绑定了CVM实例,那么会清理失败。
	// False --  表示仅仅清理此凭据中存储的SSH密钥信息,不在CVM进侧进行清理。
	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 added in v1.0.426

type DeleteSecretRequestParams struct {
	// 指定需要删除的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定计划删除日期,单位(天),0(默认)表示立即删除, 1-30 表示预留的天数,超出该日期之后彻底删除。
	// 当凭据类型为SSH密钥对凭据时,此字段只能取值只能为0。
	RecoveryWindowInDays *uint64 `json:"RecoveryWindowInDays,omitnil,omitempty" name:"RecoveryWindowInDays"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,取值:
	// True -- 表示不仅仅清理此凭据中存储的SSH密钥信息,还会将SSH密钥对从CVM侧进行清理。注意,如果SSH密钥此时绑定了CVM实例,那么会清理失败。
	// False --  表示仅仅清理此凭据中存储的SSH密钥信息,不在CVM进侧进行清理。
	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 added in v1.0.426

type DeleteSecretResponseParams struct {
	// 指定删除的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据删除的日期,unix时间戳。
	DeleteTime *int64 `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"`

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

Predefined struct for user

type DeleteSecretVersionRequest

type DeleteSecretVersionRequest struct {
	*tchttp.BaseRequest

	// 指定凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定该名称下需要删除的凭据的版本号。
	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 added in v1.0.426

type DeleteSecretVersionRequestParams struct {
	// 指定凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定该名称下需要删除的凭据的版本号。
	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 added in v1.0.426

type DeleteSecretVersionResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

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

Predefined struct for user

type DescribeAsyncRequestInfoRequest added in v1.0.204

type DescribeAsyncRequestInfoRequest struct {
	*tchttp.BaseRequest

	// 异步任务ID号。
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`
}

func NewDescribeAsyncRequestInfoRequest added in v1.0.204

func NewDescribeAsyncRequestInfoRequest() (request *DescribeAsyncRequestInfoRequest)

func (*DescribeAsyncRequestInfoRequest) FromJsonString added in v1.0.204

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

func (r *DescribeAsyncRequestInfoRequest) ToJsonString() string

type DescribeAsyncRequestInfoRequestParams added in v1.0.426

type DescribeAsyncRequestInfoRequestParams struct {
	// 异步任务ID号。
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`
}

Predefined struct for user

type DescribeAsyncRequestInfoResponse added in v1.0.204

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

func NewDescribeAsyncRequestInfoResponse added in v1.0.204

func NewDescribeAsyncRequestInfoResponse() (response *DescribeAsyncRequestInfoResponse)

func (*DescribeAsyncRequestInfoResponse) FromJsonString added in v1.0.204

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

func (r *DescribeAsyncRequestInfoResponse) ToJsonString() string

type DescribeAsyncRequestInfoResponseParams added in v1.0.426

type DescribeAsyncRequestInfoResponseParams struct {
	// 0:处理中,1:处理成功,2:处理失败
	TaskStatus *int64 `json:"TaskStatus,omitnil,omitempty" name:"TaskStatus"`

	// 任务描述信息。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

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

Predefined struct for user

type DescribeRotationDetailRequest added in v1.0.204

type DescribeRotationDetailRequest struct {
	*tchttp.BaseRequest

	// 指定需要获取凭据轮转详细信息的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewDescribeRotationDetailRequest added in v1.0.204

func NewDescribeRotationDetailRequest() (request *DescribeRotationDetailRequest)

func (*DescribeRotationDetailRequest) FromJsonString added in v1.0.204

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

func (r *DescribeRotationDetailRequest) ToJsonString() string

type DescribeRotationDetailRequestParams added in v1.0.426

type DescribeRotationDetailRequestParams struct {
	// 指定需要获取凭据轮转详细信息的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type DescribeRotationDetailResponse added in v1.0.204

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

func NewDescribeRotationDetailResponse added in v1.0.204

func NewDescribeRotationDetailResponse() (response *DescribeRotationDetailResponse)

func (*DescribeRotationDetailResponse) FromJsonString added in v1.0.204

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

func (r *DescribeRotationDetailResponse) ToJsonString() string

type DescribeRotationDetailResponseParams added in v1.0.426

type DescribeRotationDetailResponseParams struct {
	// 否允许轮转,true表示开启轮转,false表示禁止轮转。
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// 轮转的频率,以天为单位,默认为1天。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Frequency *int64 `json:"Frequency,omitnil,omitempty" name:"Frequency"`

	// 最近一次轮转的时间,显式可见的时间字符串,格式 2006-01-02 15:04:05。
	// 注意:此字段可能返回 null,表示取不到有效值。
	LatestRotateTime *string `json:"LatestRotateTime,omitnil,omitempty" name:"LatestRotateTime"`

	// 下一次开始轮转的时间,显式可见的时间字符串,格式 2006-01-02 15:04:05。
	// 注意:此字段可能返回 null,表示取不到有效值。
	NextRotateBeginTime *string `json:"NextRotateBeginTime,omitnil,omitempty" name:"NextRotateBeginTime"`

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

Predefined struct for user

type DescribeRotationHistoryRequest added in v1.0.204

type DescribeRotationHistoryRequest struct {
	*tchttp.BaseRequest

	// 指定需要获取凭据轮转历史的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewDescribeRotationHistoryRequest added in v1.0.204

func NewDescribeRotationHistoryRequest() (request *DescribeRotationHistoryRequest)

func (*DescribeRotationHistoryRequest) FromJsonString added in v1.0.204

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

func (r *DescribeRotationHistoryRequest) ToJsonString() string

type DescribeRotationHistoryRequestParams added in v1.0.426

type DescribeRotationHistoryRequestParams struct {
	// 指定需要获取凭据轮转历史的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type DescribeRotationHistoryResponse added in v1.0.204

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

func NewDescribeRotationHistoryResponse added in v1.0.204

func NewDescribeRotationHistoryResponse() (response *DescribeRotationHistoryResponse)

func (*DescribeRotationHistoryResponse) FromJsonString added in v1.0.204

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

func (r *DescribeRotationHistoryResponse) ToJsonString() string

type DescribeRotationHistoryResponseParams added in v1.0.426

type DescribeRotationHistoryResponseParams struct {
	// 版本号列表。
	VersionIDs []*string `json:"VersionIDs,omitnil,omitempty" name:"VersionIDs"`

	// 版本号个数,可以给用户展示的版本号个数上限为10个。
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeSecretRequest

type DescribeSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要获取凭据详细信息的凭据名称。
	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 added in v1.0.426

type DescribeSecretRequestParams struct {
	// 指定需要获取凭据详细信息的凭据名称。
	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 added in v1.0.426

type DescribeSecretResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据描述信息。
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 用于加密的KMS CMK ID。
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

	// 创建者UIN。
	CreateUin *uint64 `json:"CreateUin,omitnil,omitempty" name:"CreateUin"`

	// 凭据状态:Enabled、Disabled、PendingDelete, Creating, Failed。
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 删除日期,uinx 时间戳,非计划删除状态的凭据为0。
	DeleteTime *uint64 `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"`

	// 创建日期。
	CreateTime *uint64 `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 0 --  用户自定义凭据类型;1 -- 数据库凭据类型;2 -- SSH密钥对凭据类型;3 -- 云API密钥(AKSK)凭据类型(使用此功能需要联系云助手单独开启白名单);4 -- Redis类型凭据。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SecretType *int64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// 云产品名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// 云产品实例ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceID *string `json:"ResourceID,omitnil,omitempty" name:"ResourceID"`

	// 是否开启轮转:True -- 开启轮转;False -- 关闭轮转。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RotationStatus *bool `json:"RotationStatus,omitnil,omitempty" name:"RotationStatus"`

	// 轮转周期,默认以天为单位。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,用于表示SSH密钥对凭据的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,用于表示SSH密钥对所属的项目ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProjectID *int64 `json:"ProjectID,omitnil,omitempty" name:"ProjectID"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,用于表示SSH密钥对所关联的CVM实例ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AssociatedInstanceIDs []*string `json:"AssociatedInstanceIDs,omitnil,omitempty" name:"AssociatedInstanceIDs"`

	// 当凭据类型为云API密钥对凭据时,此字段有效,用于表示此云API密钥对所属的用户UIN。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TargetUin *uint64 `json:"TargetUin,omitnil,omitempty" name:"TargetUin"`

	// 凭据额外配置
	// 注意:此字段可能返回 null,表示取不到有效值。
	AdditionalConfig *string `json:"AdditionalConfig,omitnil,omitempty" name:"AdditionalConfig"`

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

Predefined struct for user

type DescribeSupportedProductsRequest added in v1.0.204

type DescribeSupportedProductsRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeSupportedProductsRequest added in v1.0.204

func NewDescribeSupportedProductsRequest() (request *DescribeSupportedProductsRequest)

func (*DescribeSupportedProductsRequest) FromJsonString added in v1.0.204

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

func (r *DescribeSupportedProductsRequest) ToJsonString() string

type DescribeSupportedProductsRequestParams added in v1.0.426

type DescribeSupportedProductsRequestParams struct {
}

Predefined struct for user

type DescribeSupportedProductsResponse added in v1.0.204

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

func NewDescribeSupportedProductsResponse added in v1.0.204

func NewDescribeSupportedProductsResponse() (response *DescribeSupportedProductsResponse)

func (*DescribeSupportedProductsResponse) FromJsonString added in v1.0.204

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

func (r *DescribeSupportedProductsResponse) ToJsonString() string

type DescribeSupportedProductsResponseParams added in v1.0.426

type DescribeSupportedProductsResponseParams struct {
	// 支持的所有云产品列表。
	// 每种云产品与凭据类型的对应关系如下:
	// 当SecretType为1时,支持的云产品列表包括:Mysql、Tdsql-mysql、Tdsql_C_Mysql;
	// 当SecretType为2时,支持的产品列表为:Cvm;
	// 当SecretType为3时,支持的产品列表为:Cam(此功能的使用需要联系云助手单独开始白名单);
	// 当SecretType为4时,支持的产品列表为:Redis。
	Products []*string `json:"Products,omitnil,omitempty" name:"Products"`

	// 支持的产品个数
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DisableSecretRequest

type DisableSecretRequest struct {
	*tchttp.BaseRequest

	// 指定停用的凭据名称。
	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 added in v1.0.426

type DisableSecretRequestParams struct {
	// 指定停用的凭据名称。
	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 added in v1.0.426

type DisableSecretResponseParams struct {
	// 停用的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

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

Predefined struct for user

type EnableSecretRequest

type EnableSecretRequest struct {
	*tchttp.BaseRequest

	// 指定启用凭据的名称。
	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 added in v1.0.426

type EnableSecretRequestParams struct {
	// 指定启用凭据的名称。
	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 added in v1.0.426

type EnableSecretResponseParams struct {
	// 启用的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

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

Predefined struct for user

type GetRegionsRequest

type GetRegionsRequest struct {
	*tchttp.BaseRequest
}

func NewGetRegionsRequest

func NewGetRegionsRequest() (request *GetRegionsRequest)

func (*GetRegionsRequest) FromJsonString

func (r *GetRegionsRequest) FromJsonString(s string) error

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

func (*GetRegionsRequest) ToJsonString

func (r *GetRegionsRequest) ToJsonString() string

type GetRegionsRequestParams added in v1.0.426

type GetRegionsRequestParams struct {
}

Predefined struct for user

type GetRegionsResponse

type GetRegionsResponse struct {
	*tchttp.BaseResponse
	Response *GetRegionsResponseParams `json:"Response"`
}

func NewGetRegionsResponse

func NewGetRegionsResponse() (response *GetRegionsResponse)

func (*GetRegionsResponse) FromJsonString

func (r *GetRegionsResponse) FromJsonString(s string) error

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

func (*GetRegionsResponse) ToJsonString

func (r *GetRegionsResponse) ToJsonString() string

type GetRegionsResponseParams added in v1.0.426

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

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

Predefined struct for user

type GetSSHKeyPairValueRequest added in v1.0.229

type GetSSHKeyPairValueRequest struct {
	*tchttp.BaseRequest

	// 凭据名称,此凭据只能为SSH密钥对凭据类型。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥对ID,是云服务器中密钥对的唯一标识。
	SSHKeyId *string `json:"SSHKeyId,omitnil,omitempty" name:"SSHKeyId"`
}

func NewGetSSHKeyPairValueRequest added in v1.0.229

func NewGetSSHKeyPairValueRequest() (request *GetSSHKeyPairValueRequest)

func (*GetSSHKeyPairValueRequest) FromJsonString added in v1.0.229

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

func (r *GetSSHKeyPairValueRequest) ToJsonString() string

type GetSSHKeyPairValueRequestParams added in v1.0.426

type GetSSHKeyPairValueRequestParams struct {
	// 凭据名称,此凭据只能为SSH密钥对凭据类型。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 密钥对ID,是云服务器中密钥对的唯一标识。
	SSHKeyId *string `json:"SSHKeyId,omitnil,omitempty" name:"SSHKeyId"`
}

Predefined struct for user

type GetSSHKeyPairValueResponse added in v1.0.229

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

func NewGetSSHKeyPairValueResponse added in v1.0.229

func NewGetSSHKeyPairValueResponse() (response *GetSSHKeyPairValueResponse)

func (*GetSSHKeyPairValueResponse) FromJsonString added in v1.0.229

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

func (r *GetSSHKeyPairValueResponse) ToJsonString() string

type GetSSHKeyPairValueResponseParams added in v1.0.426

type GetSSHKeyPairValueResponseParams struct {
	// SSH密钥对ID。
	SSHKeyID *string `json:"SSHKeyID,omitnil,omitempty" name:"SSHKeyID"`

	// 公钥明文,使用base64编码。
	PublicKey *string `json:"PublicKey,omitnil,omitempty" name:"PublicKey"`

	// 私钥明文,使用base64编码
	PrivateKey *string `json:"PrivateKey,omitnil,omitempty" name:"PrivateKey"`

	// 此密钥对所属的项目ID。
	ProjectID *int64 `json:"ProjectID,omitnil,omitempty" name:"ProjectID"`

	// SSH密钥对的描述信息。
	// 用户可以在CVM侧控制台对密钥对的描述信息进行修改。
	SSHKeyDescription *string `json:"SSHKeyDescription,omitnil,omitempty" name:"SSHKeyDescription"`

	// SSH密钥对的名称。
	// 用户可以在CVM侧控制台对密钥对的名称进行修改。
	SSHKeyName *string `json:"SSHKeyName,omitnil,omitempty" name:"SSHKeyName"`

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

Predefined struct for user

type GetSecretValueRequest

type GetSecretValueRequest struct {
	*tchttp.BaseRequest

	// 指定凭据的名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定对应凭据的版本号。
	// 对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为: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 added in v1.0.426

type GetSecretValueRequestParams struct {
	// 指定凭据的名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定对应凭据的版本号。
	// 对于云产品凭据如Mysql凭据,通过指定凭据名称和历史版本号来获取历史轮转凭据的明文信息,如果要获取当前正在使用的凭据版本的明文,需要将版本号指定为: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 added in v1.0.426

type GetSecretValueResponseParams struct {
	// 凭据的名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 该凭据对应的版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 在创建凭据(CreateSecret)时,如果指定的是二进制数据,则该字段为返回结果,并且使用base64进行编码,应用方需要进行base64解码后获取原始数据。
	// SecretBinary和SecretString只有一个不为空。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 在创建凭据(CreateSecret)时,如果指定的是普通文本数据,则该字段为返回结果。
	// SecretBinary和SecretString只有一个不为空。
	SecretString *string `json:"SecretString,omitnil,omitempty" name:"SecretString"`

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

Predefined struct for user

type GetServiceStatusRequest

type GetServiceStatusRequest struct {
	*tchttp.BaseRequest
}

func NewGetServiceStatusRequest

func NewGetServiceStatusRequest() (request *GetServiceStatusRequest)

func (*GetServiceStatusRequest) FromJsonString

func (r *GetServiceStatusRequest) FromJsonString(s string) error

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

func (*GetServiceStatusRequest) ToJsonString

func (r *GetServiceStatusRequest) ToJsonString() string

type GetServiceStatusRequestParams added in v1.0.426

type GetServiceStatusRequestParams struct {
}

Predefined struct for user

type GetServiceStatusResponse

type GetServiceStatusResponse struct {
	*tchttp.BaseResponse
	Response *GetServiceStatusResponseParams `json:"Response"`
}

func NewGetServiceStatusResponse

func NewGetServiceStatusResponse() (response *GetServiceStatusResponse)

func (*GetServiceStatusResponse) FromJsonString

func (r *GetServiceStatusResponse) FromJsonString(s string) error

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

func (*GetServiceStatusResponse) ToJsonString

func (r *GetServiceStatusResponse) ToJsonString() string

type GetServiceStatusResponseParams added in v1.0.426

type GetServiceStatusResponseParams struct {
	// true表示服务已开通,false 表示服务尚未开通。
	ServiceEnabled *bool `json:"ServiceEnabled,omitnil,omitempty" name:"ServiceEnabled"`

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

	// true表示用户已经可以使用密钥安全托管功能,
	// false表示用户暂时不能使用密钥安全托管功能。
	AccessKeyEscrowEnabled *bool `json:"AccessKeyEscrowEnabled,omitnil,omitempty" name:"AccessKeyEscrowEnabled"`

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

Predefined struct for user

type ListSecretVersionIdsRequest

type ListSecretVersionIdsRequest struct {
	*tchttp.BaseRequest

	// 凭据名称。
	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 added in v1.0.426

type ListSecretVersionIdsRequestParams struct {
	// 凭据名称。
	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 added in v1.0.426

type ListSecretVersionIdsResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// VersionId列表。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Versions []*VersionInfo `json:"Versions,omitnil,omitempty" name:"Versions"`

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

Predefined struct for user

type ListSecretsRequest

type ListSecretsRequest struct {
	*tchttp.BaseRequest

	// 查询列表的起始位置,以0开始,不设置默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 单次查询返回的最大数量,0或不设置则使用默认值 20。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据创建时间的排序方式,0或者不设置则使用降序排序, 1 表示升序排序。
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// 根据凭据状态进行过滤。
	// 默认为0表示查询全部。
	// 1 --  表示查询Enabled 凭据列表。
	// 2 --  表示查询Disabled 凭据列表。
	// 3 --  表示查询PendingDelete 凭据列表。
	// 4 --  表示PendingCreate。
	// 5 --  表示CreateFailed。
	// 其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效
	State *uint64 `json:"State,omitnil,omitempty" name:"State"`

	// 根据凭据名称进行过滤,为空表示不过滤。
	SearchSecretName *string `json:"SearchSecretName,omitnil,omitempty" name:"SearchSecretName"`

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

	// 0  -- 表示用户自定义凭据,默认为0。
	// 1  -- 表示用户云产品凭据。
	// 2 -- 表示SSH密钥对凭据。
	// 3 -- 表示云API密钥对凭据。
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// 此参数仅在SecretType参数值为1时生效,
	// 当SecretType值为1时:
	// 如果ProductName值为空,则表示查询所有类型的云产品凭据;
	// 如果ProductName值为某个指定的云产品值如Mysql时,则表示查询Mysql数据库凭据;
	// 如果ProductName值为多个云产品值,如:Mysql,Tdsql-mysql,Tdsql_C_Mysql(多个值以英文逗号,分隔开)则表示查询三种云产品类型的凭据;
	// 支持的云产品列表请通过接口:DescribeSupportedProducts进行查询。
	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 added in v1.0.426

type ListSecretsRequestParams struct {
	// 查询列表的起始位置,以0开始,不设置默认为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 单次查询返回的最大数量,0或不设置则使用默认值 20。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 根据创建时间的排序方式,0或者不设置则使用降序排序, 1 表示升序排序。
	OrderType *uint64 `json:"OrderType,omitnil,omitempty" name:"OrderType"`

	// 根据凭据状态进行过滤。
	// 默认为0表示查询全部。
	// 1 --  表示查询Enabled 凭据列表。
	// 2 --  表示查询Disabled 凭据列表。
	// 3 --  表示查询PendingDelete 凭据列表。
	// 4 --  表示PendingCreate。
	// 5 --  表示CreateFailed。
	// 其中状态PendingCreate和CreateFailed只有在SecretType为云产品凭据时生效
	State *uint64 `json:"State,omitnil,omitempty" name:"State"`

	// 根据凭据名称进行过滤,为空表示不过滤。
	SearchSecretName *string `json:"SearchSecretName,omitnil,omitempty" name:"SearchSecretName"`

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

	// 0  -- 表示用户自定义凭据,默认为0。
	// 1  -- 表示用户云产品凭据。
	// 2 -- 表示SSH密钥对凭据。
	// 3 -- 表示云API密钥对凭据。
	SecretType *uint64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// 此参数仅在SecretType参数值为1时生效,
	// 当SecretType值为1时:
	// 如果ProductName值为空,则表示查询所有类型的云产品凭据;
	// 如果ProductName值为某个指定的云产品值如Mysql时,则表示查询Mysql数据库凭据;
	// 如果ProductName值为多个云产品值,如:Mysql,Tdsql-mysql,Tdsql_C_Mysql(多个值以英文逗号,分隔开)则表示查询三种云产品类型的凭据;
	// 支持的云产品列表请通过接口:DescribeSupportedProducts进行查询。
	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 added in v1.0.426

type ListSecretsResponseParams struct {
	// 根据State和SearchSecretName 筛选的凭据总数。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 返回凭据信息列表。
	SecretMetadatas []*SecretMetadata `json:"SecretMetadatas,omitnil,omitempty" name:"SecretMetadatas"`

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

Predefined struct for user

type ProductPrivilegeUnit added in v1.0.204

type ProductPrivilegeUnit struct {
	// 权限名称,当前可选:
	// GlobalPrivileges
	// DatabasePrivileges
	// TablePrivileges
	// ColumnPrivileges
	//
	// 当权限为DatabasePrivileges时,必须通过参数Database指定数据库名;
	//
	// 当权限为TablePrivileges时,必须通过参数Database和TableName指定数据库名以及数据库中的表名;
	//
	// 当权限为ColumnPrivileges时,必须通过参数Database、TableName和CoulmnName指定数据库、数据库中的表名以及表中的列名。
	PrivilegeName *string `json:"PrivilegeName,omitnil,omitempty" name:"PrivilegeName"`

	// 权限列表。
	// 对于Mysql产品来说,可选权限值为:
	//
	// 1. 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"。
	// 注意,不传该参数表示清除该权限。
	//
	// 2. 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"。
	// 注意,不传该参数表示清除该权限。
	//
	// 3. TablePrivileges 权限的可选值为:权限的可选值为:"SELECT","INSERT","UPDATE","DELETE","CREATE", "DROP","REFERENCES","INDEX","ALTER","CREATE VIEW","SHOW VIEW", "TRIGGER"。
	// 注意,不传该参数表示清除该权限。
	//
	// 4. ColumnPrivileges 权限的可选值为:"SELECT","INSERT","UPDATE","REFERENCES"。
	// 注意,不传该参数表示清除该权限。
	Privileges []*string `json:"Privileges,omitnil,omitempty" name:"Privileges"`

	// 仅当PrivilegeName为DatabasePrivileges时这个值才有效。
	Database *string `json:"Database,omitnil,omitempty" name:"Database"`

	// 仅当PrivilegeName为TablePrivileges时这个值才有效,并且此时需要填充Database显式指明所在的数据库实例。
	TableName *string `json:"TableName,omitnil,omitempty" name:"TableName"`

	// 仅当PrivilegeName为ColumnPrivileges时这个值才生效,并且此时必须填充:
	// Database - 显式指明所在的数据库实例。
	// TableName - 显式指明所在表
	ColumnName *string `json:"ColumnName,omitnil,omitempty" name:"ColumnName"`
}

type PutSecretValueRequest

type PutSecretValueRequest struct {
	*tchttp.BaseRequest

	// 指定需要增加版本的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定新增加的版本号,最长64 字节,使用字母、数字或者 - _ . 的组合并且以字母或数字开头。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 二进制凭据信息,使用base64编码。
	// SecretBinary 和 SecretString 必须且只能设置一个。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 文本类型凭据信息明文(不需要进行base64编码),SecretBinary 和 SecretString 必须且只能设置一个。
	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 added in v1.0.426

type PutSecretValueRequestParams struct {
	// 指定需要增加版本的凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定新增加的版本号,最长64 字节,使用字母、数字或者 - _ . 的组合并且以字母或数字开头。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 二进制凭据信息,使用base64编码。
	// SecretBinary 和 SecretString 必须且只能设置一个。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 文本类型凭据信息明文(不需要进行base64编码),SecretBinary 和 SecretString 必须且只能设置一个。
	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 added in v1.0.426

type PutSecretValueResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 新增加的版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

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

Predefined struct for user

type RestoreSecretRequest

type RestoreSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要恢复的凭据名称。
	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 added in v1.0.426

type RestoreSecretRequestParams struct {
	// 指定需要恢复的凭据名称。
	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 added in v1.0.426

type RestoreSecretResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

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

Predefined struct for user

type RotateProductSecretRequest added in v1.0.204

type RotateProductSecretRequest struct {
	*tchttp.BaseRequest

	// 需要轮转的凭据名。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

func NewRotateProductSecretRequest added in v1.0.204

func NewRotateProductSecretRequest() (request *RotateProductSecretRequest)

func (*RotateProductSecretRequest) FromJsonString added in v1.0.204

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

func (r *RotateProductSecretRequest) ToJsonString() string

type RotateProductSecretRequestParams added in v1.0.426

type RotateProductSecretRequestParams struct {
	// 需要轮转的凭据名。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`
}

Predefined struct for user

type RotateProductSecretResponse added in v1.0.204

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

func NewRotateProductSecretResponse added in v1.0.204

func NewRotateProductSecretResponse() (response *RotateProductSecretResponse)

func (*RotateProductSecretResponse) FromJsonString added in v1.0.204

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

func (r *RotateProductSecretResponse) ToJsonString() string

type RotateProductSecretResponseParams added in v1.0.426

type RotateProductSecretResponseParams struct {
	// 当凭据类型为云产品凭据时(即SecretType为1,如MySQL、Tdsql等托管凭据)此字段有效,返回轮转异步任务ID号。
	FlowID *int64 `json:"FlowID,omitnil,omitempty" name:"FlowID"`

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

Predefined struct for user

type SecretMetadata

type SecretMetadata struct {
	// 凭据名称
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据的描述信息
	Description *string `json:"Description,omitnil,omitempty" name:"Description"`

	// 用于加密凭据的KMS KeyId
	KmsKeyId *string `json:"KmsKeyId,omitnil,omitempty" name:"KmsKeyId"`

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

	// 凭据状态:Enabled、Disabled、PendingDelete、Creating、Failed
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 凭据删除日期,对于status为PendingDelete 的有效,unix时间戳
	DeleteTime *uint64 `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"`

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

	// 用于加密凭据的KMS CMK类型,DEFAULT 表示SecretsManager 创建的默认密钥, CUSTOMER 表示用户指定的密钥
	KmsKeyType *string `json:"KmsKeyType,omitnil,omitempty" name:"KmsKeyType"`

	// 1:--开启轮转;0--禁止轮转
	// 注意:此字段可能返回 null,表示取不到有效值。
	RotationStatus *int64 `json:"RotationStatus,omitnil,omitempty" name:"RotationStatus"`

	// 下一次轮转开始时间,uinx 时间戳
	// 注意:此字段可能返回 null,表示取不到有效值。
	NextRotationTime *uint64 `json:"NextRotationTime,omitnil,omitempty" name:"NextRotationTime"`

	// 0 -- 用户自定义凭据;
	// 1 -- 云产品凭据;
	// 2 -- SSH密钥对凭据;
	// 3 -- 云API密钥对凭据;
	// 4 -- Redis类型凭据;
	// 注意:此字段可能返回 null,表示取不到有效值。
	SecretType *int64 `json:"SecretType,omitnil,omitempty" name:"SecretType"`

	// 云产品名称,仅在SecretType为1,即凭据类型为云产品凭据时生效
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProductName *string `json:"ProductName,omitnil,omitempty" name:"ProductName"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,用于表示SSH密钥对凭据的名称。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceName *string `json:"ResourceName,omitnil,omitempty" name:"ResourceName"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,用于表示SSH密钥对所属的项目ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ProjectID *int64 `json:"ProjectID,omitnil,omitempty" name:"ProjectID"`

	// 当凭据类型为SSH密钥对凭据时,此字段有效,用于表示SSH密钥对所关联的CVM实例ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	AssociatedInstanceIDs []*string `json:"AssociatedInstanceIDs,omitnil,omitempty" name:"AssociatedInstanceIDs"`

	// 当凭据类型为云API密钥对凭据时,此字段有效,用于表示云API密钥对所属的用户UIN。
	// 注意:此字段可能返回 null,表示取不到有效值。
	TargetUin *uint64 `json:"TargetUin,omitnil,omitempty" name:"TargetUin"`

	// 轮转的频率,以天作为单位,在轮转开启状态下生效。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RotationFrequency *int64 `json:"RotationFrequency,omitnil,omitempty" name:"RotationFrequency"`

	// 云产品凭据对应的云产品实例 ID 号。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ResourceID *string `json:"ResourceID,omitnil,omitempty" name:"ResourceID"`

	// 用户指定的轮转开始时间。
	// 注意:此字段可能返回 null,表示取不到有效值。
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`
}

type Tag

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

	// 标签值
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type TagFilter

type TagFilter struct {
	// 标签键
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// 标签值
	TagValue []*string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type UpdateDescriptionRequest

type UpdateDescriptionRequest struct {
	*tchttp.BaseRequest

	// 指定需要更新描述信息的凭据名。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 新的描述信息,最大长度2048个字节。
	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 added in v1.0.426

type UpdateDescriptionRequestParams struct {
	// 指定需要更新描述信息的凭据名。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 新的描述信息,最大长度2048个字节。
	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 added in v1.0.426

type UpdateDescriptionResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

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

Predefined struct for user

type UpdateRotationStatusRequest added in v1.0.204

type UpdateRotationStatusRequest struct {
	*tchttp.BaseRequest

	// 云产品凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 是否开启轮转。
	// true -- 开启轮转;
	// false -- 禁止轮转。
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// 轮转周期,以天为单位,最小为30天,最大为365天。
	Frequency *int64 `json:"Frequency,omitnil,omitempty" name:"Frequency"`

	// 用户设置的期望开始轮转时间,格式为:2006-01-02 15:04:05。
	// 当EnableRotation为true时,如果不填RotationBeginTime,则默认填充为当前时间。
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`
}

func NewUpdateRotationStatusRequest added in v1.0.204

func NewUpdateRotationStatusRequest() (request *UpdateRotationStatusRequest)

func (*UpdateRotationStatusRequest) FromJsonString added in v1.0.204

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

func (r *UpdateRotationStatusRequest) ToJsonString() string

type UpdateRotationStatusRequestParams added in v1.0.426

type UpdateRotationStatusRequestParams struct {
	// 云产品凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 是否开启轮转。
	// true -- 开启轮转;
	// false -- 禁止轮转。
	EnableRotation *bool `json:"EnableRotation,omitnil,omitempty" name:"EnableRotation"`

	// 轮转周期,以天为单位,最小为30天,最大为365天。
	Frequency *int64 `json:"Frequency,omitnil,omitempty" name:"Frequency"`

	// 用户设置的期望开始轮转时间,格式为:2006-01-02 15:04:05。
	// 当EnableRotation为true时,如果不填RotationBeginTime,则默认填充为当前时间。
	RotationBeginTime *string `json:"RotationBeginTime,omitnil,omitempty" name:"RotationBeginTime"`
}

Predefined struct for user

type UpdateRotationStatusResponse added in v1.0.204

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

func NewUpdateRotationStatusResponse added in v1.0.204

func NewUpdateRotationStatusResponse() (response *UpdateRotationStatusResponse)

func (*UpdateRotationStatusResponse) FromJsonString added in v1.0.204

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

func (r *UpdateRotationStatusResponse) ToJsonString() string

type UpdateRotationStatusResponseParams added in v1.0.426

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

Predefined struct for user

type UpdateSecretRequest

type UpdateSecretRequest struct {
	*tchttp.BaseRequest

	// 指定需要更新凭据内容的名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定需要更新凭据内容的版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 新的凭据内容为二进制的场景使用该字段,并使用base64进行编码。
	// SecretBinary 和 SecretString 只能一个不为空。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 新的凭据内容为文本的场景使用该字段,不需要base64编码SecretBinary 和 SecretString 只能一个不为空。
	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 added in v1.0.426

type UpdateSecretRequestParams struct {
	// 指定需要更新凭据内容的名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 指定需要更新凭据内容的版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 新的凭据内容为二进制的场景使用该字段,并使用base64进行编码。
	// SecretBinary 和 SecretString 只能一个不为空。
	SecretBinary *string `json:"SecretBinary,omitnil,omitempty" name:"SecretBinary"`

	// 新的凭据内容为文本的场景使用该字段,不需要base64编码SecretBinary 和 SecretString 只能一个不为空。
	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 added in v1.0.426

type UpdateSecretResponseParams struct {
	// 凭据名称。
	SecretName *string `json:"SecretName,omitnil,omitempty" name:"SecretName"`

	// 凭据版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

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

Predefined struct for user

type VersionInfo

type VersionInfo struct {
	// 版本号。
	VersionId *string `json:"VersionId,omitnil,omitempty" name:"VersionId"`

	// 创建时间,unix时间戳。
	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