v20190725

package
v1.0.920 Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source
const (

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

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

	// 按key回档未开启
	FAILEDOPERATION_FLASHBACKBYKEYNOTOPEN = "FailedOperation.FlashbackByKeyNotOpen"

	// 内核响应超时。
	FAILEDOPERATION_KERNELRESPONSETIMEOUT = "FailedOperation.KernelResponseTimeout"

	// 当前实例已开启外网访问。
	FAILEDOPERATION_NOTALLOWMODIFYADDRAFTEROPENWANSERVICE = "FailedOperation.NotAllowModifyAddrAfterOpenWanService"

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

	// appId校验失败。
	INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"

	// 实例查询失败。
	INTERNALERROR_FINDINSTANCEFAILED = "InternalError.FindInstanceFailed"

	// password与原先记录的password不同。
	INTERNALERROR_PASSWORDERROR = "InternalError.PasswordError"

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

	// 当前实例不支持设置参数。
	INVALIDPARAMETER_CURRENTINSTANCENOTSUPPORTMODIFYPARAMS = "InvalidParameter.CurrentInstanceNotSupportModifyParams"

	// 无效Vip信息。
	INVALIDPARAMETER_INVALIDVIP = "InvalidParameter.InvalidVip"

	// 接口参数为空。
	INVALIDPARAMETER_PARAMETERSNIL = "InvalidParameter.ParametersNil"

	// 当前子账号无权执行该操作。
	INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

	// 可用区已关闭售卖。
	INVALIDPARAMETER_ZONECLOSED = "InvalidParameter.ZoneClosed"

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

	// 备份文件未找到。
	INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"

	// appId校验失败。
	INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"

	// 无效的实例类型。
	INVALIDPARAMETERVALUE_CLUSTERTYPEERROR = "InvalidParameterValue.ClusterTypeError"

	// 非法的实例名。
	INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName"

	// 非法的实例状态。
	INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"

	// 实例状态不允许进行下线,进行下线操作的实例状态必须为隔离状态。
	INVALIDPARAMETERVALUE_ILLEGALSTATUSTOOFFLINE = "InvalidParameterValue.IllegalStatusToOffline"

	// 实例已删除。
	INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"

	// 实例已隔离。
	INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated"

	// 计费相关错误,不允许对当前实例进行对应的新购/续费/配置变更操作。
	INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"

	// 实例锁定失败。
	INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"

	// 错误的机型。
	INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"

	// 内存和磁盘必须同时升配或降配。
	INVALIDPARAMETERVALUE_MODIFYMODEERROR = "InvalidParameterValue.ModifyModeError"

	// 实例版本错误。
	INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"

	// 实例版本不支持查询客户端信息。
	INVALIDPARAMETERVALUE_MONGOVERSIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.MongoVersionNotSupportQueryClient"

	// 当前副本集/分片未找到该节点。
	INVALIDPARAMETERVALUE_NODENOTFOUNDINREPLICA = "InvalidParameterValue.NodeNotFoundInReplica"

	// 未找到实例。
	INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

	// OplogSize参数设置错误,应介于磁盘容量的10%和90%之间。
	INVALIDPARAMETERVALUE_OPLOGSIZEOUTOFRANGE = "InvalidParameterValue.OplogSizeOutOfRange"

	// 密码不符合规范。
	INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"

	// 单个地域后付费实例数量超过限制。
	INVALIDPARAMETERVALUE_POSTPAIDINSTANCEBEYONDLIMIT = "InvalidParameterValue.PostPaidInstanceBeyondLimit"

	// 预付费实例不支持销毁。
	INVALIDPARAMETERVALUE_PREPAIDINSTANCEUNABLETOISOLATE = "InvalidParameterValue.PrePaidInstanceUnableToIsolate"

	// 项目不存在。
	INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"

	// proxy版本不支持查询客户端信息,请联系工作人员进行升级。
	INVALIDPARAMETERVALUE_PROXYNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.ProxyNotSupportQueryClient"

	// 查询offset超出范围。
	INVALIDPARAMETERVALUE_QUERYOUTOFRANGE = "InvalidParameterValue.QueryOutOfRange"

	// 只能查询7天内的慢日志。
	INVALIDPARAMETERVALUE_QUERYTIMEOUTOFRANGE = "InvalidParameterValue.QueryTimeOutOfRange"

	// 只能查询7天内的慢日志。
	INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit"

	// 无效的地域。
	INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"

	// 当前地域尚不支持该操作。
	INVALIDPARAMETERVALUE_REGIONNOTSUPPORTOPERATION = "InvalidParameterValue.RegionNotSupportOperation"

	// 地域尚不支持查询客户端信息。
	INVALIDPARAMETERVALUE_REGIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.RegionNotSupportQueryClient"

	// 未找到副本集/分片。
	INVALIDPARAMETERVALUE_REPLICANOTFOUND = "InvalidParameterValue.ReplicaNotFound"

	// 副本集(分片)数量错误。
	INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"

	// 从节点数错误。
	INVALIDPARAMETERVALUE_SECONDARYNUMERROR = "InvalidParameterValue.SecondaryNumError"

	// 安全组ID无效。
	INVALIDPARAMETERVALUE_SECURITYGROUPID = "InvalidParameterValue.SecurityGroupId"

	// 设置的磁盘大小不得低于已用磁盘的1.2倍。
	INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed"

	// slowMS参数取值范围[100, 。
	INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit"

	// 购买规格错误。
	INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"

	// 起始时间晚于结束时间。
	INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime"

	// 实例处于不允许操作的状态。
	INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

	// 未找到指定的标签。
	INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"

	// 用户账户不存在。
	INVALIDPARAMETERVALUE_USERNOTFOUND = "InvalidParameterValue.UserNotFound"

	// 未找到虚拟网络(子网)。
	INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"

	// 可用区已关闭售卖。
	INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"

	// 无效的可用区。
	INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

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

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

	// 内核版本不支持。
	UNSUPPORTEDOPERATION_KERNELVERSIONNOTSUPPORT = "UnsupportedOperation.KernelVersionNotSupport"

	// 当前版本不支持该操作。
	UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"
)
View Source
const APIVersion = "2019-07-25"

Variables

This section is empty.

Functions

This section is empty.

Types

type AddNodeList added in v1.0.827

type AddNodeList struct {
	// 需要删除的节点角色。
	// - SECONDARY:Mongod 节点。
	// - READONLY:只读节点。
	// - MONGOS:Mongos 节点。
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 节点所对应的可用区。
	// - 单可用区,所有节点在同一可用区。
	// - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置新增节点对应的可用区,且新增后必须满足任意2个可用区节点数大于第3个可用区原则。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`
}

type AssignProjectRequest

type AssignProjectRequest struct {
	*tchttp.BaseRequest

	// 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 项目ID,用户已创建项目的唯一ID,非自定义
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`
}

func NewAssignProjectRequest

func NewAssignProjectRequest() (request *AssignProjectRequest)

func (*AssignProjectRequest) FromJsonString

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

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

func (*AssignProjectRequest) ToJsonString

func (r *AssignProjectRequest) ToJsonString() string

type AssignProjectRequestParams added in v1.0.426

type AssignProjectRequestParams struct {
	// 实例ID列表,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 项目ID,用户已创建项目的唯一ID,非自定义
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`
}

Predefined struct for user

type AssignProjectResponse

type AssignProjectResponse struct {
	*tchttp.BaseResponse
	Response *AssignProjectResponseParams `json:"Response"`
}

func NewAssignProjectResponse

func NewAssignProjectResponse() (response *AssignProjectResponse)

func (*AssignProjectResponse) FromJsonString

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

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

func (*AssignProjectResponse) ToJsonString

func (r *AssignProjectResponse) ToJsonString() string

type AssignProjectResponseParams added in v1.0.426

type AssignProjectResponseParams struct {
	// 返回的异步任务ID列表
	FlowIds []*uint64 `json:"FlowIds,omitnil,omitempty" name:"FlowIds"`

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

Predefined struct for user

type Auth added in v1.0.324

type Auth struct {
	// 当前账号具有的权限信息。<ul><li>0:无权限。</li><li>1:只读。</li><li>2:只写。</li><li>3:读写。</li></ul>
	Mask *int64 `json:"Mask,omitnil,omitempty" name:"Mask"`

	// 指具有当前账号权限的数据库名。
	// <ul><li>* :表示所有数据库。</li><li>db.name:表示特定name的数据库。</li></ul>
	NameSpace *string `json:"NameSpace,omitnil,omitempty" name:"NameSpace"`
}

type BackupDownloadTask

type BackupDownloadTask struct {
	// 任务创建时间
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 备份文件名
	BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"`

	// 分片名称
	ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"`

	// 备份数据大小,单位为字节
	BackupSize *int64 `json:"BackupSize,omitnil,omitempty" name:"BackupSize"`

	// 任务状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 任务进度百分比
	Percent *int64 `json:"Percent,omitnil,omitempty" name:"Percent"`

	// 耗时,单位为秒
	TimeSpend *int64 `json:"TimeSpend,omitnil,omitempty" name:"TimeSpend"`

	// 备份数据下载链接
	Url *string `json:"Url,omitnil,omitempty" name:"Url"`

	// 备份文件备份类型,0-逻辑备份,1-物理备份
	BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"`

	// 发起备份时指定的备注信息
	// 注意:此字段可能返回 null,表示取不到有效值。
	BackupDesc *string `json:"BackupDesc,omitnil,omitempty" name:"BackupDesc"`
}

type BackupDownloadTaskStatus

type BackupDownloadTaskStatus struct {
	// 分片名
	ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"`

	// 任务当前状态。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`
}

type BackupInfo

type BackupInfo struct {
	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 备份方式,0-自动备份,1-手动备份
	BackupType *uint64 `json:"BackupType,omitnil,omitempty" name:"BackupType"`

	// 备份名称
	BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"`

	// 备份备注
	// 注意:此字段可能返回 null,表示取不到有效值。
	BackupDesc *string `json:"BackupDesc,omitnil,omitempty" name:"BackupDesc"`

	// 备份文件大小,单位KB
	// 注意:此字段可能返回 null,表示取不到有效值。
	BackupSize *uint64 `json:"BackupSize,omitnil,omitempty" name:"BackupSize"`

	// 备份开始时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 备份结束时间
	// 注意:此字段可能返回 null,表示取不到有效值。
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 备份状态,1-备份中,2-备份成功
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 备份方法,0-逻辑备份,1-物理备份
	BackupMethod *uint64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"`
}

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

func (c *Client) AssignProject(request *AssignProjectRequest) (response *AssignProjectResponse, err error)

AssignProject 本接口(AssignProject)用于指定云数据库实例的所属项目。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"

func (*Client) AssignProjectWithContext added in v1.0.324

func (c *Client) AssignProjectWithContext(ctx context.Context, request *AssignProjectRequest) (response *AssignProjectResponse, err error)

AssignProject 本接口(AssignProject)用于指定云数据库实例的所属项目。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"

func (*Client) CreateAccountUser added in v1.0.571

func (c *Client) CreateAccountUser(request *CreateAccountUserRequest) (response *CreateAccountUserResponse, err error)

CreateAccountUser 本接口(CreateAccountUser)用于自定义实例访问账号。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INTERNALERROR_PASSWORDERROR = "InternalError.PasswordError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"

func (*Client) CreateAccountUserWithContext added in v1.0.571

func (c *Client) CreateAccountUserWithContext(ctx context.Context, request *CreateAccountUserRequest) (response *CreateAccountUserResponse, err error)

CreateAccountUser 本接口(CreateAccountUser)用于自定义实例访问账号。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INTERNALERROR_PASSWORDERROR = "InternalError.PasswordError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"

func (*Client) CreateBackupDBInstance

func (c *Client) CreateBackupDBInstance(request *CreateBackupDBInstanceRequest) (response *CreateBackupDBInstanceResponse, err error)

CreateBackupDBInstance 本接口(CreateBackupDBInstance)用于备份实例。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"
INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) CreateBackupDBInstanceWithContext added in v1.0.324

func (c *Client) CreateBackupDBInstanceWithContext(ctx context.Context, request *CreateBackupDBInstanceRequest) (response *CreateBackupDBInstanceResponse, err error)

CreateBackupDBInstance 本接口(CreateBackupDBInstance)用于备份实例。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"
INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) CreateBackupDownloadTask

func (c *Client) CreateBackupDownloadTask(request *CreateBackupDownloadTaskRequest) (response *CreateBackupDownloadTaskResponse, err error)

CreateBackupDownloadTask 本接口用来创建某个备份文件的下载任务

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) CreateBackupDownloadTaskWithContext added in v1.0.324

func (c *Client) CreateBackupDownloadTaskWithContext(ctx context.Context, request *CreateBackupDownloadTaskRequest) (response *CreateBackupDownloadTaskResponse, err error)

CreateBackupDownloadTask 本接口用来创建某个备份文件的下载任务

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) CreateDBInstance

func (c *Client) CreateDBInstance(request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)

CreateDBInstance 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SECONDARYNUMERROR = "InvalidParameterValue.SecondaryNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) CreateDBInstanceHour

func (c *Client) CreateDBInstanceHour(request *CreateDBInstanceHourRequest) (response *CreateDBInstanceHourResponse, err error)

CreateDBInstanceHour 本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CLUSTERTYPEERROR = "InvalidParameterValue.ClusterTypeError"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_POSTPAIDINSTANCEBEYONDLIMIT = "InvalidParameterValue.PostPaidInstanceBeyondLimit"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) CreateDBInstanceHourWithContext added in v1.0.324

func (c *Client) CreateDBInstanceHourWithContext(ctx context.Context, request *CreateDBInstanceHourRequest) (response *CreateDBInstanceHourResponse, err error)

CreateDBInstanceHour 本接口(CreateDBInstanceHour)用于创建按量计费的MongoDB云数据库实例。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CLUSTERTYPEERROR = "InvalidParameterValue.ClusterTypeError"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_POSTPAIDINSTANCEBEYONDLIMIT = "InvalidParameterValue.PostPaidInstanceBeyondLimit"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) CreateDBInstanceWithContext added in v1.0.324

func (c *Client) CreateDBInstanceWithContext(ctx context.Context, request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)

CreateDBInstance 本接口(CreateDBInstance)用于创建包年包月的MongoDB云数据库实例。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SECONDARYNUMERROR = "InvalidParameterValue.SecondaryNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) DeleteAccountUser added in v1.0.635

func (c *Client) DeleteAccountUser(request *DeleteAccountUserRequest) (response *DeleteAccountUserResponse, err error)

DeleteAccountUser 本接口(DeleteAccountUser)用于删除实例的自定义账号。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CLUSTERTYPEERROR = "InvalidParameterValue.ClusterTypeError"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_POSTPAIDINSTANCEBEYONDLIMIT = "InvalidParameterValue.PostPaidInstanceBeyondLimit"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) DeleteAccountUserWithContext added in v1.0.635

func (c *Client) DeleteAccountUserWithContext(ctx context.Context, request *DeleteAccountUserRequest) (response *DeleteAccountUserResponse, err error)

DeleteAccountUser 本接口(DeleteAccountUser)用于删除实例的自定义账号。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CLUSTERTYPEERROR = "InvalidParameterValue.ClusterTypeError"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_POSTPAIDINSTANCEBEYONDLIMIT = "InvalidParameterValue.PostPaidInstanceBeyondLimit"
INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) DescribeAccountUsers added in v1.0.501

func (c *Client) DescribeAccountUsers(request *DescribeAccountUsersRequest) (response *DescribeAccountUsersResponse, err error)

DescribeAccountUsers 本接口(DescribeAccountUsers)用于获取当前实例的全部账号。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

func (*Client) DescribeAccountUsersWithContext added in v1.0.501

func (c *Client) DescribeAccountUsersWithContext(ctx context.Context, request *DescribeAccountUsersRequest) (response *DescribeAccountUsersResponse, err error)

DescribeAccountUsers 本接口(DescribeAccountUsers)用于获取当前实例的全部账号。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

func (*Client) DescribeAsyncRequestInfo

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

DescribeAsyncRequestInfo 查询异步任务状态接口

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) DescribeAsyncRequestInfoWithContext added in v1.0.324

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

DescribeAsyncRequestInfo 查询异步任务状态接口

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) DescribeBackupDownloadTask

func (c *Client) DescribeBackupDownloadTask(request *DescribeBackupDownloadTaskRequest) (response *DescribeBackupDownloadTaskResponse, err error)

DescribeBackupDownloadTask 查询备份下载任务信息

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeBackupDownloadTaskWithContext added in v1.0.324

func (c *Client) DescribeBackupDownloadTaskWithContext(ctx context.Context, request *DescribeBackupDownloadTaskRequest) (response *DescribeBackupDownloadTaskResponse, err error)

DescribeBackupDownloadTask 查询备份下载任务信息

可能返回的错误码:

AUTHFAILURE = "AuthFailure"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeClientConnections

func (c *Client) DescribeClientConnections(request *DescribeClientConnectionsRequest) (response *DescribeClientConnectionsResponse, err error)

DescribeClientConnections 本接口(DescribeClientConnections)用于查询实例客户端连接信息,包括连接 IP 和连接数量。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_MONGOVERSIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.MongoVersionNotSupportQueryClient"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PROXYNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.ProxyNotSupportQueryClient"
INVALIDPARAMETERVALUE_REGIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.RegionNotSupportQueryClient"

func (*Client) DescribeClientConnectionsWithContext added in v1.0.324

func (c *Client) DescribeClientConnectionsWithContext(ctx context.Context, request *DescribeClientConnectionsRequest) (response *DescribeClientConnectionsResponse, err error)

DescribeClientConnections 本接口(DescribeClientConnections)用于查询实例客户端连接信息,包括连接 IP 和连接数量。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_MONGOVERSIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.MongoVersionNotSupportQueryClient"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PROXYNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.ProxyNotSupportQueryClient"
INVALIDPARAMETERVALUE_REGIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.RegionNotSupportQueryClient"

func (*Client) DescribeCurrentOp

func (c *Client) DescribeCurrentOp(request *DescribeCurrentOpRequest) (response *DescribeCurrentOpResponse, err error)

DescribeCurrentOp 本接口(DescribeCurrentOp)用于查询MongoDB云数据库实例的当前正在执行的操作。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_QUERYOUTOFRANGE = "InvalidParameterValue.QueryOutOfRange"
INVALIDPARAMETERVALUE_REGIONNOTSUPPORTOPERATION = "InvalidParameterValue.RegionNotSupportOperation"
INVALIDPARAMETERVALUE_REPLICANOTFOUND = "InvalidParameterValue.ReplicaNotFound"

func (*Client) DescribeCurrentOpWithContext added in v1.0.324

func (c *Client) DescribeCurrentOpWithContext(ctx context.Context, request *DescribeCurrentOpRequest) (response *DescribeCurrentOpResponse, err error)

DescribeCurrentOp 本接口(DescribeCurrentOp)用于查询MongoDB云数据库实例的当前正在执行的操作。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_QUERYOUTOFRANGE = "InvalidParameterValue.QueryOutOfRange"
INVALIDPARAMETERVALUE_REGIONNOTSUPPORTOPERATION = "InvalidParameterValue.RegionNotSupportOperation"
INVALIDPARAMETERVALUE_REPLICANOTFOUND = "InvalidParameterValue.ReplicaNotFound"

func (*Client) DescribeDBBackups

func (c *Client) DescribeDBBackups(request *DescribeDBBackupsRequest) (response *DescribeDBBackupsResponse, err error)

DescribeDBBackups 本接口(DescribeDBBackups)用于查询实例备份列表,目前只支持查询7天内的备份记录。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeDBBackupsWithContext added in v1.0.324

func (c *Client) DescribeDBBackupsWithContext(ctx context.Context, request *DescribeDBBackupsRequest) (response *DescribeDBBackupsResponse, err error)

DescribeDBBackups 本接口(DescribeDBBackups)用于查询实例备份列表,目前只支持查询7天内的备份记录。

可能返回的错误码:

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeDBInstanceDeal

func (c *Client) DescribeDBInstanceDeal(request *DescribeDBInstanceDealRequest) (response *DescribeDBInstanceDealResponse, err error)

DescribeDBInstanceDeal 本接口(DescribeDBInstanceDeal)用于获取MongoDB购买、续费及变配订单详细。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

func (*Client) DescribeDBInstanceDealWithContext added in v1.0.324

func (c *Client) DescribeDBInstanceDealWithContext(ctx context.Context, request *DescribeDBInstanceDealRequest) (response *DescribeDBInstanceDealResponse, err error)

DescribeDBInstanceDeal 本接口(DescribeDBInstanceDeal)用于获取MongoDB购买、续费及变配订单详细。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

func (*Client) DescribeDBInstanceNodeProperty added in v1.0.525

func (c *Client) DescribeDBInstanceNodeProperty(request *DescribeDBInstanceNodePropertyRequest) (response *DescribeDBInstanceNodePropertyResponse, err error)

DescribeDBInstanceNodeProperty 本接口用于查询节点的属性,包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。

可能返回的错误码:

FAILEDOPERATION_KERNELRESPONSETIMEOUT = "FailedOperation.KernelResponseTimeout"
INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

func (*Client) DescribeDBInstanceNodePropertyWithContext added in v1.0.525

func (c *Client) DescribeDBInstanceNodePropertyWithContext(ctx context.Context, request *DescribeDBInstanceNodePropertyRequest) (response *DescribeDBInstanceNodePropertyResponse, err error)

DescribeDBInstanceNodeProperty 本接口用于查询节点的属性,包括节点所在可用区、节点名称、地址、角色、状态、主从延迟、优先级、投票权、标签等属性。

可能返回的错误码:

FAILEDOPERATION_KERNELRESPONSETIMEOUT = "FailedOperation.KernelResponseTimeout"
INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

func (*Client) DescribeDBInstances

func (c *Client) DescribeDBInstances(request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)

DescribeDBInstances 本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeDBInstancesWithContext added in v1.0.324

func (c *Client) DescribeDBInstancesWithContext(ctx context.Context, request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)

DescribeDBInstances 本接口(DescribeDBInstances)用于查询云数据库实例列表,支持通过项目ID、实例ID、实例状态等过滤条件来筛选主实例、灾备实例和只读实例信息列表。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeInstanceParams added in v1.0.312

func (c *Client) DescribeInstanceParams(request *DescribeInstanceParamsRequest) (response *DescribeInstanceParamsResponse, err error)

DescribeInstanceParams 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CURRENTINSTANCENOTSUPPORTMODIFYPARAMS = "InvalidParameter.CurrentInstanceNotSupportModifyParams"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeInstanceParamsWithContext added in v1.0.324

func (c *Client) DescribeInstanceParamsWithContext(ctx context.Context, request *DescribeInstanceParamsRequest) (response *DescribeInstanceParamsResponse, err error)

DescribeInstanceParams 本接口(DescribeInstanceParams)用于查询当前实例可修改的参数列表。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_CURRENTINSTANCENOTSUPPORTMODIFYPARAMS = "InvalidParameter.CurrentInstanceNotSupportModifyParams"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) DescribeSecurityGroup

func (c *Client) DescribeSecurityGroup(request *DescribeSecurityGroupRequest) (response *DescribeSecurityGroupResponse, err error)

DescribeSecurityGroup 本接口(DescribeSecurityGroup)用于查询实例绑定的安全组。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeSecurityGroupWithContext added in v1.0.324

func (c *Client) DescribeSecurityGroupWithContext(ctx context.Context, request *DescribeSecurityGroupRequest) (response *DescribeSecurityGroupResponse, err error)

DescribeSecurityGroup 本接口(DescribeSecurityGroup)用于查询实例绑定的安全组。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeSlowLogPatterns

func (c *Client) DescribeSlowLogPatterns(request *DescribeSlowLogPatternsRequest) (response *DescribeSlowLogPatternsResponse, err error)

DescribeSlowLogPatterns 本接口(DescribeSlowLogPatterns)用于获取数据库实例慢日志的统计信息。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_QUERYTIMEOUTOFRANGE = "InvalidParameterValue.QueryTimeOutOfRange"
INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit"
INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit"
INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime"

func (*Client) DescribeSlowLogPatternsWithContext added in v1.0.324

func (c *Client) DescribeSlowLogPatternsWithContext(ctx context.Context, request *DescribeSlowLogPatternsRequest) (response *DescribeSlowLogPatternsResponse, err error)

DescribeSlowLogPatterns 本接口(DescribeSlowLogPatterns)用于获取数据库实例慢日志的统计信息。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_QUERYTIMEOUTOFRANGE = "InvalidParameterValue.QueryTimeOutOfRange"
INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit"
INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit"
INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime"

func (*Client) DescribeSlowLogs

func (c *Client) DescribeSlowLogs(request *DescribeSlowLogsRequest) (response *DescribeSlowLogsResponse, err error)

DescribeSlowLogs 本接口(DescribeSlowLogs)用于获取云数据库慢日志信息。接口只支持查询最近7天内慢日志。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_QUERYTIMEOUTOFRANGE = "InvalidParameterValue.QueryTimeOutOfRange"
INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit"
INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit"
INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime"

func (*Client) DescribeSlowLogsWithContext added in v1.0.324

func (c *Client) DescribeSlowLogsWithContext(ctx context.Context, request *DescribeSlowLogsRequest) (response *DescribeSlowLogsResponse, err error)

DescribeSlowLogs 本接口(DescribeSlowLogs)用于获取云数据库慢日志信息。接口只支持查询最近7天内慢日志。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_QUERYTIMEOUTOFRANGE = "InvalidParameterValue.QueryTimeOutOfRange"
INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit"
INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit"
INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime"

func (*Client) DescribeSpecInfo

func (c *Client) DescribeSpecInfo(request *DescribeSpecInfoRequest) (response *DescribeSpecInfoResponse, err error)

DescribeSpecInfo 本接口(DescribeSpecInfo)用于查询实例的售卖规格。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

func (*Client) DescribeSpecInfoWithContext added in v1.0.324

func (c *Client) DescribeSpecInfoWithContext(ctx context.Context, request *DescribeSpecInfoRequest) (response *DescribeSpecInfoResponse, err error)

DescribeSpecInfo 本接口(DescribeSpecInfo)用于查询实例的售卖规格。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

func (*Client) FlashBackDBInstance added in v1.0.895

func (c *Client) FlashBackDBInstance(request *FlashBackDBInstanceRequest) (response *FlashBackDBInstanceResponse, err error)

FlashBackDBInstance 该接口用于发起按 Key 闪回任务,依据数据的闪回 Key(默认为 id)对数据进行极速回档,快速恢复业务。

**说明:按 Key 闪回于2023年09月11日正式进行公测,在此期间,该接口仅对公测用户开放。**

可能返回的错误码:

FAILEDOPERATION_FLASHBACKBYKEYNOTOPEN = "FailedOperation.FlashbackByKeyNotOpen"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMETERSNIL = "InvalidParameter.ParametersNil"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
UNSUPPORTEDOPERATION_KERNELVERSIONNOTSUPPORT = "UnsupportedOperation.KernelVersionNotSupport"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) FlashBackDBInstanceWithContext added in v1.0.895

func (c *Client) FlashBackDBInstanceWithContext(ctx context.Context, request *FlashBackDBInstanceRequest) (response *FlashBackDBInstanceResponse, err error)

FlashBackDBInstance 该接口用于发起按 Key 闪回任务,依据数据的闪回 Key(默认为 id)对数据进行极速回档,快速恢复业务。

**说明:按 Key 闪回于2023年09月11日正式进行公测,在此期间,该接口仅对公测用户开放。**

可能返回的错误码:

FAILEDOPERATION_FLASHBACKBYKEYNOTOPEN = "FailedOperation.FlashbackByKeyNotOpen"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PARAMETERSNIL = "InvalidParameter.ParametersNil"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
UNSUPPORTEDOPERATION_KERNELVERSIONNOTSUPPORT = "UnsupportedOperation.KernelVersionNotSupport"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) FlushInstanceRouterConfig

func (c *Client) FlushInstanceRouterConfig(request *FlushInstanceRouterConfigRequest) (response *FlushInstanceRouterConfigResponse, err error)

FlushInstanceRouterConfig 在所有mongos上执行FlushRouterConfig命令

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) FlushInstanceRouterConfigWithContext added in v1.0.324

func (c *Client) FlushInstanceRouterConfigWithContext(ctx context.Context, request *FlushInstanceRouterConfigRequest) (response *FlushInstanceRouterConfigResponse, err error)

FlushInstanceRouterConfig 在所有mongos上执行FlushRouterConfig命令

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) InquirePriceCreateDBInstances

func (c *Client) InquirePriceCreateDBInstances(request *InquirePriceCreateDBInstancesRequest) (response *InquirePriceCreateDBInstancesResponse, err error)

InquirePriceCreateDBInstances 本接口(InquirePriceCreateDBInstances)用于创建数据库实例询价。本接口参数中必须传入region参数,否则无法通过校验。本接口仅允许针对购买限制范围内的实例配置进行询价。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

func (*Client) InquirePriceCreateDBInstancesWithContext added in v1.0.324

func (c *Client) InquirePriceCreateDBInstancesWithContext(ctx context.Context, request *InquirePriceCreateDBInstancesRequest) (response *InquirePriceCreateDBInstancesResponse, err error)

InquirePriceCreateDBInstances 本接口(InquirePriceCreateDBInstances)用于创建数据库实例询价。本接口参数中必须传入region参数,否则无法通过校验。本接口仅允许针对购买限制范围内的实例配置进行询价。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"
INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

func (*Client) InquirePriceModifyDBInstanceSpec

func (c *Client) InquirePriceModifyDBInstanceSpec(request *InquirePriceModifyDBInstanceSpecRequest) (response *InquirePriceModifyDBInstanceSpecResponse, err error)

InquirePriceModifyDBInstanceSpec 本接口 (InquirePriceModifyDBInstanceSpec) 用于查询实例配置变更后的价格。

可能返回的错误码:

INTERNALERROR_FINDINSTANCEFAILED = "InternalError.FindInstanceFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"

func (*Client) InquirePriceModifyDBInstanceSpecWithContext added in v1.0.324

func (c *Client) InquirePriceModifyDBInstanceSpecWithContext(ctx context.Context, request *InquirePriceModifyDBInstanceSpecRequest) (response *InquirePriceModifyDBInstanceSpecResponse, err error)

InquirePriceModifyDBInstanceSpec 本接口 (InquirePriceModifyDBInstanceSpec) 用于查询实例配置变更后的价格。

可能返回的错误码:

INTERNALERROR_FINDINSTANCEFAILED = "InternalError.FindInstanceFailed"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"

func (*Client) InquirePriceRenewDBInstances

func (c *Client) InquirePriceRenewDBInstances(request *InquirePriceRenewDBInstancesRequest) (response *InquirePriceRenewDBInstancesResponse, err error)

InquirePriceRenewDBInstances 本接口 (InquiryPriceRenewDBInstances) 用于续费包年包月实例询价。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_FINDINSTANCEFAILED = "InternalError.FindInstanceFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"

func (*Client) InquirePriceRenewDBInstancesWithContext added in v1.0.324

func (c *Client) InquirePriceRenewDBInstancesWithContext(ctx context.Context, request *InquirePriceRenewDBInstancesRequest) (response *InquirePriceRenewDBInstancesResponse, err error)

InquirePriceRenewDBInstances 本接口 (InquiryPriceRenewDBInstances) 用于续费包年包月实例询价。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_FINDINSTANCEFAILED = "InternalError.FindInstanceFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"

func (*Client) IsolateDBInstance

func (c *Client) IsolateDBInstance(request *IsolateDBInstanceRequest) (response *IsolateDBInstanceResponse, err error)

IsolateDBInstance 本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复,请谨慎操作。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"
INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PREPAIDINSTANCEUNABLETOISOLATE = "InvalidParameterValue.PrePaidInstanceUnableToIsolate"

func (*Client) IsolateDBInstanceWithContext added in v1.0.324

func (c *Client) IsolateDBInstanceWithContext(ctx context.Context, request *IsolateDBInstanceRequest) (response *IsolateDBInstanceResponse, err error)

IsolateDBInstance 本接口(IsolateDBInstance)用于隔离MongoDB云数据库按量计费实例。隔离后实例保留在回收站中,不能再写入数据。隔离一定时间后,实例会彻底删除,回收站保存时间请参考按量计费的服务条款。在隔离中的按量计费实例无法恢复,请谨慎操作。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"
INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PREPAIDINSTANCEUNABLETOISOLATE = "InvalidParameterValue.PrePaidInstanceUnableToIsolate"

func (*Client) KillOps

func (c *Client) KillOps(request *KillOpsRequest) (response *KillOpsResponse, err error)

KillOps 本接口(KillOps)用于终止MongoDB云数据库实例上执行的特定操作。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETERVALUE_NODENOTFOUNDINREPLICA = "InvalidParameterValue.NodeNotFoundInReplica"

func (*Client) KillOpsWithContext added in v1.0.324

func (c *Client) KillOpsWithContext(ctx context.Context, request *KillOpsRequest) (response *KillOpsResponse, err error)

KillOps 本接口(KillOps)用于终止MongoDB云数据库实例上执行的特定操作。

可能返回的错误码:

FAILEDOPERATION = "FailedOperation"
INVALIDPARAMETERVALUE_NODENOTFOUNDINREPLICA = "InvalidParameterValue.NodeNotFoundInReplica"

func (*Client) ModifyDBInstanceNetworkAddress added in v1.0.378

func (c *Client) ModifyDBInstanceNetworkAddress(request *ModifyDBInstanceNetworkAddressRequest) (response *ModifyDBInstanceNetworkAddressResponse, err error)

ModifyDBInstanceNetworkAddress 本接口(ModifyDBInstanceNetworkAddress)用于修改云数据库实例的网络信息,支持基础网络切换为私有网络、私有网络切换私有网络。

可能返回的错误码:

FAILEDOPERATION_NOTALLOWMODIFYADDRAFTEROPENWANSERVICE = "FailedOperation.NotAllowModifyAddrAfterOpenWanService"
INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDVIP = "InvalidParameter.InvalidVip"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"

func (*Client) ModifyDBInstanceNetworkAddressWithContext added in v1.0.378

func (c *Client) ModifyDBInstanceNetworkAddressWithContext(ctx context.Context, request *ModifyDBInstanceNetworkAddressRequest) (response *ModifyDBInstanceNetworkAddressResponse, err error)

ModifyDBInstanceNetworkAddress 本接口(ModifyDBInstanceNetworkAddress)用于修改云数据库实例的网络信息,支持基础网络切换为私有网络、私有网络切换私有网络。

可能返回的错误码:

FAILEDOPERATION_NOTALLOWMODIFYADDRAFTEROPENWANSERVICE = "FailedOperation.NotAllowModifyAddrAfterOpenWanService"
INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INVALIDVIP = "InvalidParameter.InvalidVip"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"

func (*Client) ModifyDBInstanceSecurityGroup added in v1.0.359

func (c *Client) ModifyDBInstanceSecurityGroup(request *ModifyDBInstanceSecurityGroupRequest) (response *ModifyDBInstanceSecurityGroupResponse, err error)

ModifyDBInstanceSecurityGroup 本接口(ModifyDBInstanceSecurityGroup)用于修改实例绑定的安全组

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_SECURITYGROUPID = "InvalidParameterValue.SecurityGroupId"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) ModifyDBInstanceSecurityGroupWithContext added in v1.0.359

func (c *Client) ModifyDBInstanceSecurityGroupWithContext(ctx context.Context, request *ModifyDBInstanceSecurityGroupRequest) (response *ModifyDBInstanceSecurityGroupResponse, err error)

ModifyDBInstanceSecurityGroup 本接口(ModifyDBInstanceSecurityGroup)用于修改实例绑定的安全组

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_SECURITYGROUPID = "InvalidParameterValue.SecurityGroupId"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) ModifyDBInstanceSpec

func (c *Client) ModifyDBInstanceSpec(request *ModifyDBInstanceSpecRequest) (response *ModifyDBInstanceSpecResponse, err error)

ModifyDBInstanceSpec 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETER_ZONECLOSED = "InvalidParameter.ZoneClosed"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MODIFYMODEERROR = "InvalidParameterValue.ModifyModeError"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_OPLOGSIZEOUTOFRANGE = "InvalidParameterValue.OplogSizeOutOfRange"
INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) ModifyDBInstanceSpecWithContext added in v1.0.324

func (c *Client) ModifyDBInstanceSpecWithContext(ctx context.Context, request *ModifyDBInstanceSpecRequest) (response *ModifyDBInstanceSpecResponse, err error)

ModifyDBInstanceSpec 本接口(ModifyDBInstanceSpec)用于调整MongoDB云数据库实例配置。接口支持的售卖规格,可从查询云数据库的售卖规格(DescribeSpecInfo)获取。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETER_ZONECLOSED = "InvalidParameter.ZoneClosed"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_MODIFYMODEERROR = "InvalidParameterValue.ModifyModeError"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_OPLOGSIZEOUTOFRANGE = "InvalidParameterValue.OplogSizeOutOfRange"
INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) OfflineIsolatedDBInstance

func (c *Client) OfflineIsolatedDBInstance(request *OfflineIsolatedDBInstanceRequest) (response *OfflineIsolatedDBInstanceResponse, err error)

OfflineIsolatedDBInstance 本接口(OfflineIsolatedDBInstance)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALSTATUSTOOFFLINE = "InvalidParameterValue.IllegalStatusToOffline"
INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) OfflineIsolatedDBInstanceWithContext added in v1.0.324

func (c *Client) OfflineIsolatedDBInstanceWithContext(ctx context.Context, request *OfflineIsolatedDBInstanceRequest) (response *OfflineIsolatedDBInstanceResponse, err error)

OfflineIsolatedDBInstance 本接口(OfflineIsolatedDBInstance)用于立即下线隔离状态的云数据库实例。进行操作的实例状态必须为隔离状态。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALSTATUSTOOFFLINE = "InvalidParameterValue.IllegalStatusToOffline"
INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) RenameInstance

func (c *Client) RenameInstance(request *RenameInstanceRequest) (response *RenameInstanceResponse, err error)

RenameInstance 本接口(RenameInstance)用于修改云数据库实例的名称。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName"
INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"
INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) RenameInstanceWithContext added in v1.0.324

func (c *Client) RenameInstanceWithContext(ctx context.Context, request *RenameInstanceRequest) (response *RenameInstanceResponse, err error)

RenameInstance 本接口(RenameInstance)用于修改云数据库实例的名称。

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName"
INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"
INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) RenewDBInstances

func (c *Client) RenewDBInstances(request *RenewDBInstancesRequest) (response *RenewDBInstancesResponse, err error)

RenewDBInstances 本接口(RenewDBInstance)用于续费云数据库实例,仅支持付费模式为包年包月的实例。按量计费实例不需要续费。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) RenewDBInstancesWithContext added in v1.0.324

func (c *Client) RenewDBInstancesWithContext(ctx context.Context, request *RenewDBInstancesRequest) (response *RenewDBInstancesResponse, err error)

RenewDBInstances 本接口(RenewDBInstance)用于续费云数据库实例,仅支持付费模式为包年包月的实例。按量计费实例不需要续费。

可能返回的错误码:

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) ResetDBInstancePassword

func (c *Client) ResetDBInstancePassword(request *ResetDBInstancePasswordRequest) (response *ResetDBInstancePasswordResponse, err error)

ResetDBInstancePassword 修改实例用户的密码

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_USERNOTFOUND = "InvalidParameterValue.UserNotFound"

func (*Client) ResetDBInstancePasswordWithContext added in v1.0.324

func (c *Client) ResetDBInstancePasswordWithContext(ctx context.Context, request *ResetDBInstancePasswordRequest) (response *ResetDBInstancePasswordResponse, err error)

ResetDBInstancePassword 修改实例用户的密码

可能返回的错误码:

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"
INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
INVALIDPARAMETERVALUE_USERNOTFOUND = "InvalidParameterValue.UserNotFound"

func (*Client) SetAccountUserPrivilege added in v1.0.324

func (c *Client) SetAccountUserPrivilege(request *SetAccountUserPrivilegeRequest) (response *SetAccountUserPrivilegeResponse, err error)

SetAccountUserPrivilege 本接口(SetAccountUserPrivilege)用于设置实例的账号权限。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) SetAccountUserPrivilegeWithContext added in v1.0.324

func (c *Client) SetAccountUserPrivilegeWithContext(ctx context.Context, request *SetAccountUserPrivilegeRequest) (response *SetAccountUserPrivilegeResponse, err error)

SetAccountUserPrivilege 本接口(SetAccountUserPrivilege)用于设置实例的账号权限。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) SetInstanceMaintenance added in v1.0.874

func (c *Client) SetInstanceMaintenance(request *SetInstanceMaintenanceRequest) (response *SetInstanceMaintenanceResponse, err error)

SetInstanceMaintenance 本接口(SetInstanceMaintenance ) 用于设置实例维护时间窗。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) SetInstanceMaintenanceWithContext added in v1.0.874

func (c *Client) SetInstanceMaintenanceWithContext(ctx context.Context, request *SetInstanceMaintenanceRequest) (response *SetInstanceMaintenanceResponse, err error)

SetInstanceMaintenance 本接口(SetInstanceMaintenance ) 用于设置实例维护时间窗。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) TerminateDBInstances added in v1.0.474

func (c *Client) TerminateDBInstances(request *TerminateDBInstancesRequest) (response *TerminateDBInstancesResponse, err error)

TerminateDBInstances 本接口(TerminateDBInstances)可将包年包月实例退还隔离。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"
INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

func (*Client) TerminateDBInstancesWithContext added in v1.0.474

func (c *Client) TerminateDBInstancesWithContext(ctx context.Context, request *TerminateDBInstancesRequest) (response *TerminateDBInstancesResponse, err error)

TerminateDBInstances 本接口(TerminateDBInstances)可将包年包月实例退还隔离。

可能返回的错误码:

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"
INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

type ClientConnection

type ClientConnection struct {
	// 连接的客户端IP
	IP *string `json:"IP,omitnil,omitempty" name:"IP"`

	// 对应客户端IP的连接数
	Count *uint64 `json:"Count,omitnil,omitempty" name:"Count"`

	// 是否为内部ip
	InternalService *bool `json:"InternalService,omitnil,omitempty" name:"InternalService"`
}

type CreateAccountUserRequest added in v1.0.571

type CreateAccountUserRequest struct {
	*tchttp.BaseRequest

	// 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 新账号名称。其格式要求如下:<ul><li>字符范围[1,32]。</li><li>可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。</li></ul>
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 新账号密码。密码复杂度要求如下:<ul><li>字符长度范围[8,32]。</li><li>至少包含字母、数字和特殊字符(叹号“!”、at"@"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。</li></ul>
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// mongouser 账号对应的密码。mongouser 为系统默认账号,即为创建实例时,设置的密码。
	MongoUserPassword *string `json:"MongoUserPassword,omitnil,omitempty" name:"MongoUserPassword"`

	// 账号备注信息。
	UserDesc *string `json:"UserDesc,omitnil,omitempty" name:"UserDesc"`

	// 账号的读写权限信息。
	AuthRole []*Auth `json:"AuthRole,omitnil,omitempty" name:"AuthRole"`
}

func NewCreateAccountUserRequest added in v1.0.571

func NewCreateAccountUserRequest() (request *CreateAccountUserRequest)

func (*CreateAccountUserRequest) FromJsonString added in v1.0.571

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

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

func (*CreateAccountUserRequest) ToJsonString added in v1.0.571

func (r *CreateAccountUserRequest) ToJsonString() string

type CreateAccountUserRequestParams added in v1.0.571

type CreateAccountUserRequestParams struct {
	// 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 新账号名称。其格式要求如下:<ul><li>字符范围[1,32]。</li><li>可输入[A,Z]、[a,z]、[1,9]范围的字符以及下划线“_”与短划线“-”。</li></ul>
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 新账号密码。密码复杂度要求如下:<ul><li>字符长度范围[8,32]。</li><li>至少包含字母、数字和特殊字符(叹号“!”、at"@"、井号“#”、百分号“%”、插入符“^”、星号“*”、小括号“()”、下划线“_”)中的两种。</li></ul>
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// mongouser 账号对应的密码。mongouser 为系统默认账号,即为创建实例时,设置的密码。
	MongoUserPassword *string `json:"MongoUserPassword,omitnil,omitempty" name:"MongoUserPassword"`

	// 账号备注信息。
	UserDesc *string `json:"UserDesc,omitnil,omitempty" name:"UserDesc"`

	// 账号的读写权限信息。
	AuthRole []*Auth `json:"AuthRole,omitnil,omitempty" name:"AuthRole"`
}

Predefined struct for user

type CreateAccountUserResponse added in v1.0.571

type CreateAccountUserResponse struct {
	*tchttp.BaseResponse
	Response *CreateAccountUserResponseParams `json:"Response"`
}

func NewCreateAccountUserResponse added in v1.0.571

func NewCreateAccountUserResponse() (response *CreateAccountUserResponse)

func (*CreateAccountUserResponse) FromJsonString added in v1.0.571

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

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

func (*CreateAccountUserResponse) ToJsonString added in v1.0.571

func (r *CreateAccountUserResponse) ToJsonString() string

type CreateAccountUserResponseParams added in v1.0.571

type CreateAccountUserResponseParams struct {
	// 创建任务ID。
	FlowId *uint64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

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

Predefined struct for user

type CreateBackupDBInstanceRequest

type CreateBackupDBInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 设置备份方式。
	// - 0:逻辑备份。
	// - 1:物理备份。
	BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"`

	// 备份备注信息。
	BackupRemark *string `json:"BackupRemark,omitnil,omitempty" name:"BackupRemark"`
}

func NewCreateBackupDBInstanceRequest

func NewCreateBackupDBInstanceRequest() (request *CreateBackupDBInstanceRequest)

func (*CreateBackupDBInstanceRequest) FromJsonString

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

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

func (*CreateBackupDBInstanceRequest) ToJsonString

func (r *CreateBackupDBInstanceRequest) ToJsonString() string

type CreateBackupDBInstanceRequestParams added in v1.0.426

type CreateBackupDBInstanceRequestParams struct {
	// 实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 设置备份方式。
	// - 0:逻辑备份。
	// - 1:物理备份。
	BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"`

	// 备份备注信息。
	BackupRemark *string `json:"BackupRemark,omitnil,omitempty" name:"BackupRemark"`
}

Predefined struct for user

type CreateBackupDBInstanceResponse

type CreateBackupDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *CreateBackupDBInstanceResponseParams `json:"Response"`
}

func NewCreateBackupDBInstanceResponse

func NewCreateBackupDBInstanceResponse() (response *CreateBackupDBInstanceResponse)

func (*CreateBackupDBInstanceResponse) FromJsonString

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

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

func (*CreateBackupDBInstanceResponse) ToJsonString

func (r *CreateBackupDBInstanceResponse) ToJsonString() string

type CreateBackupDBInstanceResponseParams added in v1.0.426

type CreateBackupDBInstanceResponseParams struct {
	// 查询备份流程的状态。
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`

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

Predefined struct for user

type CreateBackupDownloadTaskRequest

type CreateBackupDownloadTaskRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 要下载的备份文件名,可通过DescribeDBBackups接口获取。
	BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"`

	// 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
	// 如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
	// 如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。
	BackupSets []*ReplicaSetInfo `json:"BackupSets,omitnil,omitempty" name:"BackupSets"`
}

func NewCreateBackupDownloadTaskRequest

func NewCreateBackupDownloadTaskRequest() (request *CreateBackupDownloadTaskRequest)

func (*CreateBackupDownloadTaskRequest) FromJsonString

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

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

func (*CreateBackupDownloadTaskRequest) ToJsonString

func (r *CreateBackupDownloadTaskRequest) ToJsonString() string

type CreateBackupDownloadTaskRequestParams added in v1.0.426

type CreateBackupDownloadTaskRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 要下载的备份文件名,可通过DescribeDBBackups接口获取。
	BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"`

	// 指定要下载的副本集的节点名称 或 分片集群的分片名称列表。
	// 如副本集cmgo-p8vnipr5,示例(固定取值):BackupSets.0=cmgo-p8vnipr5_0,可下载全量数据。
	// 如分片集群cmgo-p8vnipr5,示例:BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1,即下载分片0和分片1的数据,分片集群如需全量下载,请按示例方式传入全部分片名称。
	BackupSets []*ReplicaSetInfo `json:"BackupSets,omitnil,omitempty" name:"BackupSets"`
}

Predefined struct for user

type CreateBackupDownloadTaskResponse

type CreateBackupDownloadTaskResponse struct {
	*tchttp.BaseResponse
	Response *CreateBackupDownloadTaskResponseParams `json:"Response"`
}

func NewCreateBackupDownloadTaskResponse

func NewCreateBackupDownloadTaskResponse() (response *CreateBackupDownloadTaskResponse)

func (*CreateBackupDownloadTaskResponse) FromJsonString

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

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

func (*CreateBackupDownloadTaskResponse) ToJsonString

func (r *CreateBackupDownloadTaskResponse) ToJsonString() string

type CreateBackupDownloadTaskResponseParams added in v1.0.426

type CreateBackupDownloadTaskResponseParams struct {
	// 下载任务状态
	Tasks []*BackupDownloadTaskStatus `json:"Tasks,omitnil,omitempty" name:"Tasks"`

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

Predefined struct for user

type CreateDBInstanceHourRequest

type CreateDBInstanceHourRequest struct {
	*tchttp.BaseRequest

	// 实例内存大小,单位:GB。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例硬盘大小,单位:GB。
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 指副本集数量。
	// - 创建副本集实例,该参数只能为1。
	// - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
	// - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
	// - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
	// - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 机器类型。
	// - HIO:高IO型。
	// - HIO10G:高IO万兆。
	MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"`

	// 实例数量,最小值1,最大值为10。
	GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// 可用区信息,输入格式如:ap-guangzhou-2。
	// - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 实例架构类型。
	// - REPLSET:副本集。
	// - SHARD:分片集群。
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 私有网络ID。如果不设置该参数,则默认选择基础网络。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// 项目ID。若不设置该参数,则为默认项目。
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 实例标签信息。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 实例类型。
	// - 1:正式实例。
	// - 3:只读实例。
	// - 4:灾备实例。
	Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"`

	// 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
	Father *string `json:"Father,omitnil,omitempty" name:"Father"`

	// 安全组。
	SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"`

	// 克隆实例回档时间。
	// - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
	// - 回档时间范围:仅能回档7天内时间点的数据。
	RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"`

	// 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
	// - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
	// - 不支持4.2及以上版本。
	// - 不支持只读灾备实例。
	// - 不能选择基础网络。
	AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"`

	// Mongos CPU 核数。购买分片集群时,必须填写。
	MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"`

	// Mongos 内存大小。购买分片集群时,必须填写。
	//
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// Mongos 数量。购买分片集群时,必须填写。
	//
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"`

	// 只读节点数量,最大不超过7个。
	ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"`

	// 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
	ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"`

	// Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
	HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"`
}

func NewCreateDBInstanceHourRequest

func NewCreateDBInstanceHourRequest() (request *CreateDBInstanceHourRequest)

func (*CreateDBInstanceHourRequest) FromJsonString

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

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

func (*CreateDBInstanceHourRequest) ToJsonString

func (r *CreateDBInstanceHourRequest) ToJsonString() string

type CreateDBInstanceHourRequestParams added in v1.0.426

type CreateDBInstanceHourRequestParams struct {
	// 实例内存大小,单位:GB。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例硬盘大小,单位:GB。
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 指副本集数量。
	// - 创建副本集实例,该参数只能为1。
	// - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
	// - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
	// - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
	// - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 机器类型。
	// - HIO:高IO型。
	// - HIO10G:高IO万兆。
	MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"`

	// 实例数量,最小值1,最大值为10。
	GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// 可用区信息,输入格式如:ap-guangzhou-2。
	// - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 实例架构类型。
	// - REPLSET:副本集。
	// - SHARD:分片集群。
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 私有网络ID。如果不设置该参数,则默认选择基础网络。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// 项目ID。若不设置该参数,则为默认项目。
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 实例标签信息。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 实例类型。
	// - 1:正式实例。
	// - 3:只读实例。
	// - 4:灾备实例。
	Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"`

	// 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
	Father *string `json:"Father,omitnil,omitempty" name:"Father"`

	// 安全组。
	SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"`

	// 克隆实例回档时间。
	// - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
	// - 回档时间范围:仅能回档7天内时间点的数据。
	RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"`

	// 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
	// - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
	// - 不支持4.2及以上版本。
	// - 不支持只读灾备实例。
	// - 不能选择基础网络。
	AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"`

	// Mongos CPU 核数。购买分片集群时,必须填写。
	MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"`

	// Mongos 内存大小。购买分片集群时,必须填写。
	//
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// Mongos 数量。购买分片集群时,必须填写。
	//
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"`

	// 只读节点数量,最大不超过7个。
	ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"`

	// 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
	ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"`

	// Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
	HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"`
}

Predefined struct for user

type CreateDBInstanceHourResponse

type CreateDBInstanceHourResponse struct {
	*tchttp.BaseResponse
	Response *CreateDBInstanceHourResponseParams `json:"Response"`
}

func NewCreateDBInstanceHourResponse

func NewCreateDBInstanceHourResponse() (response *CreateDBInstanceHourResponse)

func (*CreateDBInstanceHourResponse) FromJsonString

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

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

func (*CreateDBInstanceHourResponse) ToJsonString

func (r *CreateDBInstanceHourResponse) ToJsonString() string

type CreateDBInstanceHourResponseParams added in v1.0.426

type CreateDBInstanceHourResponseParams struct {
	// 订单ID。
	DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"`

	// 创建的实例ID列表。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

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

Predefined struct for user

type CreateDBInstanceRequest

type CreateDBInstanceRequest struct {
	*tchttp.BaseRequest

	// 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例内存大小,单位:GB。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例硬盘大小,单位:GB。
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
	// - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
	// - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
	// - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 实例数量, 最小值1,最大值为10。
	GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// 可用区信息,输入格式如:ap-guangzhou-2。
	// - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
	Period *uint64 `json:"Period,omitnil,omitempty" name:"Period"`

	// 机器类型。
	// - HIO:高IO型。
	// - HIO10G:高IO万兆。
	MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"`

	// 实例架构类型。
	// - REPLSET:副本集。
	// - SHARD:分片集群。
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 指副本集数量。
	// - 创建副本集实例,该参数只能为1。
	// - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// 项目ID。若不设置该参数,则为默认项目。
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 私有网络ID。如果不设置该参数,则默认选择基础网络。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// 实例标签信息。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 自动续费标记。
	// - 0:不自动续费。默认为不自动续费。
	// - 1:自动续费。
	AutoRenewFlag *uint64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// 是否自动选择代金券。
	// - 1:是。
	// - 0:否。默认为0。
	AutoVoucher *uint64 `json:"AutoVoucher,omitnil,omitempty" name:"AutoVoucher"`

	// 实例类型。
	// - 1:正式实例。
	// - 3:只读实例。
	// - 4:灾备实例。
	Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"`

	// 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
	Father *string `json:"Father,omitnil,omitempty" name:"Father"`

	// 安全组。
	SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"`

	// 克隆实例回档时间。
	// - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
	// - 回档时间范围:仅能回档7天内时间点的数据。
	RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"`

	// 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
	// - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
	// - 不支持4.2及以上版本。
	// - 不支持只读灾备实例。
	// - 不能选择基础网络。
	AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"`

	// Mongos CPU 核数,购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"`

	// Mongos 内存大小。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// Mongos 数量。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。为了保障高可用,取值范围为[3,32]。
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"`

	// 只读节点数量,取值范围[0,5]。
	ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"`

	// 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
	ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"`

	// Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
	HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"`
}

func NewCreateDBInstanceRequest

func NewCreateDBInstanceRequest() (request *CreateDBInstanceRequest)

func (*CreateDBInstanceRequest) FromJsonString

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

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

func (*CreateDBInstanceRequest) ToJsonString

func (r *CreateDBInstanceRequest) ToJsonString() string

type CreateDBInstanceRequestParams added in v1.0.426

type CreateDBInstanceRequestParams struct {
	// 指每个副本集内节点个数。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例内存大小,单位:GB。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例硬盘大小,单位:GB。
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 指版本信息。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
	// - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
	// - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
	// - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 实例数量, 最小值1,最大值为10。
	GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// 可用区信息,输入格式如:ap-guangzhou-2。
	// - 具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	// - 该参数为主可用区,如果多可用区部署,Zone必须是AvailabilityZoneList中的一个。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 实例时长,单位:月,可选值包括 [1,2,3,4,5,6,7,8,9,10,11,12,24,36]。
	Period *uint64 `json:"Period,omitnil,omitempty" name:"Period"`

	// 机器类型。
	// - HIO:高IO型。
	// - HIO10G:高IO万兆。
	MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"`

	// 实例架构类型。
	// - REPLSET:副本集。
	// - SHARD:分片集群。
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 指副本集数量。
	// - 创建副本集实例,该参数只能为1。
	// - 创建分片实例,指分片的数量。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// 项目ID。若不设置该参数,则为默认项目。
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 私有网络ID。如果不设置该参数,则默认选择基础网络。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络下的子网 ID,如果配置参数 VpcId,则 SubnetId必须配置。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 实例密码。自定义密码长度为8-32个字符,至少包含字母、数字和字符(!@#%^*()_)中的两种。
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// 实例标签信息。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 自动续费标记。
	// - 0:不自动续费。默认为不自动续费。
	// - 1:自动续费。
	AutoRenewFlag *uint64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// 是否自动选择代金券。
	// - 1:是。
	// - 0:否。默认为0。
	AutoVoucher *uint64 `json:"AutoVoucher,omitnil,omitempty" name:"AutoVoucher"`

	// 实例类型。
	// - 1:正式实例。
	// - 3:只读实例。
	// - 4:灾备实例。
	Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"`

	// 父实例 ID。当参数**Clone**为3或者4时,即实例为只读或灾备实例时,该参数必须配置。
	Father *string `json:"Father,omitnil,omitempty" name:"Father"`

	// 安全组。
	SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"`

	// 克隆实例回档时间。
	// - 若为克隆实例,则必须配置该参数。输入格式示例:2021-08-13 16:30:00。
	// - 回档时间范围:仅能回档7天内时间点的数据。
	RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"`

	// 实例名称。仅支持长度为60个字符的中文、英文、数字、下划线_、分隔符- 。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 多可用区部署的节点列表。具体信息,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)获取。
	// - 多可用区部署节点只能部署在3个不同可用区。不支持将集群的大多数节点部署在同一个可用区。例如:3节点集群不支持2个节点部署在同一个区。
	// - 不支持4.2及以上版本。
	// - 不支持只读灾备实例。
	// - 不能选择基础网络。
	AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"`

	// Mongos CPU 核数,购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"`

	// Mongos 内存大小。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// Mongos 数量。购买MongoDB 4.2 及以上WiredTiger存储引擎版本的分片集群时,必须填写。具体售卖规格,请通过接口 [DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567) 获取。为了保障高可用,取值范围为[3,32]。
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"`

	// 只读节点数量,取值范围[0,5]。
	ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"`

	// 指只读节点所属可用区。跨可用区部署实例,参数**ReadonlyNodeNum**不为**0**时,必须配置该参数。
	ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"`

	// Hidden节点所属可用区。跨可用区部署实例,必须配置该参数。
	HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"`
}

Predefined struct for user

type CreateDBInstanceResponse

type CreateDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *CreateDBInstanceResponseParams `json:"Response"`
}

func NewCreateDBInstanceResponse

func NewCreateDBInstanceResponse() (response *CreateDBInstanceResponse)

func (*CreateDBInstanceResponse) FromJsonString

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

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

func (*CreateDBInstanceResponse) ToJsonString

func (r *CreateDBInstanceResponse) ToJsonString() string

type CreateDBInstanceResponseParams added in v1.0.426

type CreateDBInstanceResponseParams struct {
	// 订单ID
	DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"`

	// 创建的实例ID列表
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

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

Predefined struct for user

type CurrentOp

type CurrentOp struct {
	// 操作序号
	// 注意:此字段可能返回 null,表示取不到有效值。
	OpId *int64 `json:"OpId,omitnil,omitempty" name:"OpId"`

	// 操作所在的命名空间,形式如db.collection
	// 注意:此字段可能返回 null,表示取不到有效值。
	Ns *string `json:"Ns,omitnil,omitempty" name:"Ns"`

	// 操作执行语句
	// 注意:此字段可能返回 null,表示取不到有效值。
	Query *string `json:"Query,omitnil,omitempty" name:"Query"`

	// 操作类型,可能的取值:aggregate、count、delete、distinct、find、findAndModify、getMore、insert、mapReduce、update和command
	// 注意:此字段可能返回 null,表示取不到有效值。
	Op *string `json:"Op,omitnil,omitempty" name:"Op"`

	// 操作所在的分片名称
	ReplicaSetName *string `json:"ReplicaSetName,omitnil,omitempty" name:"ReplicaSetName"`

	// 筛选条件,节点状态,可能的取值为:Primary、Secondary
	// 注意:此字段可能返回 null,表示取不到有效值。
	State *string `json:"State,omitnil,omitempty" name:"State"`

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

	// 操作所在的节点名称
	NodeName *string `json:"NodeName,omitnil,omitempty" name:"NodeName"`

	// 操作已执行时间(ms)
	// 注意:此字段可能返回 null,表示取不到有效值。
	MicrosecsRunning *uint64 `json:"MicrosecsRunning,omitnil,omitempty" name:"MicrosecsRunning"`
}

type DBInstanceInfo

type DBInstanceInfo struct {
	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 地域信息
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`
}

type DBInstancePrice

type DBInstancePrice struct {
	// 单价
	// 注意:此字段可能返回 null,表示取不到有效值。
	UnitPrice *float64 `json:"UnitPrice,omitnil,omitempty" name:"UnitPrice"`

	// 原价
	OriginalPrice *float64 `json:"OriginalPrice,omitnil,omitempty" name:"OriginalPrice"`

	// 折扣价
	DiscountPrice *float64 `json:"DiscountPrice,omitnil,omitempty" name:"DiscountPrice"`
}

type DeleteAccountUserRequest added in v1.0.635

type DeleteAccountUserRequest struct {
	*tchttp.BaseRequest

	// 指定待删除账号的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 配置待删除的账号名。
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 配置 mongouser 对应的密码。mongouser为系统默认账号,输入其对应的密码。
	MongoUserPassword *string `json:"MongoUserPassword,omitnil,omitempty" name:"MongoUserPassword"`
}

func NewDeleteAccountUserRequest added in v1.0.635

func NewDeleteAccountUserRequest() (request *DeleteAccountUserRequest)

func (*DeleteAccountUserRequest) FromJsonString added in v1.0.635

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

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

func (*DeleteAccountUserRequest) ToJsonString added in v1.0.635

func (r *DeleteAccountUserRequest) ToJsonString() string

type DeleteAccountUserRequestParams added in v1.0.635

type DeleteAccountUserRequestParams struct {
	// 指定待删除账号的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 配置待删除的账号名。
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 配置 mongouser 对应的密码。mongouser为系统默认账号,输入其对应的密码。
	MongoUserPassword *string `json:"MongoUserPassword,omitnil,omitempty" name:"MongoUserPassword"`
}

Predefined struct for user

type DeleteAccountUserResponse added in v1.0.635

type DeleteAccountUserResponse struct {
	*tchttp.BaseResponse
	Response *DeleteAccountUserResponseParams `json:"Response"`
}

func NewDeleteAccountUserResponse added in v1.0.635

func NewDeleteAccountUserResponse() (response *DeleteAccountUserResponse)

func (*DeleteAccountUserResponse) FromJsonString added in v1.0.635

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

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

func (*DeleteAccountUserResponse) ToJsonString added in v1.0.635

func (r *DeleteAccountUserResponse) ToJsonString() string

type DeleteAccountUserResponseParams added in v1.0.635

type DeleteAccountUserResponseParams struct {
	// 账户删除任务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 DescribeAccountUsersRequest added in v1.0.501

type DescribeAccountUsersRequest struct {
	*tchttp.BaseRequest

	// 指定待获取账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeAccountUsersRequest added in v1.0.501

func NewDescribeAccountUsersRequest() (request *DescribeAccountUsersRequest)

func (*DescribeAccountUsersRequest) FromJsonString added in v1.0.501

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

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

func (*DescribeAccountUsersRequest) ToJsonString added in v1.0.501

func (r *DescribeAccountUsersRequest) ToJsonString() string

type DescribeAccountUsersRequestParams added in v1.0.501

type DescribeAccountUsersRequestParams struct {
	// 指定待获取账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeAccountUsersResponse added in v1.0.501

type DescribeAccountUsersResponse struct {
	*tchttp.BaseResponse
	Response *DescribeAccountUsersResponseParams `json:"Response"`
}

func NewDescribeAccountUsersResponse added in v1.0.501

func NewDescribeAccountUsersResponse() (response *DescribeAccountUsersResponse)

func (*DescribeAccountUsersResponse) FromJsonString added in v1.0.501

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

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

func (*DescribeAccountUsersResponse) ToJsonString added in v1.0.501

func (r *DescribeAccountUsersResponse) ToJsonString() string

type DescribeAccountUsersResponseParams added in v1.0.501

type DescribeAccountUsersResponseParams struct {
	// 实例账号列表。
	Users []*UserInfo `json:"Users,omitnil,omitempty" name:"Users"`

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

Predefined struct for user

type DescribeAsyncRequestInfoRequest

type DescribeAsyncRequestInfoRequest struct {
	*tchttp.BaseRequest

	// 异步请求Id,涉及到异步流程的接口返回,如CreateBackupDBInstance
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`
}

func NewDescribeAsyncRequestInfoRequest

func NewDescribeAsyncRequestInfoRequest() (request *DescribeAsyncRequestInfoRequest)

func (*DescribeAsyncRequestInfoRequest) FromJsonString

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

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

func (*DescribeAsyncRequestInfoRequest) ToJsonString

func (r *DescribeAsyncRequestInfoRequest) ToJsonString() string

type DescribeAsyncRequestInfoRequestParams added in v1.0.426

type DescribeAsyncRequestInfoRequestParams struct {
	// 异步请求Id,涉及到异步流程的接口返回,如CreateBackupDBInstance
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`
}

Predefined struct for user

type DescribeAsyncRequestInfoResponse

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

func NewDescribeAsyncRequestInfoResponse

func NewDescribeAsyncRequestInfoResponse() (response *DescribeAsyncRequestInfoResponse)

func (*DescribeAsyncRequestInfoResponse) FromJsonString

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

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

func (*DescribeAsyncRequestInfoResponse) ToJsonString

func (r *DescribeAsyncRequestInfoResponse) ToJsonString() string

type DescribeAsyncRequestInfoResponseParams added in v1.0.426

type DescribeAsyncRequestInfoResponseParams struct {
	// 状态。返回参数有:initial-初始化、running-运行中、paused-任务执行失败,已暂停、undoed-任务执行失败,已回滚、failed-任务执行失败, 已终止、success-成功
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

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

Predefined struct for user

type DescribeBackupDownloadTaskRequest

type DescribeBackupDownloadTaskRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 备份文件名,用来过滤指定文件的下载任务
	BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"`

	// 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 此次查询返回的条数,取值范围为1-100,默认为20
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 指定此次查询返回的页数,默认为0
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 排序字段,取值为createTime,finishTime两种,默认为createTime
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 排序方式,取值为asc,desc两种,默认desc
	OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`

	// 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
	Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"`
}

func NewDescribeBackupDownloadTaskRequest

func NewDescribeBackupDownloadTaskRequest() (request *DescribeBackupDownloadTaskRequest)

func (*DescribeBackupDownloadTaskRequest) FromJsonString

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

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

func (*DescribeBackupDownloadTaskRequest) ToJsonString

func (r *DescribeBackupDownloadTaskRequest) ToJsonString() string

type DescribeBackupDownloadTaskRequestParams added in v1.0.426

type DescribeBackupDownloadTaskRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 备份文件名,用来过滤指定文件的下载任务
	BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"`

	// 指定查询时间范围内的任务,StartTime指定开始时间,不填默认不限制开始时间
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 指定查询时间范围内的任务,EndTime指定截止时间,不填默认不限制截止时间
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 此次查询返回的条数,取值范围为1-100,默认为20
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 指定此次查询返回的页数,默认为0
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 排序字段,取值为createTime,finishTime两种,默认为createTime
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 排序方式,取值为asc,desc两种,默认desc
	OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`

	// 根据任务状态过滤。0-等待执行,1-正在下载,2-下载完成,3-下载失败,4-等待重试。不填默认返回所有类型
	Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"`
}

Predefined struct for user

type DescribeBackupDownloadTaskResponse

type DescribeBackupDownloadTaskResponse struct {
	*tchttp.BaseResponse
	Response *DescribeBackupDownloadTaskResponseParams `json:"Response"`
}

func NewDescribeBackupDownloadTaskResponse

func NewDescribeBackupDownloadTaskResponse() (response *DescribeBackupDownloadTaskResponse)

func (*DescribeBackupDownloadTaskResponse) FromJsonString

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

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

func (*DescribeBackupDownloadTaskResponse) ToJsonString

func (r *DescribeBackupDownloadTaskResponse) ToJsonString() string

type DescribeBackupDownloadTaskResponseParams added in v1.0.426

type DescribeBackupDownloadTaskResponseParams struct {
	// 满足查询条件的所有条数
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 下载任务列表
	Tasks []*BackupDownloadTask `json:"Tasks,omitnil,omitempty" name:"Tasks"`

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

Predefined struct for user

type DescribeClientConnectionsRequest

type DescribeClientConnectionsRequest struct {
	*tchttp.BaseRequest

	// 指定待查询的实例ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 单次请求返回的数量。最小值为1,最大值为1000,默认值为1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认值为0。Offset=Limit*(页码-1)。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeClientConnectionsRequest

func NewDescribeClientConnectionsRequest() (request *DescribeClientConnectionsRequest)

func (*DescribeClientConnectionsRequest) FromJsonString

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

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

func (*DescribeClientConnectionsRequest) ToJsonString

func (r *DescribeClientConnectionsRequest) ToJsonString() string

type DescribeClientConnectionsRequestParams added in v1.0.426

type DescribeClientConnectionsRequestParams struct {
	// 指定待查询的实例ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 单次请求返回的数量。最小值为1,最大值为1000,默认值为1000。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认值为0。Offset=Limit*(页码-1)。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeClientConnectionsResponse

type DescribeClientConnectionsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeClientConnectionsResponseParams `json:"Response"`
}

func NewDescribeClientConnectionsResponse

func NewDescribeClientConnectionsResponse() (response *DescribeClientConnectionsResponse)

func (*DescribeClientConnectionsResponse) FromJsonString

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

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

func (*DescribeClientConnectionsResponse) ToJsonString

func (r *DescribeClientConnectionsResponse) ToJsonString() string

type DescribeClientConnectionsResponseParams added in v1.0.426

type DescribeClientConnectionsResponseParams struct {
	// 客户端连接信息,包括客户端 IP 和对应 IP 的连接数量。
	Clients []*ClientConnection `json:"Clients,omitnil,omitempty" name:"Clients"`

	// 满足条件的记录总条数,可用于分页查询。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeCurrentOpRequest

type DescribeCurrentOpRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 筛选条件,操作所属的命名空间namespace,格式为db.collection
	Ns *string `json:"Ns,omitnil,omitempty" name:"Ns"`

	// 筛选条件,操作已经执行的时间(单位:毫秒),结果将返回超过设置时间的操作,默认值为0,取值范围为[0, 3600000]
	MillisecondRunning *uint64 `json:"MillisecondRunning,omitnil,omitempty" name:"MillisecondRunning"`

	// 筛选条件,操作类型,可能的取值:none,update,insert,query,command,getmore,remove和killcursors
	Op *string `json:"Op,omitnil,omitempty" name:"Op"`

	// 筛选条件,分片名称
	ReplicaSetName *string `json:"ReplicaSetName,omitnil,omitempty" name:"ReplicaSetName"`

	// 筛选条件,节点状态,可能的取值为:primary
	// secondary
	State *string `json:"State,omitnil,omitempty" name:"State"`

	// 单次请求返回的数量,默认值为100,取值范围为[0,100]
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认值为0,取值范围为[0,10000]
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
	OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`
}

func NewDescribeCurrentOpRequest

func NewDescribeCurrentOpRequest() (request *DescribeCurrentOpRequest)

func (*DescribeCurrentOpRequest) FromJsonString

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

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

func (*DescribeCurrentOpRequest) ToJsonString

func (r *DescribeCurrentOpRequest) ToJsonString() string

type DescribeCurrentOpRequestParams added in v1.0.426

type DescribeCurrentOpRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 筛选条件,操作所属的命名空间namespace,格式为db.collection
	Ns *string `json:"Ns,omitnil,omitempty" name:"Ns"`

	// 筛选条件,操作已经执行的时间(单位:毫秒),结果将返回超过设置时间的操作,默认值为0,取值范围为[0, 3600000]
	MillisecondRunning *uint64 `json:"MillisecondRunning,omitnil,omitempty" name:"MillisecondRunning"`

	// 筛选条件,操作类型,可能的取值:none,update,insert,query,command,getmore,remove和killcursors
	Op *string `json:"Op,omitnil,omitempty" name:"Op"`

	// 筛选条件,分片名称
	ReplicaSetName *string `json:"ReplicaSetName,omitnil,omitempty" name:"ReplicaSetName"`

	// 筛选条件,节点状态,可能的取值为:primary
	// secondary
	State *string `json:"State,omitnil,omitempty" name:"State"`

	// 单次请求返回的数量,默认值为100,取值范围为[0,100]
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认值为0,取值范围为[0,10000]
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 返回结果集排序的字段,目前支持:"MicrosecsRunning"/"microsecsrunning",默认为升序排序
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 返回结果集排序方式,可能的取值:"ASC"/"asc"或"DESC"/"desc"
	OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`
}

Predefined struct for user

type DescribeCurrentOpResponse

type DescribeCurrentOpResponse struct {
	*tchttp.BaseResponse
	Response *DescribeCurrentOpResponseParams `json:"Response"`
}

func NewDescribeCurrentOpResponse

func NewDescribeCurrentOpResponse() (response *DescribeCurrentOpResponse)

func (*DescribeCurrentOpResponse) FromJsonString

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

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

func (*DescribeCurrentOpResponse) ToJsonString

func (r *DescribeCurrentOpResponse) ToJsonString() string

type DescribeCurrentOpResponseParams added in v1.0.426

type DescribeCurrentOpResponseParams struct {
	// 符合查询条件的操作总数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 当前操作列表
	CurrentOps []*CurrentOp `json:"CurrentOps,omitnil,omitempty" name:"CurrentOps"`

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

Predefined struct for user

type DescribeDBBackupsRequest

type DescribeDBBackupsRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。
	BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"`

	// 分页大小,最大值为100,不设置默认查询所有。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页偏移量,最小值为0,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

func NewDescribeDBBackupsRequest

func NewDescribeDBBackupsRequest() (request *DescribeDBBackupsRequest)

func (*DescribeDBBackupsRequest) FromJsonString

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

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

func (*DescribeDBBackupsRequest) ToJsonString

func (r *DescribeDBBackupsRequest) ToJsonString() string

type DescribeDBBackupsRequestParams added in v1.0.426

type DescribeDBBackupsRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 备份方式,当前支持:0-逻辑备份,1-物理备份,2-所有备份。默认为逻辑备份。
	BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"`

	// 分页大小,最大值为100,不设置默认查询所有。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 分页偏移量,最小值为0,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`
}

Predefined struct for user

type DescribeDBBackupsResponse

type DescribeDBBackupsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDBBackupsResponseParams `json:"Response"`
}

func NewDescribeDBBackupsResponse

func NewDescribeDBBackupsResponse() (response *DescribeDBBackupsResponse)

func (*DescribeDBBackupsResponse) FromJsonString

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

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

func (*DescribeDBBackupsResponse) ToJsonString

func (r *DescribeDBBackupsResponse) ToJsonString() string

type DescribeDBBackupsResponseParams added in v1.0.426

type DescribeDBBackupsResponseParams struct {
	// 备份列表
	BackupList []*BackupInfo `json:"BackupList,omitnil,omitempty" name:"BackupList"`

	// 备份总数
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeDBInstanceDealRequest

type DescribeDBInstanceDealRequest struct {
	*tchttp.BaseRequest

	// 订单ID,通过CreateDBInstance等接口返回
	DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"`
}

func NewDescribeDBInstanceDealRequest

func NewDescribeDBInstanceDealRequest() (request *DescribeDBInstanceDealRequest)

func (*DescribeDBInstanceDealRequest) FromJsonString

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

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

func (*DescribeDBInstanceDealRequest) ToJsonString

func (r *DescribeDBInstanceDealRequest) ToJsonString() string

type DescribeDBInstanceDealRequestParams added in v1.0.426

type DescribeDBInstanceDealRequestParams struct {
	// 订单ID,通过CreateDBInstance等接口返回
	DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"`
}

Predefined struct for user

type DescribeDBInstanceDealResponse

type DescribeDBInstanceDealResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDBInstanceDealResponseParams `json:"Response"`
}

func NewDescribeDBInstanceDealResponse

func NewDescribeDBInstanceDealResponse() (response *DescribeDBInstanceDealResponse)

func (*DescribeDBInstanceDealResponse) FromJsonString

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

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

func (*DescribeDBInstanceDealResponse) ToJsonString

func (r *DescribeDBInstanceDealResponse) ToJsonString() string

type DescribeDBInstanceDealResponseParams added in v1.0.426

type DescribeDBInstanceDealResponseParams struct {
	// 订单状态,1:未支付,2:已支付,3:发货中,4:发货成功,5:发货失败,6:退款,7:订单关闭,8:超时未支付关闭。
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 订单原价。
	OriginalPrice *float64 `json:"OriginalPrice,omitnil,omitempty" name:"OriginalPrice"`

	// 订单折扣价格。
	DiscountPrice *float64 `json:"DiscountPrice,omitnil,omitempty" name:"DiscountPrice"`

	// 订单行为,purchase:新购,renew:续费,upgrade:升配,downgrade:降配,refund:退货退款。
	Action *string `json:"Action,omitnil,omitempty" name:"Action"`

	// 当前订单的资源Id。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

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

Predefined struct for user

type DescribeDBInstanceNodePropertyRequest added in v1.0.525

type DescribeDBInstanceNodePropertyRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点ID。
	NodeIds []*string `json:"NodeIds,omitnil,omitempty" name:"NodeIds"`

	// 节点角色。可选值包括:
	// <ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>
	Roles []*string `json:"Roles,omitnil,omitempty" name:"Roles"`

	// 该参数指定节点是否为Hidden节点,默认为false。
	OnlyHidden *bool `json:"OnlyHidden,omitnil,omitempty" name:"OnlyHidden"`

	// 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
	Priority *int64 `json:"Priority,omitnil,omitempty" name:"Priority"`

	// 该参数指定节点投票权。
	// <ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>
	Votes *int64 `json:"Votes,omitnil,omitempty" name:"Votes"`

	// 节点标签。
	Tags []*NodeTag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewDescribeDBInstanceNodePropertyRequest added in v1.0.525

func NewDescribeDBInstanceNodePropertyRequest() (request *DescribeDBInstanceNodePropertyRequest)

func (*DescribeDBInstanceNodePropertyRequest) FromJsonString added in v1.0.525

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

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

func (*DescribeDBInstanceNodePropertyRequest) ToJsonString added in v1.0.525

type DescribeDBInstanceNodePropertyRequestParams added in v1.0.525

type DescribeDBInstanceNodePropertyRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 节点ID。
	NodeIds []*string `json:"NodeIds,omitnil,omitempty" name:"NodeIds"`

	// 节点角色。可选值包括:
	// <ul><li>PRIMARY:主节点。</li><li>SECONDARY:从节点。</li><li>READONLY:只读节点。</li><li>ARBITER:仲裁节点。</li></ul>
	Roles []*string `json:"Roles,omitnil,omitempty" name:"Roles"`

	// 该参数指定节点是否为Hidden节点,默认为false。
	OnlyHidden *bool `json:"OnlyHidden,omitnil,omitempty" name:"OnlyHidden"`

	// 该参数指定选举新主节点的优先级。其取值范围为[0,100],数值越高,优先级越高。
	Priority *int64 `json:"Priority,omitnil,omitempty" name:"Priority"`

	// 该参数指定节点投票权。
	// <ul><li>1:具有投票权。</li><li>0:无投票权。</li></ul>
	Votes *int64 `json:"Votes,omitnil,omitempty" name:"Votes"`

	// 节点标签。
	Tags []*NodeTag `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type DescribeDBInstanceNodePropertyResponse added in v1.0.525

type DescribeDBInstanceNodePropertyResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDBInstanceNodePropertyResponseParams `json:"Response"`
}

func NewDescribeDBInstanceNodePropertyResponse added in v1.0.525

func NewDescribeDBInstanceNodePropertyResponse() (response *DescribeDBInstanceNodePropertyResponse)

func (*DescribeDBInstanceNodePropertyResponse) FromJsonString added in v1.0.525

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

func (*DescribeDBInstanceNodePropertyResponse) ToJsonString added in v1.0.525

type DescribeDBInstanceNodePropertyResponseParams added in v1.0.525

type DescribeDBInstanceNodePropertyResponseParams struct {
	// Mongos节点属性。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Mongos []*NodeProperty `json:"Mongos,omitnil,omitempty" name:"Mongos"`

	// 副本集节点信息。
	ReplicateSets []*ReplicateSetInfo `json:"ReplicateSets,omitnil,omitempty" name:"ReplicateSets"`

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

Predefined struct for user

type DescribeDBInstancesRequest

type DescribeDBInstancesRequest struct {
	*tchttp.BaseRequest

	// 实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>2:临时实例。</li><li>3:只读实例。</li><li>-1:正式实例、只读、灾备实例。</li></ul>
	InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// 集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:所有实例。</li></ul>
	ClusterType *int64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 实例状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程执行中。</li><li>2:实例有效。</li><li>-2:已隔离(包年包月实例)。</li><li>-3:已隔离(按量计费实例)。</li></ul>
	Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 私有网络的 ID。
	// - 基础网络则无需配置该参数。
	// - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其 ID。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络的子网ID。
	// - 基础网络则无需配置该参数。
	// - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其子网 ID。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>
	PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 单次请求返回的数量。默认值为20,取值范围为[1,100]。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 配置返回结果的排序方式。
	// - ASC:升序。
	// - DESC:降序。
	OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`

	// 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在右上角的账户信息下拉菜单中,选择项目管理查询项目。
	ProjectIds []*uint64 `json:"ProjectIds,omitnil,omitempty" name:"ProjectIds"`

	// 配置查询搜索的关键词。支持配置为实例ID、实例名称或者内网 IP 地址。
	SearchKey *string `json:"SearchKey,omitnil,omitempty" name:"SearchKey"`

	// 标签信息,包含标签键与标签值。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`
}

func NewDescribeDBInstancesRequest

func NewDescribeDBInstancesRequest() (request *DescribeDBInstancesRequest)

func (*DescribeDBInstancesRequest) FromJsonString

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

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

func (*DescribeDBInstancesRequest) ToJsonString

func (r *DescribeDBInstancesRequest) ToJsonString() string

type DescribeDBInstancesRequestParams added in v1.0.426

type DescribeDBInstancesRequestParams struct {
	// 实例 ID 列表。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 实例类型。取值范围如下:<ul><li>0:所有实例。</li><li>1:正式实例。</li><li>2:临时实例。</li><li>3:只读实例。</li><li>-1:正式实例、只读、灾备实例。</li></ul>
	InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// 集群类型,取值范围如下:<ul><li>0:副本集实例。</li><li>1:分片实例。</li><li>-1:所有实例。</li></ul>
	ClusterType *int64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 实例状态,取值范围如下所示:<ul><li>0:待初始化。</li><li>1:流程执行中。</li><li>2:实例有效。</li><li>-2:已隔离(包年包月实例)。</li><li>-3:已隔离(按量计费实例)。</li></ul>
	Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 私有网络的 ID。
	// - 基础网络则无需配置该参数。
	// - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其 ID。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络的子网ID。
	// - 基础网络则无需配置该参数。
	// - 请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表中,单击私有网络名称,在**私有网络**页面获取其子网 ID。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 付费类型,取值范围如下:<ul><li>0:查询按量计费实例。</li><li>1:查询包年包月实例。</li><li>-1:查询按量计费与包年包月实例。</li></ul>
	PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 单次请求返回的数量。默认值为20,取值范围为[1,100]。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 偏移量,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 配置返回结果排序依据的字段。目前支持依据"ProjectId"、"InstanceName"、"CreateTime"排序。
	OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"`

	// 配置返回结果的排序方式。
	// - ASC:升序。
	// - DESC:降序。
	OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"`

	// 项目 ID。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb),在右上角的账户信息下拉菜单中,选择项目管理查询项目。
	ProjectIds []*uint64 `json:"ProjectIds,omitnil,omitempty" name:"ProjectIds"`

	// 配置查询搜索的关键词。支持配置为实例ID、实例名称或者内网 IP 地址。
	SearchKey *string `json:"SearchKey,omitnil,omitempty" name:"SearchKey"`

	// 标签信息,包含标签键与标签值。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`
}

Predefined struct for user

type DescribeDBInstancesResponse

type DescribeDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeDBInstancesResponseParams `json:"Response"`
}

func NewDescribeDBInstancesResponse

func NewDescribeDBInstancesResponse() (response *DescribeDBInstancesResponse)

func (*DescribeDBInstancesResponse) FromJsonString

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

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

func (*DescribeDBInstancesResponse) ToJsonString

func (r *DescribeDBInstancesResponse) ToJsonString() string

type DescribeDBInstancesResponseParams added in v1.0.426

type DescribeDBInstancesResponseParams struct {
	// 符合查询条件的实例总数。
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// 实例详细信息列表。
	InstanceDetails []*InstanceDetail `json:"InstanceDetails,omitnil,omitempty" name:"InstanceDetails"`

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

Predefined struct for user

type DescribeInstanceParamsRequest added in v1.0.312

type DescribeInstanceParamsRequest struct {
	*tchttp.BaseRequest

	// 指定待查询参数列表的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceParamsRequest added in v1.0.312

func NewDescribeInstanceParamsRequest() (request *DescribeInstanceParamsRequest)

func (*DescribeInstanceParamsRequest) FromJsonString added in v1.0.312

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

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

func (*DescribeInstanceParamsRequest) ToJsonString added in v1.0.312

func (r *DescribeInstanceParamsRequest) ToJsonString() string

type DescribeInstanceParamsRequestParams added in v1.0.426

type DescribeInstanceParamsRequestParams struct {
	// 指定待查询参数列表的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeInstanceParamsResponse added in v1.0.312

type DescribeInstanceParamsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeInstanceParamsResponseParams `json:"Response"`
}

func NewDescribeInstanceParamsResponse added in v1.0.312

func NewDescribeInstanceParamsResponse() (response *DescribeInstanceParamsResponse)

func (*DescribeInstanceParamsResponse) FromJsonString added in v1.0.312

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

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

func (*DescribeInstanceParamsResponse) ToJsonString added in v1.0.312

func (r *DescribeInstanceParamsResponse) ToJsonString() string

type DescribeInstanceParamsResponseParams added in v1.0.426

type DescribeInstanceParamsResponseParams struct {
	// 参数值为枚举类型参数集合。
	InstanceEnumParam []*InstanceEnumParam `json:"InstanceEnumParam,omitnil,omitempty" name:"InstanceEnumParam"`

	// 参数值为 Integer 类型参数集合。
	InstanceIntegerParam []*InstanceIntegerParam `json:"InstanceIntegerParam,omitnil,omitempty" name:"InstanceIntegerParam"`

	// 参数值为 Text 类型的参数集合。
	InstanceTextParam []*InstanceTextParam `json:"InstanceTextParam,omitnil,omitempty" name:"InstanceTextParam"`

	// 参数值为混合类型的参数集合。
	InstanceMultiParam []*InstanceMultiParam `json:"InstanceMultiParam,omitnil,omitempty" name:"InstanceMultiParam"`

	// 当前实例支持修改的参数个数统计 如0
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

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

Predefined struct for user

type DescribeSecurityGroupRequest

type DescribeSecurityGroupRequest struct {
	*tchttp.BaseRequest

	// 实例 ID。例如:cmgo-p8vn****。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewDescribeSecurityGroupRequest

func NewDescribeSecurityGroupRequest() (request *DescribeSecurityGroupRequest)

func (*DescribeSecurityGroupRequest) FromJsonString

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

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

func (*DescribeSecurityGroupRequest) ToJsonString

func (r *DescribeSecurityGroupRequest) ToJsonString() string

type DescribeSecurityGroupRequestParams added in v1.0.426

type DescribeSecurityGroupRequestParams struct {
	// 实例 ID。例如:cmgo-p8vn****。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type DescribeSecurityGroupResponse

type DescribeSecurityGroupResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSecurityGroupResponseParams `json:"Response"`
}

func NewDescribeSecurityGroupResponse

func NewDescribeSecurityGroupResponse() (response *DescribeSecurityGroupResponse)

func (*DescribeSecurityGroupResponse) FromJsonString

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

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

func (*DescribeSecurityGroupResponse) ToJsonString

func (r *DescribeSecurityGroupResponse) ToJsonString() string

type DescribeSecurityGroupResponseParams added in v1.0.426

type DescribeSecurityGroupResponseParams struct {
	// 实例绑定的安全组信息。
	Groups []*SecurityGroup `json:"Groups,omitnil,omitempty" name:"Groups"`

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

Predefined struct for user

type DescribeSlowLogPatternsRequest

type DescribeSlowLogPatternsRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
	SlowMS *uint64 `json:"SlowMS,omitnil,omitempty" name:"SlowMS"`

	// 偏移量,最小值为0,最大值为10000,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页大小,最小值为1,最大值为100,默认值为20。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
	Format *string `json:"Format,omitnil,omitempty" name:"Format"`
}

func NewDescribeSlowLogPatternsRequest

func NewDescribeSlowLogPatternsRequest() (request *DescribeSlowLogPatternsRequest)

func (*DescribeSlowLogPatternsRequest) FromJsonString

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

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

func (*DescribeSlowLogPatternsRequest) ToJsonString

func (r *DescribeSlowLogPatternsRequest) ToJsonString() string

type DescribeSlowLogPatternsRequestParams added in v1.0.426

type DescribeSlowLogPatternsRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
	SlowMS *uint64 `json:"SlowMS,omitnil,omitempty" name:"SlowMS"`

	// 偏移量,最小值为0,最大值为10000,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页大小,最小值为1,最大值为100,默认值为20。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 慢日志返回格式,可设置为json,不传默认返回原生慢日志格式。
	Format *string `json:"Format,omitnil,omitempty" name:"Format"`
}

Predefined struct for user

type DescribeSlowLogPatternsResponse

type DescribeSlowLogPatternsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSlowLogPatternsResponseParams `json:"Response"`
}

func NewDescribeSlowLogPatternsResponse

func NewDescribeSlowLogPatternsResponse() (response *DescribeSlowLogPatternsResponse)

func (*DescribeSlowLogPatternsResponse) FromJsonString

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

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

func (*DescribeSlowLogPatternsResponse) ToJsonString

func (r *DescribeSlowLogPatternsResponse) ToJsonString() string

type DescribeSlowLogPatternsResponseParams added in v1.0.426

type DescribeSlowLogPatternsResponseParams struct {
	// 慢日志统计信息总数
	Count *uint64 `json:"Count,omitnil,omitempty" name:"Count"`

	// 慢日志统计信息
	SlowLogPatterns []*SlowLogPattern `json:"SlowLogPatterns,omitnil,omitempty" name:"SlowLogPatterns"`

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

Predefined struct for user

type DescribeSlowLogsRequest

type DescribeSlowLogsRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
	SlowMS *uint64 `json:"SlowMS,omitnil,omitempty" name:"SlowMS"`

	// 偏移量,最小值为0,最大值为10000,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页大小,最小值为1,最大值为100,默认值为20。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 慢日志返回格式。默认返回原生慢日志格式,4.4及以上版本可设置为json。
	Format *string `json:"Format,omitnil,omitempty" name:"Format"`
}

func NewDescribeSlowLogsRequest

func NewDescribeSlowLogsRequest() (request *DescribeSlowLogsRequest)

func (*DescribeSlowLogsRequest) FromJsonString

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

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

func (*DescribeSlowLogsRequest) ToJsonString

func (r *DescribeSlowLogsRequest) ToJsonString() string

type DescribeSlowLogsRequestParams added in v1.0.426

type DescribeSlowLogsRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 慢日志起始时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-01 10:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// 慢日志终止时间,格式:yyyy-mm-dd hh:mm:ss,如:2019-06-02 12:00:00。查询起止时间间隔不能超过24小时,只允许查询最近7天内慢日志。
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// 慢日志执行时间阈值,返回执行时间超过该阈值的慢日志,单位为毫秒(ms),最小为100毫秒。
	SlowMS *uint64 `json:"SlowMS,omitnil,omitempty" name:"SlowMS"`

	// 偏移量,最小值为0,最大值为10000,默认值为0。
	Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// 分页大小,最小值为1,最大值为100,默认值为20。
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// 慢日志返回格式。默认返回原生慢日志格式,4.4及以上版本可设置为json。
	Format *string `json:"Format,omitnil,omitempty" name:"Format"`
}

Predefined struct for user

type DescribeSlowLogsResponse

type DescribeSlowLogsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSlowLogsResponseParams `json:"Response"`
}

func NewDescribeSlowLogsResponse

func NewDescribeSlowLogsResponse() (response *DescribeSlowLogsResponse)

func (*DescribeSlowLogsResponse) FromJsonString

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

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

func (*DescribeSlowLogsResponse) ToJsonString

func (r *DescribeSlowLogsResponse) ToJsonString() string

type DescribeSlowLogsResponseParams added in v1.0.426

type DescribeSlowLogsResponseParams struct {
	// 慢日志总数
	Count *uint64 `json:"Count,omitnil,omitempty" name:"Count"`

	// 慢日志详情
	// 注意:此字段可能返回 null,表示取不到有效值。
	SlowLogs []*string `json:"SlowLogs,omitnil,omitempty" name:"SlowLogs"`

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

Predefined struct for user

type DescribeSpecInfoRequest

type DescribeSpecInfoRequest struct {
	*tchttp.BaseRequest

	// 待查询可用区
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`
}

func NewDescribeSpecInfoRequest

func NewDescribeSpecInfoRequest() (request *DescribeSpecInfoRequest)

func (*DescribeSpecInfoRequest) FromJsonString

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

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

func (*DescribeSpecInfoRequest) ToJsonString

func (r *DescribeSpecInfoRequest) ToJsonString() string

type DescribeSpecInfoRequestParams added in v1.0.426

type DescribeSpecInfoRequestParams struct {
	// 待查询可用区
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`
}

Predefined struct for user

type DescribeSpecInfoResponse

type DescribeSpecInfoResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSpecInfoResponseParams `json:"Response"`
}

func NewDescribeSpecInfoResponse

func NewDescribeSpecInfoResponse() (response *DescribeSpecInfoResponse)

func (*DescribeSpecInfoResponse) FromJsonString

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

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

func (*DescribeSpecInfoResponse) ToJsonString

func (r *DescribeSpecInfoResponse) ToJsonString() string

type DescribeSpecInfoResponseParams added in v1.0.426

type DescribeSpecInfoResponseParams struct {
	// 实例售卖规格信息列表
	SpecInfoList []*SpecificationInfo `json:"SpecInfoList,omitnil,omitempty" name:"SpecInfoList"`

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

Predefined struct for user

type FBKeyValue added in v1.0.895

type FBKeyValue struct {
	// 用于按key回档过滤的key
	Key *string `json:"Key,omitnil,omitempty" name:"Key"`

	// 用于按key回档过滤的value
	Value *string `json:"Value,omitnil,omitempty" name:"Value"`
}

type FlashBackDBInstanceRequest added in v1.0.895

type FlashBackDBInstanceRequest struct {
	*tchttp.BaseRequest

	// 开启按 Key 回档的实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 源数据想恢复到的时间。
	TargetFlashbackTime *string `json:"TargetFlashbackTime,omitnil,omitempty" name:"TargetFlashbackTime"`

	// 源数据所在的库表信息。
	TargetDatabases []*FlashbackDatabase `json:"TargetDatabases,omitnil,omitempty" name:"TargetDatabases"`

	// 数据最终写入的实例 ID。
	TargetInstanceId *string `json:"TargetInstanceId,omitnil,omitempty" name:"TargetInstanceId"`
}

func NewFlashBackDBInstanceRequest added in v1.0.895

func NewFlashBackDBInstanceRequest() (request *FlashBackDBInstanceRequest)

func (*FlashBackDBInstanceRequest) FromJsonString added in v1.0.895

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

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

func (*FlashBackDBInstanceRequest) ToJsonString added in v1.0.895

func (r *FlashBackDBInstanceRequest) ToJsonString() string

type FlashBackDBInstanceRequestParams added in v1.0.895

type FlashBackDBInstanceRequestParams struct {
	// 开启按 Key 回档的实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 源数据想恢复到的时间。
	TargetFlashbackTime *string `json:"TargetFlashbackTime,omitnil,omitempty" name:"TargetFlashbackTime"`

	// 源数据所在的库表信息。
	TargetDatabases []*FlashbackDatabase `json:"TargetDatabases,omitnil,omitempty" name:"TargetDatabases"`

	// 数据最终写入的实例 ID。
	TargetInstanceId *string `json:"TargetInstanceId,omitnil,omitempty" name:"TargetInstanceId"`
}

Predefined struct for user

type FlashBackDBInstanceResponse added in v1.0.895

type FlashBackDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *FlashBackDBInstanceResponseParams `json:"Response"`
}

func NewFlashBackDBInstanceResponse added in v1.0.895

func NewFlashBackDBInstanceResponse() (response *FlashBackDBInstanceResponse)

func (*FlashBackDBInstanceResponse) FromJsonString added in v1.0.895

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

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

func (*FlashBackDBInstanceResponse) ToJsonString added in v1.0.895

func (r *FlashBackDBInstanceResponse) ToJsonString() string

type FlashBackDBInstanceResponseParams added in v1.0.895

type FlashBackDBInstanceResponseParams struct {
	// 回档数据异步任务 ID。
	// 注意:此字段可能返回 null,表示取不到有效值。
	FlowId *int64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

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

Predefined struct for user

type FlashbackCollection added in v1.0.895

type FlashbackCollection struct {
	// 按key回档指定的集合名
	CollectionName *string `json:"CollectionName,omitnil,omitempty" name:"CollectionName"`

	// 按key回档到的目标集合名
	TargetResultCollectionName *string `json:"TargetResultCollectionName,omitnil,omitempty" name:"TargetResultCollectionName"`

	// 上传到cos的文件的value所对应的key值
	FilterKey *string `json:"FilterKey,omitnil,omitempty" name:"FilterKey"`

	// 用于按key回档过滤的键值对
	KeyValues []*FBKeyValue `json:"KeyValues,omitnil,omitempty" name:"KeyValues"`
}

type FlashbackDatabase added in v1.0.895

type FlashbackDatabase struct {
	// 按key回档源数据所在库
	DBName *string `json:"DBName,omitnil,omitempty" name:"DBName"`

	// 按key回档的集群数组
	Collections []*FlashbackCollection `json:"Collections,omitnil,omitempty" name:"Collections"`
}

type FlushInstanceRouterConfigRequest

type FlushInstanceRouterConfigRequest struct {
	*tchttp.BaseRequest

	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewFlushInstanceRouterConfigRequest

func NewFlushInstanceRouterConfigRequest() (request *FlushInstanceRouterConfigRequest)

func (*FlushInstanceRouterConfigRequest) FromJsonString

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

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

func (*FlushInstanceRouterConfigRequest) ToJsonString

func (r *FlushInstanceRouterConfigRequest) ToJsonString() string

type FlushInstanceRouterConfigRequestParams added in v1.0.426

type FlushInstanceRouterConfigRequestParams struct {
	// 实例ID
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type FlushInstanceRouterConfigResponse

type FlushInstanceRouterConfigResponse struct {
	*tchttp.BaseResponse
	Response *FlushInstanceRouterConfigResponseParams `json:"Response"`
}

func NewFlushInstanceRouterConfigResponse

func NewFlushInstanceRouterConfigResponse() (response *FlushInstanceRouterConfigResponse)

func (*FlushInstanceRouterConfigResponse) FromJsonString

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

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

func (*FlushInstanceRouterConfigResponse) ToJsonString

func (r *FlushInstanceRouterConfigResponse) ToJsonString() string

type FlushInstanceRouterConfigResponseParams added in v1.0.426

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

Predefined struct for user

type InquirePriceCreateDBInstancesRequest

type InquirePriceCreateDBInstancesRequest struct {
	*tchttp.BaseRequest

	// 实例所属区域及可用区信息。格式:ap-guangzhou-2。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 每个分片的主从节点数量。
	// 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinNodeNum与MaxNodeNum分别对应其最小值与最大值。
	NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例内存大小。
	// - 单位:GB。
	// - 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例硬盘大小。
	// - 单位:GB。
	// - 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。
	Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 实例版本信息。具体支持的版本,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:
	// - MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本。
	// - MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本。
	// - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
	// - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
	// - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
	// - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
	// - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 机器类型。
	// - HIO:高IO型。
	// - HIO10G:高IO万兆型。
	MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"`

	// 实例数量,取值范围为[1,10]。
	GoodsNum *int64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// 实例类型。
	// - REPLSET:副本集。
	// - SHARD:分片集群。
	// - STANDALONE:单节点。
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 副本集个数。
	// - 创建副本集实例时,该参数固定设置为1。
	// - 创建分片集群时,指分片数量,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
	// - 若为单节点实例,该参数固定设置为0。
	ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// - 选择包年包月计费模式,即 <b>InstanceChargeType </b>设定为<b>PREPAID</b>时,需设定购买实例的时长。该参数取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。
	// -选择按量计费,即 <b>InstanceChargeType</b> 设定为 **POSTPAID_BY_HOUR** 时,该参数仅可配置为 1。
	Period *int64 `json:"Period,omitnil,omitempty" name:"Period"`

	// 实例付费方式。
	// - PREPAID:包年包月计费。
	// - POSTPAID_BY_HOUR:按量计费。
	InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"`

	// 分片实例询价必填参数,指 Mongos CPU核数,取值范围为[1,16]。
	MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"`

	// 分片实例询价必填参数,指 Mongos 内存,取值范围为[2,32],单位:GB。
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// 分片实例询价必填参数,指 Mongos 个数,取值范围为[3,32]。
	MongosNum *uint64 `json:"MongosNum,omitnil,omitempty" name:"MongosNum"`

	// 分片实例询价必填参数,指 ConfigServer CPU核数,取值为1,单位:GB。
	ConfigServerCpu *uint64 `json:"ConfigServerCpu,omitnil,omitempty" name:"ConfigServerCpu"`

	// 分片实例询价必填参数,指 ConfigServer 内存大小,取值为2,单位:GB。
	ConfigServerMemory *uint64 `json:"ConfigServerMemory,omitnil,omitempty" name:"ConfigServerMemory"`

	// 分片实例询价必填参数,指 ConfigServer 磁盘大小,取值为 20,单位:GB。
	ConfigServerVolume *uint64 `json:"ConfigServerVolume,omitnil,omitempty" name:"ConfigServerVolume"`
}

func NewInquirePriceCreateDBInstancesRequest

func NewInquirePriceCreateDBInstancesRequest() (request *InquirePriceCreateDBInstancesRequest)

func (*InquirePriceCreateDBInstancesRequest) FromJsonString

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

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

func (*InquirePriceCreateDBInstancesRequest) ToJsonString

func (r *InquirePriceCreateDBInstancesRequest) ToJsonString() string

type InquirePriceCreateDBInstancesRequestParams added in v1.0.426

type InquirePriceCreateDBInstancesRequestParams struct {
	// 实例所属区域及可用区信息。格式:ap-guangzhou-2。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 每个分片的主从节点数量。
	// 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinNodeNum与MaxNodeNum分别对应其最小值与最大值。
	NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例内存大小。
	// - 单位:GB。
	// - 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数CPU与Memory分别对应CPU核数与内存规格。
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例硬盘大小。
	// - 单位:GB。
	// - 取值范围:请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinStorage与MaxStorage分别对应其最小磁盘规格与最大磁盘规格。
	Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 实例版本信息。具体支持的版本,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MongoVersionCode为实例所支持的版本信息。版本信息与版本号对应关系如下:
	// - MONGO_3_WT:MongoDB 3.2 WiredTiger存储引擎版本。
	// - MONGO_3_ROCKS:MongoDB 3.2 RocksDB存储引擎版本。
	// - MONGO_36_WT:MongoDB 3.6 WiredTiger存储引擎版本。
	// - MONGO_40_WT:MongoDB 4.0 WiredTiger存储引擎版本。
	// - MONGO_42_WT:MongoDB 4.2 WiredTiger存储引擎版本。
	// - MONGO_44_WT:MongoDB 4.4 WiredTiger存储引擎版本。
	// - MONGO_50_WT:MongoDB 5.0 WiredTiger存储引擎版本。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 机器类型。
	// - HIO:高IO型。
	// - HIO10G:高IO万兆型。
	MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"`

	// 实例数量,取值范围为[1,10]。
	GoodsNum *int64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"`

	// 实例类型。
	// - REPLSET:副本集。
	// - SHARD:分片集群。
	// - STANDALONE:单节点。
	ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 副本集个数。
	// - 创建副本集实例时,该参数固定设置为1。
	// - 创建分片集群时,指分片数量,请通过接口[DescribeSpecInfo](https://cloud.tencent.com/document/product/240/38567)查询,其返回的数据结构SpecItems中的参数MinReplicateSetNum与MaxReplicateSetNum分别对应其最小值与最大值。
	// - 若为单节点实例,该参数固定设置为0。
	ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// - 选择包年包月计费模式,即 <b>InstanceChargeType </b>设定为<b>PREPAID</b>时,需设定购买实例的时长。该参数取值可选:[1,2,3,4,5,6,7,8,9,10,11,12,24,36];单位:月。
	// -选择按量计费,即 <b>InstanceChargeType</b> 设定为 **POSTPAID_BY_HOUR** 时,该参数仅可配置为 1。
	Period *int64 `json:"Period,omitnil,omitempty" name:"Period"`

	// 实例付费方式。
	// - PREPAID:包年包月计费。
	// - POSTPAID_BY_HOUR:按量计费。
	InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"`

	// 分片实例询价必填参数,指 Mongos CPU核数,取值范围为[1,16]。
	MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"`

	// 分片实例询价必填参数,指 Mongos 内存,取值范围为[2,32],单位:GB。
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// 分片实例询价必填参数,指 Mongos 个数,取值范围为[3,32]。
	MongosNum *uint64 `json:"MongosNum,omitnil,omitempty" name:"MongosNum"`

	// 分片实例询价必填参数,指 ConfigServer CPU核数,取值为1,单位:GB。
	ConfigServerCpu *uint64 `json:"ConfigServerCpu,omitnil,omitempty" name:"ConfigServerCpu"`

	// 分片实例询价必填参数,指 ConfigServer 内存大小,取值为2,单位:GB。
	ConfigServerMemory *uint64 `json:"ConfigServerMemory,omitnil,omitempty" name:"ConfigServerMemory"`

	// 分片实例询价必填参数,指 ConfigServer 磁盘大小,取值为 20,单位:GB。
	ConfigServerVolume *uint64 `json:"ConfigServerVolume,omitnil,omitempty" name:"ConfigServerVolume"`
}

Predefined struct for user

type InquirePriceCreateDBInstancesResponse

type InquirePriceCreateDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *InquirePriceCreateDBInstancesResponseParams `json:"Response"`
}

func NewInquirePriceCreateDBInstancesResponse

func NewInquirePriceCreateDBInstancesResponse() (response *InquirePriceCreateDBInstancesResponse)

func (*InquirePriceCreateDBInstancesResponse) FromJsonString

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

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

func (*InquirePriceCreateDBInstancesResponse) ToJsonString

type InquirePriceCreateDBInstancesResponseParams added in v1.0.426

type InquirePriceCreateDBInstancesResponseParams struct {
	// 价格
	Price *DBInstancePrice `json:"Price,omitnil,omitempty" name:"Price"`

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

Predefined struct for user

type InquirePriceModifyDBInstanceSpecRequest

type InquirePriceModifyDBInstanceSpecRequest struct {
	*tchttp.BaseRequest

	// 实例 ID,格式如:cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 变更配置后实例内存大小,单位:GB。
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 变更配置后实例磁盘大小,单位:GB。
	Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 实例节点数。默认为不变更节点数,暂不支持变更。
	NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例分片数。默认为不变更分片数,暂不支持变更。
	ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`
}

func NewInquirePriceModifyDBInstanceSpecRequest

func NewInquirePriceModifyDBInstanceSpecRequest() (request *InquirePriceModifyDBInstanceSpecRequest)

func (*InquirePriceModifyDBInstanceSpecRequest) FromJsonString

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

func (*InquirePriceModifyDBInstanceSpecRequest) ToJsonString

type InquirePriceModifyDBInstanceSpecRequestParams added in v1.0.426

type InquirePriceModifyDBInstanceSpecRequestParams struct {
	// 实例 ID,格式如:cmgo-p8vn****。与云数据库控制台页面中显示的实例ID相同。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 变更配置后实例内存大小,单位:GB。
	Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 变更配置后实例磁盘大小,单位:GB。
	Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 实例节点数。默认为不变更节点数,暂不支持变更。
	NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例分片数。默认为不变更分片数,暂不支持变更。
	ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`
}

Predefined struct for user

type InquirePriceModifyDBInstanceSpecResponse

type InquirePriceModifyDBInstanceSpecResponse struct {
	*tchttp.BaseResponse
	Response *InquirePriceModifyDBInstanceSpecResponseParams `json:"Response"`
}

func NewInquirePriceModifyDBInstanceSpecResponse

func NewInquirePriceModifyDBInstanceSpecResponse() (response *InquirePriceModifyDBInstanceSpecResponse)

func (*InquirePriceModifyDBInstanceSpecResponse) FromJsonString

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

func (*InquirePriceModifyDBInstanceSpecResponse) ToJsonString

type InquirePriceModifyDBInstanceSpecResponseParams added in v1.0.426

type InquirePriceModifyDBInstanceSpecResponseParams struct {
	// 价格。
	Price *DBInstancePrice `json:"Price,omitnil,omitempty" name:"Price"`

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

Predefined struct for user

type InquirePriceRenewDBInstancesRequest

type InquirePriceRenewDBInstancesRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同,接口单次最多只支持5个实例进行操作。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 预付费模式(即包年包月)相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,omitnil,omitempty" name:"InstanceChargePrepaid"`
}

func NewInquirePriceRenewDBInstancesRequest

func NewInquirePriceRenewDBInstancesRequest() (request *InquirePriceRenewDBInstancesRequest)

func (*InquirePriceRenewDBInstancesRequest) FromJsonString

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

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

func (*InquirePriceRenewDBInstancesRequest) ToJsonString

func (r *InquirePriceRenewDBInstancesRequest) ToJsonString() string

type InquirePriceRenewDBInstancesRequestParams added in v1.0.426

type InquirePriceRenewDBInstancesRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同,接口单次最多只支持5个实例进行操作。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 预付费模式(即包年包月)相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,omitnil,omitempty" name:"InstanceChargePrepaid"`
}

Predefined struct for user

type InquirePriceRenewDBInstancesResponse

type InquirePriceRenewDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *InquirePriceRenewDBInstancesResponseParams `json:"Response"`
}

func NewInquirePriceRenewDBInstancesResponse

func NewInquirePriceRenewDBInstancesResponse() (response *InquirePriceRenewDBInstancesResponse)

func (*InquirePriceRenewDBInstancesResponse) FromJsonString

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

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

func (*InquirePriceRenewDBInstancesResponse) ToJsonString

func (r *InquirePriceRenewDBInstancesResponse) ToJsonString() string

type InquirePriceRenewDBInstancesResponseParams added in v1.0.426

type InquirePriceRenewDBInstancesResponseParams struct {
	// 价格
	Price *DBInstancePrice `json:"Price,omitnil,omitempty" name:"Price"`

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

Predefined struct for user

type InstanceChargePrepaid

type InstanceChargePrepaid struct {
	// 购买实例的时长,单位:月。取值范围:1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36。默认为1。
	// (InquirePriceRenewDBInstances,RenewDBInstances调用时必填)
	Period *int64 `json:"Period,omitnil,omitempty" name:"Period"`

	// 自动续费标识。取值范围:
	// NOTIFY_AND_AUTO_RENEW:通知过期且自动续费
	// NOTIFY_AND_MANUAL_RENEW:通知过期不自动续费
	// DISABLE_NOTIFY_AND_MANUAL_RENEW:不通知过期不自动续费
	//
	// 默认取值:NOTIFY_AND_MANUAL_RENEW。若该参数指定为NOTIFY_AND_AUTO_RENEW,在账户余额充足的情况下,实例到期后将按月自动续费。
	// (InquirePriceRenewDBInstances,RenewDBInstances调用时必填)
	RenewFlag *string `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"`
}

type InstanceDetail

type InstanceDetail struct {
	// 实例ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例名称。
	InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"`

	// 付费类型,可能的返回值:1-包年包月;0-按量计费
	PayMode *uint64 `json:"PayMode,omitnil,omitempty" name:"PayMode"`

	// 项目ID。
	ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 集群类型,可能的返回值:0-副本集实例,1-分片实例。
	ClusterType *uint64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 地域信息。
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// 可用区信息。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 网络类型,可能的返回值:0-基础网络,1-私有网络
	NetType *uint64 `json:"NetType,omitnil,omitempty" name:"NetType"`

	// 私有网络的ID。
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// 私有网络的子网ID。
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// 实例状态,可能的返回值:0-待初始化,1-流程处理中,2-运行中,-2-实例已过期。
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 实例IP。
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

	// 端口号。
	Vport *uint64 `json:"Vport,omitnil,omitempty" name:"Vport"`

	// 实例创建时间。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 实例到期时间。
	DeadLine *string `json:"DeadLine,omitnil,omitempty" name:"DeadLine"`

	// 实例版本信息。
	MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"`

	// 实例内存规格,单位为MB。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例磁盘规格,单位为MB。
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 实例CPU核心数。
	CpuNum *uint64 `json:"CpuNum,omitnil,omitempty" name:"CpuNum"`

	// 实例机器类型。
	MachineType *string `json:"MachineType,omitnil,omitempty" name:"MachineType"`

	// 实例从节点数。
	SecondaryNum *uint64 `json:"SecondaryNum,omitnil,omitempty" name:"SecondaryNum"`

	// 实例分片数。
	ReplicationSetNum *uint64 `json:"ReplicationSetNum,omitnil,omitempty" name:"ReplicationSetNum"`

	// 实例自动续费标志,可能的返回值:0-手动续费,1-自动续费,2-确认不续费。
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// 已用容量,单位MB。
	UsedVolume *uint64 `json:"UsedVolume,omitnil,omitempty" name:"UsedVolume"`

	// 维护窗口起始时间。
	MaintenanceStart *string `json:"MaintenanceStart,omitnil,omitempty" name:"MaintenanceStart"`

	// 维护窗口结束时间。
	MaintenanceEnd *string `json:"MaintenanceEnd,omitnil,omitempty" name:"MaintenanceEnd"`

	// 分片信息。
	ReplicaSets []*ShardInfo `json:"ReplicaSets,omitnil,omitempty" name:"ReplicaSets"`

	// 只读实例信息。
	ReadonlyInstances []*DBInstanceInfo `json:"ReadonlyInstances,omitnil,omitempty" name:"ReadonlyInstances"`

	// 灾备实例信息。
	StandbyInstances []*DBInstanceInfo `json:"StandbyInstances,omitnil,omitempty" name:"StandbyInstances"`

	// 临时实例信息。
	CloneInstances []*DBInstanceInfo `json:"CloneInstances,omitnil,omitempty" name:"CloneInstances"`

	// 关联实例信息,对于正式实例,该字段表示它的临时实例信息;对于临时实例,则表示它的正式实例信息;如果为只读/灾备实例,则表示他的主实例信息。
	RelatedInstance *DBInstanceInfo `json:"RelatedInstance,omitnil,omitempty" name:"RelatedInstance"`

	// 实例标签信息集合。
	Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 实例版本标记。
	InstanceVer *uint64 `json:"InstanceVer,omitnil,omitempty" name:"InstanceVer"`

	// 实例版本标记。
	ClusterVer *uint64 `json:"ClusterVer,omitnil,omitempty" name:"ClusterVer"`

	// 协议信息,可能的返回值:1-mongodb,2-dynamodb。
	Protocol *uint64 `json:"Protocol,omitnil,omitempty" name:"Protocol"`

	// 实例类型,可能的返回值,1-正式实例,2-临时实例,3-只读实例,4-灾备实例
	InstanceType *uint64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"`

	// 实例状态描述
	InstanceStatusDesc *string `json:"InstanceStatusDesc,omitnil,omitempty" name:"InstanceStatusDesc"`

	// 实例对应的物理实例id,回档并替换过的实例有不同的InstanceId和RealInstanceId,从barad获取监控数据等场景下需要用物理id获取
	RealInstanceId *string `json:"RealInstanceId,omitnil,omitempty" name:"RealInstanceId"`

	// 实例当前可用区信息。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ZoneList []*string `json:"ZoneList,omitnil,omitempty" name:"ZoneList"`

	// mongos节点个数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"`

	// mongos节点内存。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"`

	// mongos节点CPU核数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	MongosCpuNum *uint64 `json:"MongosCpuNum,omitnil,omitempty" name:"MongosCpuNum"`

	// Config Server节点个数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ConfigServerNodeNum *uint64 `json:"ConfigServerNodeNum,omitnil,omitempty" name:"ConfigServerNodeNum"`

	// Config Server节点内存。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ConfigServerMemory *uint64 `json:"ConfigServerMemory,omitnil,omitempty" name:"ConfigServerMemory"`

	// Config Server节点磁盘大小。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ConfigServerVolume *uint64 `json:"ConfigServerVolume,omitnil,omitempty" name:"ConfigServerVolume"`

	// Config Server节点CPU核数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ConfigServerCpuNum *uint64 `json:"ConfigServerCpuNum,omitnil,omitempty" name:"ConfigServerCpuNum"`

	// readonly节点个数。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"`
}

type InstanceEnumParam added in v1.0.312

type InstanceEnumParam struct {
	// 参数当前值。
	CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"`

	// 参数默认值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// 枚举值,所有支持的值。
	EnumValue []*string `json:"EnumValue,omitnil,omitempty" name:"EnumValue"`

	// 参数修改之后是否需要重启生效。
	// - 1:需要重启后生效。
	// - 0:无需重启,设置成功即可生效。
	NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"`

	// 参数名称。
	ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"`

	// 参数说明。
	Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"`

	// 参数值类型说明。
	ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"`

	// 是否为运行中参数值。
	// - 1:运行中参数值。
	// - 0:非运行中参数值。
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`
}

type InstanceIntegerParam added in v1.0.312

type InstanceIntegerParam struct {
	// 参数当前值。
	CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"`

	// 参数默认值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// 参数最大值。
	Max *string `json:"Max,omitnil,omitempty" name:"Max"`

	// 最小值。
	Min *string `json:"Min,omitnil,omitempty" name:"Min"`

	// 参数修改之后是否需要重启生效。
	// - 1:需要重启后生效。
	// - 0:无需重启,设置成功即可生效。
	NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"`

	// 参数名称。
	ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"`

	// 参数说明。
	Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"`

	// 参数类型。
	ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"`

	// 是否为运行中参数值。
	// - 1:运行中参数值。
	// - 0:非运行中参数值。
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 冗余字段,可忽略。
	Unit *string `json:"Unit,omitnil,omitempty" name:"Unit"`
}

type InstanceMultiParam added in v1.0.312

type InstanceMultiParam struct {
	// 参数当前值。
	CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"`

	// 参数默认值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// 参考值范围。
	EnumValue []*string `json:"EnumValue,omitnil,omitempty" name:"EnumValue"`

	// 参数修改后是否需要重启才会生效。
	// - 1:需要重启后生效。
	// - 0:无需重启,设置成功即可生效。
	NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"`

	// 参数名称。
	ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"`

	// 是否为运行中参数值。
	// - 1:运行中参数值。
	// - 0:非运行中参数值。
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 参数说明。
	Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"`

	// 当前值的类型描述,默认为multi。
	ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"`
}

type InstanceTextParam added in v1.0.312

type InstanceTextParam struct {
	// 参数当前值。
	CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"`

	// 参数默认值。
	DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"`

	// 修改参数值之后是否需要重启。
	NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"`

	// 参数名称。
	ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"`

	// Text 类型参数对应的值。
	TextValue *string `json:"TextValue,omitnil,omitempty" name:"TextValue"`

	// 参数说明。
	Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"`

	// 参数值类型说明。
	ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"`

	// 是否为运行中的参数值。
	// - 1:运行中参数值。
	// - 0:非运行中参数值。
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`
}

type IsolateDBInstanceRequest

type IsolateDBInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewIsolateDBInstanceRequest

func NewIsolateDBInstanceRequest() (request *IsolateDBInstanceRequest)

func (*IsolateDBInstanceRequest) FromJsonString

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

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

func (*IsolateDBInstanceRequest) ToJsonString

func (r *IsolateDBInstanceRequest) ToJsonString() string

type IsolateDBInstanceRequestParams added in v1.0.426

type IsolateDBInstanceRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type IsolateDBInstanceResponse

type IsolateDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *IsolateDBInstanceResponseParams `json:"Response"`
}

func NewIsolateDBInstanceResponse

func NewIsolateDBInstanceResponse() (response *IsolateDBInstanceResponse)

func (*IsolateDBInstanceResponse) FromJsonString

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

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

func (*IsolateDBInstanceResponse) ToJsonString

func (r *IsolateDBInstanceResponse) ToJsonString() string

type IsolateDBInstanceResponseParams added in v1.0.426

type IsolateDBInstanceResponseParams struct {
	// 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`

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

Predefined struct for user

type KillOpsRequest

type KillOpsRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 待终止的操作
	Operations []*Operation `json:"Operations,omitnil,omitempty" name:"Operations"`
}

func NewKillOpsRequest

func NewKillOpsRequest() (request *KillOpsRequest)

func (*KillOpsRequest) FromJsonString

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

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

func (*KillOpsRequest) ToJsonString

func (r *KillOpsRequest) ToJsonString() string

type KillOpsRequestParams added in v1.0.426

type KillOpsRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 待终止的操作
	Operations []*Operation `json:"Operations,omitnil,omitempty" name:"Operations"`
}

Predefined struct for user

type KillOpsResponse

type KillOpsResponse struct {
	*tchttp.BaseResponse
	Response *KillOpsResponseParams `json:"Response"`
}

func NewKillOpsResponse

func NewKillOpsResponse() (response *KillOpsResponse)

func (*KillOpsResponse) FromJsonString

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

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

func (*KillOpsResponse) ToJsonString

func (r *KillOpsResponse) ToJsonString() string

type KillOpsResponseParams added in v1.0.426

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

Predefined struct for user

type ModifyDBInstanceNetworkAddressRequest added in v1.0.378

type ModifyDBInstanceNetworkAddressRequest struct {
	*tchttp.BaseRequest

	// 指定需修改网络的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 原 IP 地址保留时长。
	// - 单位为分钟,0表示立即回收原 IP 地址。
	// - 原 IP 将在约定时间后释放,在释放前原 IP和新 IP均可访问。
	OldIpExpiredTime *uint64 `json:"OldIpExpiredTime,omitnil,omitempty" name:"OldIpExpiredTime"`

	// 切换后的私有网络 ID,若实例当前为基础网络,该字段无需配置。
	NewUniqVpcId *string `json:"NewUniqVpcId,omitnil,omitempty" name:"NewUniqVpcId"`

	// 切换私有网络的子网 ID。若实例当前为基础网络,该字段无需配置。
	NewUniqSubnetId *string `json:"NewUniqSubnetId,omitnil,omitempty" name:"NewUniqSubnetId"`

	// IP 地址信息,包含新 IP 地址与 原 IP 地址。
	NetworkAddresses []*ModifyNetworkAddress `json:"NetworkAddresses,omitnil,omitempty" name:"NetworkAddresses"`
}

func NewModifyDBInstanceNetworkAddressRequest added in v1.0.378

func NewModifyDBInstanceNetworkAddressRequest() (request *ModifyDBInstanceNetworkAddressRequest)

func (*ModifyDBInstanceNetworkAddressRequest) FromJsonString added in v1.0.378

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

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

func (*ModifyDBInstanceNetworkAddressRequest) ToJsonString added in v1.0.378

type ModifyDBInstanceNetworkAddressRequestParams added in v1.0.426

type ModifyDBInstanceNetworkAddressRequestParams struct {
	// 指定需修改网络的实例 ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 原 IP 地址保留时长。
	// - 单位为分钟,0表示立即回收原 IP 地址。
	// - 原 IP 将在约定时间后释放,在释放前原 IP和新 IP均可访问。
	OldIpExpiredTime *uint64 `json:"OldIpExpiredTime,omitnil,omitempty" name:"OldIpExpiredTime"`

	// 切换后的私有网络 ID,若实例当前为基础网络,该字段无需配置。
	NewUniqVpcId *string `json:"NewUniqVpcId,omitnil,omitempty" name:"NewUniqVpcId"`

	// 切换私有网络的子网 ID。若实例当前为基础网络,该字段无需配置。
	NewUniqSubnetId *string `json:"NewUniqSubnetId,omitnil,omitempty" name:"NewUniqSubnetId"`

	// IP 地址信息,包含新 IP 地址与 原 IP 地址。
	NetworkAddresses []*ModifyNetworkAddress `json:"NetworkAddresses,omitnil,omitempty" name:"NetworkAddresses"`
}

Predefined struct for user

type ModifyDBInstanceNetworkAddressResponse added in v1.0.378

type ModifyDBInstanceNetworkAddressResponse struct {
	*tchttp.BaseResponse
	Response *ModifyDBInstanceNetworkAddressResponseParams `json:"Response"`
}

func NewModifyDBInstanceNetworkAddressResponse added in v1.0.378

func NewModifyDBInstanceNetworkAddressResponse() (response *ModifyDBInstanceNetworkAddressResponse)

func (*ModifyDBInstanceNetworkAddressResponse) FromJsonString added in v1.0.378

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

func (*ModifyDBInstanceNetworkAddressResponse) ToJsonString added in v1.0.378

type ModifyDBInstanceNetworkAddressResponseParams added in v1.0.426

type ModifyDBInstanceNetworkAddressResponseParams struct {
	// 修改网络异步流程任务ID。
	FlowId *uint64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

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

Predefined struct for user

type ModifyDBInstanceSecurityGroupRequest added in v1.0.359

type ModifyDBInstanceSecurityGroupRequest struct {
	*tchttp.BaseRequest

	// 实例 ID。例如:cmgo-7pje****。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 目标安全组 ID。请通过接口[DescribeSecurityGroup](https://cloud.tencent.com/document/product/240/55675)查看具体的安全组 ID。
	SecurityGroupIds []*string `json:"SecurityGroupIds,omitnil,omitempty" name:"SecurityGroupIds"`
}

func NewModifyDBInstanceSecurityGroupRequest added in v1.0.359

func NewModifyDBInstanceSecurityGroupRequest() (request *ModifyDBInstanceSecurityGroupRequest)

func (*ModifyDBInstanceSecurityGroupRequest) FromJsonString added in v1.0.359

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

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

func (*ModifyDBInstanceSecurityGroupRequest) ToJsonString added in v1.0.359

func (r *ModifyDBInstanceSecurityGroupRequest) ToJsonString() string

type ModifyDBInstanceSecurityGroupRequestParams added in v1.0.426

type ModifyDBInstanceSecurityGroupRequestParams struct {
	// 实例 ID。例如:cmgo-7pje****。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 目标安全组 ID。请通过接口[DescribeSecurityGroup](https://cloud.tencent.com/document/product/240/55675)查看具体的安全组 ID。
	SecurityGroupIds []*string `json:"SecurityGroupIds,omitnil,omitempty" name:"SecurityGroupIds"`
}

Predefined struct for user

type ModifyDBInstanceSecurityGroupResponse added in v1.0.359

type ModifyDBInstanceSecurityGroupResponse struct {
	*tchttp.BaseResponse
	Response *ModifyDBInstanceSecurityGroupResponseParams `json:"Response"`
}

func NewModifyDBInstanceSecurityGroupResponse added in v1.0.359

func NewModifyDBInstanceSecurityGroupResponse() (response *ModifyDBInstanceSecurityGroupResponse)

func (*ModifyDBInstanceSecurityGroupResponse) FromJsonString added in v1.0.359

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

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

func (*ModifyDBInstanceSecurityGroupResponse) ToJsonString added in v1.0.359

type ModifyDBInstanceSecurityGroupResponseParams added in v1.0.426

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

Predefined struct for user

type ModifyDBInstanceSpecRequest

type ModifyDBInstanceSpecRequest struct {
	*tchttp.BaseRequest

	// 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例配置变更后的内存大小。
	// - 单位:GB。
	// - 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例配置变更后的硬盘大小,单位:GB。<ul><li>内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。</li><li>降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。</li></ul>
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// (已废弃) 请使用ResizeOplog独立接口完成。
	//
	// 实例配置变更后 Oplog 的大小。
	// - 单位:GB。
	// - 默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。
	OplogSize *uint64 `json:"OplogSize,omitnil,omitempty" name:"OplogSize"`

	// 实例变更后的节点数(mongod节点或mongos节点或readonly节点调整后的节点数,具体类型取决于AddNodeList或RemoveNodeList参数的节点类型)。
	// <ul><li>副本集:取值范围请通过云数据库的售卖规格(DescribeSpecInfo)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。</li><li>分片集群:取值范围请通过云数据库的售卖规格(DescribeSpecInfo)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。</li></ul>
	NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例变更后的分片数。<ul><li>取值范围请通过云数据库的售卖规格(DescribeSpecInfo)接口返回的参数MinReplicateSetNum与MaxReplicateSetNum获取。</li><li>该参数只能增加不能减少。</li></ul>
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// 实例配置变更的切换时间。<ul><li>0:调整完成时,立即执行变配任务。默认为0。</li><li>1:在维护时间窗内,执行变配任务。
	// <b>说明</b>:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。</li></ul>
	InMaintenance *uint64 `json:"InMaintenance,omitnil,omitempty" name:"InMaintenance"`

	// 新增节点属性列表。
	AddNodeList []*AddNodeList `json:"AddNodeList,omitnil,omitempty" name:"AddNodeList"`

	// 删除节点属性列表。
	RemoveNodeList []*RemoveNodeList `json:"RemoveNodeList,omitnil,omitempty" name:"RemoveNodeList"`
}

func NewModifyDBInstanceSpecRequest

func NewModifyDBInstanceSpecRequest() (request *ModifyDBInstanceSpecRequest)

func (*ModifyDBInstanceSpecRequest) FromJsonString

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

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

func (*ModifyDBInstanceSpecRequest) ToJsonString

func (r *ModifyDBInstanceSpecRequest) ToJsonString() string

type ModifyDBInstanceSpecRequestParams added in v1.0.426

type ModifyDBInstanceSpecRequestParams struct {
	// 实例 ID,例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例配置变更后的内存大小。
	// - 单位:GB。
	// - 内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 实例配置变更后的硬盘大小,单位:GB。<ul><li>内存和磁盘必须同时升配或同时降配,即 Memory 与 Volume 需同时配置变更。</li><li>降配时,变更后的磁盘容量必须大于已用磁盘容量的1.2倍。</li></ul>
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// (已废弃) 请使用ResizeOplog独立接口完成。
	//
	// 实例配置变更后 Oplog 的大小。
	// - 单位:GB。
	// - 默认 Oplog 占用容量为磁盘空间的10%。系统允许设置的 Oplog 容量范围为磁盘空间的[10%,90%]。
	OplogSize *uint64 `json:"OplogSize,omitnil,omitempty" name:"OplogSize"`

	// 实例变更后的节点数(mongod节点或mongos节点或readonly节点调整后的节点数,具体类型取决于AddNodeList或RemoveNodeList参数的节点类型)。
	// <ul><li>副本集:取值范围请通过云数据库的售卖规格(DescribeSpecInfo)接口返回的参数 MinNodeNum 与 MaxNodeNum 获取。</li><li>分片集群:取值范围请通过云数据库的售卖规格(DescribeSpecInfo)接口返回的参数 MinReplicateSetNodeNum 与 MaxReplicateSetNodeNum 获取。</li></ul>
	NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"`

	// 实例变更后的分片数。<ul><li>取值范围请通过云数据库的售卖规格(DescribeSpecInfo)接口返回的参数MinReplicateSetNum与MaxReplicateSetNum获取。</li><li>该参数只能增加不能减少。</li></ul>
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"`

	// 实例配置变更的切换时间。<ul><li>0:调整完成时,立即执行变配任务。默认为0。</li><li>1:在维护时间窗内,执行变配任务。
	// <b>说明</b>:调整节点数和分片数不支持在<b>维护时间窗内</b>变更。</li></ul>
	InMaintenance *uint64 `json:"InMaintenance,omitnil,omitempty" name:"InMaintenance"`

	// 新增节点属性列表。
	AddNodeList []*AddNodeList `json:"AddNodeList,omitnil,omitempty" name:"AddNodeList"`

	// 删除节点属性列表。
	RemoveNodeList []*RemoveNodeList `json:"RemoveNodeList,omitnil,omitempty" name:"RemoveNodeList"`
}

Predefined struct for user

type ModifyDBInstanceSpecResponse

type ModifyDBInstanceSpecResponse struct {
	*tchttp.BaseResponse
	Response *ModifyDBInstanceSpecResponseParams `json:"Response"`
}

func NewModifyDBInstanceSpecResponse

func NewModifyDBInstanceSpecResponse() (response *ModifyDBInstanceSpecResponse)

func (*ModifyDBInstanceSpecResponse) FromJsonString

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

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

func (*ModifyDBInstanceSpecResponse) ToJsonString

func (r *ModifyDBInstanceSpecResponse) ToJsonString() string

type ModifyDBInstanceSpecResponseParams added in v1.0.426

type ModifyDBInstanceSpecResponseParams struct {
	// 订单 ID。
	DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"`

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

Predefined struct for user

type ModifyNetworkAddress added in v1.0.378

type ModifyNetworkAddress struct {
	// 新IP地址。
	NewIPAddress *string `json:"NewIPAddress,omitnil,omitempty" name:"NewIPAddress"`

	// 原IP地址。
	OldIpAddress *string `json:"OldIpAddress,omitnil,omitempty" name:"OldIpAddress"`
}

type NodeProperty added in v1.0.525

type NodeProperty struct {
	// 节点所在的可用区。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

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

	// 节点访问地址。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Address *string `json:"Address,omitnil,omitempty" name:"Address"`

	// 角色。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 是否为Hidden节点
	// 注意:此字段可能返回 null,表示取不到有效值。
	Hidden *bool `json:"Hidden,omitnil,omitempty" name:"Hidden"`

	// 节点状态,包括:ORMAL/STARTUP/RECOVERING/STARTUP2/UNKNOWN/DOWN/ROLLBACK/REMOVED等。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// 主从延迟,单位秒。
	// 注意:此字段可能返回 null,表示取不到有效值。
	SlaveDelay *int64 `json:"SlaveDelay,omitnil,omitempty" name:"SlaveDelay"`

	// 节点优先级。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Priority *int64 `json:"Priority,omitnil,omitempty" name:"Priority"`

	// 节点投票权。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Votes *int64 `json:"Votes,omitnil,omitempty" name:"Votes"`

	// 节点标签。
	// 注意:此字段可能返回 null,表示取不到有效值。
	Tags []*NodeTag `json:"Tags,omitnil,omitempty" name:"Tags"`

	// 副本集Id。
	// 注意:此字段可能返回 null,表示取不到有效值。
	ReplicateSetId *string `json:"ReplicateSetId,omitnil,omitempty" name:"ReplicateSetId"`
}

type NodeTag added in v1.0.525

type NodeTag struct {
	// 节点Tag key
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagKey *string `json:"TagKey,omitnil,omitempty" name:"TagKey"`

	// 节点Tag Value
	// 注意:此字段可能返回 null,表示取不到有效值。
	TagValue *string `json:"TagValue,omitnil,omitempty" name:"TagValue"`
}

type OfflineIsolatedDBInstanceRequest

type OfflineIsolatedDBInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewOfflineIsolatedDBInstanceRequest

func NewOfflineIsolatedDBInstanceRequest() (request *OfflineIsolatedDBInstanceRequest)

func (*OfflineIsolatedDBInstanceRequest) FromJsonString

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

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

func (*OfflineIsolatedDBInstanceRequest) ToJsonString

func (r *OfflineIsolatedDBInstanceRequest) ToJsonString() string

type OfflineIsolatedDBInstanceRequestParams added in v1.0.426

type OfflineIsolatedDBInstanceRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type OfflineIsolatedDBInstanceResponse

type OfflineIsolatedDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *OfflineIsolatedDBInstanceResponseParams `json:"Response"`
}

func NewOfflineIsolatedDBInstanceResponse

func NewOfflineIsolatedDBInstanceResponse() (response *OfflineIsolatedDBInstanceResponse)

func (*OfflineIsolatedDBInstanceResponse) FromJsonString

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

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

func (*OfflineIsolatedDBInstanceResponse) ToJsonString

func (r *OfflineIsolatedDBInstanceResponse) ToJsonString() string

type OfflineIsolatedDBInstanceResponseParams added in v1.0.426

type OfflineIsolatedDBInstanceResponseParams struct {
	// 异步任务的请求 ID,可使用此 ID 查询异步任务的执行结果。
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`

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

Predefined struct for user

type Operation

type Operation struct {
	// 操作所在的分片名
	ReplicaSetName *string `json:"ReplicaSetName,omitnil,omitempty" name:"ReplicaSetName"`

	// 操作所在的节点名
	NodeName *string `json:"NodeName,omitnil,omitempty" name:"NodeName"`

	// 操作序号
	OpId *int64 `json:"OpId,omitnil,omitempty" name:"OpId"`
}

type RemoveNodeList added in v1.0.827

type RemoveNodeList struct {
	// 需要删除的节点角色。
	// - SECONDARY:Mongod 节点。
	// - READONLY:只读节点。
	// - MONGOS:Mongos 节点。
	Role *string `json:"Role,omitnil,omitempty" name:"Role"`

	// 要删除的节点 ID。分片集群须指定一组分片要删除的节点名称即可,其余分片对改组对齐。
	//
	// - 获取方式:登录 [MongoDB控制台](https://console.cloud.tencent.com/),在**节点管理**页签,可获取**节点 ID**。
	// - 特别说明:分片集群同一节点上的分片,仅需指定0分片节点 ID 即可。例如:cmgo-6hfk****_0-node-primary。
	NodeName *string `json:"NodeName,omitnil,omitempty" name:"NodeName"`

	// 节点所对应的可用区。
	// - 单可用区,所有节点在同一可用区。
	// - 多可用区:当前标准规格是三可用区分布,主从节点不在同一可用区,需注意配置所删除节点对应的可用区,且删除后必须满足任意2个可用区节点数大于第3个可用区原则。
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`
}

type RenameInstanceRequest

type RenameInstanceRequest struct {
	*tchttp.BaseRequest

	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 自定义实例名称,名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符 -
	NewName *string `json:"NewName,omitnil,omitempty" name:"NewName"`
}

func NewRenameInstanceRequest

func NewRenameInstanceRequest() (request *RenameInstanceRequest)

func (*RenameInstanceRequest) FromJsonString

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

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

func (*RenameInstanceRequest) ToJsonString

func (r *RenameInstanceRequest) ToJsonString() string

type RenameInstanceRequestParams added in v1.0.426

type RenameInstanceRequestParams struct {
	// 实例ID,格式如:cmgo-p8vnipr5。与云数据库控制台页面中显示的实例ID相同
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 自定义实例名称,名称只支持长度为60个字符的中文、英文、数字、下划线_、分隔符 -
	NewName *string `json:"NewName,omitnil,omitempty" name:"NewName"`
}

Predefined struct for user

type RenameInstanceResponse

type RenameInstanceResponse struct {
	*tchttp.BaseResponse
	Response *RenameInstanceResponseParams `json:"Response"`
}

func NewRenameInstanceResponse

func NewRenameInstanceResponse() (response *RenameInstanceResponse)

func (*RenameInstanceResponse) FromJsonString

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

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

func (*RenameInstanceResponse) ToJsonString

func (r *RenameInstanceResponse) ToJsonString() string

type RenameInstanceResponseParams added in v1.0.426

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

Predefined struct for user

type RenewDBInstancesRequest

type RenewDBInstancesRequest struct {
	*tchttp.BaseRequest

	// 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,omitnil,omitempty" name:"InstanceChargePrepaid"`
}

func NewRenewDBInstancesRequest

func NewRenewDBInstancesRequest() (request *RenewDBInstancesRequest)

func (*RenewDBInstancesRequest) FromJsonString

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

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

func (*RenewDBInstancesRequest) ToJsonString

func (r *RenewDBInstancesRequest) ToJsonString() string

type RenewDBInstancesRequestParams added in v1.0.426

type RenewDBInstancesRequestParams struct {
	// 一个或多个待操作的实例ID。可通过DescribeInstances接口返回值中的InstanceId获取。每次请求批量实例的上限为100。
	InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"`

	// 预付费模式,即包年包月相关参数设置。通过该参数可以指定包年包月实例的续费时长、是否设置自动续费等属性。包年包月实例该参数为必传参数。
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,omitnil,omitempty" name:"InstanceChargePrepaid"`
}

Predefined struct for user

type RenewDBInstancesResponse

type RenewDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *RenewDBInstancesResponseParams `json:"Response"`
}

func NewRenewDBInstancesResponse

func NewRenewDBInstancesResponse() (response *RenewDBInstancesResponse)

func (*RenewDBInstancesResponse) FromJsonString

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

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

func (*RenewDBInstancesResponse) ToJsonString

func (r *RenewDBInstancesResponse) ToJsonString() string

type RenewDBInstancesResponseParams added in v1.0.426

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

Predefined struct for user

type ReplicaSetInfo

type ReplicaSetInfo struct {
	// 副本集ID
	ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"`
}

type ReplicateSetInfo added in v1.0.525

type ReplicateSetInfo struct {
	// 节点属性
	// 注意:此字段可能返回 null,表示取不到有效值。
	Nodes []*NodeProperty `json:"Nodes,omitnil,omitempty" name:"Nodes"`
}

type ResetDBInstancePasswordRequest

type ResetDBInstancePasswordRequest struct {
	*tchttp.BaseRequest

	// 实例Id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例账号名
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 新密码,新密码长度不能少于8位
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

func NewResetDBInstancePasswordRequest

func NewResetDBInstancePasswordRequest() (request *ResetDBInstancePasswordRequest)

func (*ResetDBInstancePasswordRequest) FromJsonString

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

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

func (*ResetDBInstancePasswordRequest) ToJsonString

func (r *ResetDBInstancePasswordRequest) ToJsonString() string

type ResetDBInstancePasswordRequestParams added in v1.0.426

type ResetDBInstancePasswordRequestParams struct {
	// 实例Id
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 实例账号名
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 新密码,新密码长度不能少于8位
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

Predefined struct for user

type ResetDBInstancePasswordResponse

type ResetDBInstancePasswordResponse struct {
	*tchttp.BaseResponse
	Response *ResetDBInstancePasswordResponseParams `json:"Response"`
}

func NewResetDBInstancePasswordResponse

func NewResetDBInstancePasswordResponse() (response *ResetDBInstancePasswordResponse)

func (*ResetDBInstancePasswordResponse) FromJsonString

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

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

func (*ResetDBInstancePasswordResponse) ToJsonString

func (r *ResetDBInstancePasswordResponse) ToJsonString() string

type ResetDBInstancePasswordResponseParams added in v1.0.426

type ResetDBInstancePasswordResponseParams struct {
	// 异步请求Id,用户查询该流程的运行状态
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`

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

Predefined struct for user

type SecurityGroup

type SecurityGroup struct {
	// 所属项目id
	ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"`

	// 创建时间
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 入站规则
	Inbound []*SecurityGroupBound `json:"Inbound,omitnil,omitempty" name:"Inbound"`

	// 出站规则
	Outbound []*SecurityGroupBound `json:"Outbound,omitnil,omitempty" name:"Outbound"`

	// 安全组id
	SecurityGroupId *string `json:"SecurityGroupId,omitnil,omitempty" name:"SecurityGroupId"`

	// 安全组名称
	SecurityGroupName *string `json:"SecurityGroupName,omitnil,omitempty" name:"SecurityGroupName"`

	// 安全组备注
	SecurityGroupRemark *string `json:"SecurityGroupRemark,omitnil,omitempty" name:"SecurityGroupRemark"`
}

type SecurityGroupBound

type SecurityGroupBound struct {
	// 执行规则。ACCEPT或DROP
	Action *string `json:"Action,omitnil,omitempty" name:"Action"`

	// ip段。
	CidrIp *string `json:"CidrIp,omitnil,omitempty" name:"CidrIp"`

	// 端口范围
	PortRange *string `json:"PortRange,omitnil,omitempty" name:"PortRange"`

	// 传输层协议。tcp,udp或ALL
	IpProtocol *string `json:"IpProtocol,omitnil,omitempty" name:"IpProtocol"`

	// 安全组id代表的地址集合
	Id *string `json:"Id,omitnil,omitempty" name:"Id"`

	// 地址组id代表的地址集合
	AddressModule *string `json:"AddressModule,omitnil,omitempty" name:"AddressModule"`

	// 服务组id代表的协议和端口集合
	ServiceModule *string `json:"ServiceModule,omitnil,omitempty" name:"ServiceModule"`

	// 描述
	Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"`
}

type SetAccountUserPrivilegeRequest added in v1.0.324

type SetAccountUserPrivilegeRequest struct {
	*tchttp.BaseRequest

	// 指定待设置账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 设置账号名称。
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 设置权限信息。
	AuthRole []*Auth `json:"AuthRole,omitnil,omitempty" name:"AuthRole"`
}

func NewSetAccountUserPrivilegeRequest added in v1.0.324

func NewSetAccountUserPrivilegeRequest() (request *SetAccountUserPrivilegeRequest)

func (*SetAccountUserPrivilegeRequest) FromJsonString added in v1.0.324

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

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

func (*SetAccountUserPrivilegeRequest) ToJsonString added in v1.0.324

func (r *SetAccountUserPrivilegeRequest) ToJsonString() string

type SetAccountUserPrivilegeRequestParams added in v1.0.426

type SetAccountUserPrivilegeRequestParams struct {
	// 指定待设置账号的实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 设置账号名称。
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 设置权限信息。
	AuthRole []*Auth `json:"AuthRole,omitnil,omitempty" name:"AuthRole"`
}

Predefined struct for user

type SetAccountUserPrivilegeResponse added in v1.0.324

type SetAccountUserPrivilegeResponse struct {
	*tchttp.BaseResponse
	Response *SetAccountUserPrivilegeResponseParams `json:"Response"`
}

func NewSetAccountUserPrivilegeResponse added in v1.0.324

func NewSetAccountUserPrivilegeResponse() (response *SetAccountUserPrivilegeResponse)

func (*SetAccountUserPrivilegeResponse) FromJsonString added in v1.0.324

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

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

func (*SetAccountUserPrivilegeResponse) ToJsonString added in v1.0.324

func (r *SetAccountUserPrivilegeResponse) ToJsonString() string

type SetAccountUserPrivilegeResponseParams added in v1.0.426

type SetAccountUserPrivilegeResponseParams struct {
	// 任务ID。
	FlowId *uint64 `json:"FlowId,omitnil,omitempty" name:"FlowId"`

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

Predefined struct for user

type SetInstanceMaintenanceRequest added in v1.0.874

type SetInstanceMaintenanceRequest struct {
	*tchttp.BaseRequest

	// 指定实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 维护时间窗开始时间。取值范围为"00:00-23:00"的任意整点或半点,如00:00或00:30。
	MaintenanceStart *string `json:"MaintenanceStart,omitnil,omitempty" name:"MaintenanceStart"`

	// 维护时间窗结束时间。
	// - 取值范围为"00:00-23:00"的任意整点或半点,维护时间持续时长最小为30分钟,最大为3小时。
	// - 结束时间务必是基于开始时间向后的时间。
	MaintenanceEnd *string `json:"MaintenanceEnd,omitnil,omitempty" name:"MaintenanceEnd"`
}

func NewSetInstanceMaintenanceRequest added in v1.0.874

func NewSetInstanceMaintenanceRequest() (request *SetInstanceMaintenanceRequest)

func (*SetInstanceMaintenanceRequest) FromJsonString added in v1.0.874

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

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

func (*SetInstanceMaintenanceRequest) ToJsonString added in v1.0.874

func (r *SetInstanceMaintenanceRequest) ToJsonString() string

type SetInstanceMaintenanceRequestParams added in v1.0.874

type SetInstanceMaintenanceRequestParams struct {
	// 指定实例ID。例如:cmgo-p8vn****。请登录 [MongoDB 控制台](https://console.cloud.tencent.com/mongodb)在实例列表复制实例 ID。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// 维护时间窗开始时间。取值范围为"00:00-23:00"的任意整点或半点,如00:00或00:30。
	MaintenanceStart *string `json:"MaintenanceStart,omitnil,omitempty" name:"MaintenanceStart"`

	// 维护时间窗结束时间。
	// - 取值范围为"00:00-23:00"的任意整点或半点,维护时间持续时长最小为30分钟,最大为3小时。
	// - 结束时间务必是基于开始时间向后的时间。
	MaintenanceEnd *string `json:"MaintenanceEnd,omitnil,omitempty" name:"MaintenanceEnd"`
}

Predefined struct for user

type SetInstanceMaintenanceResponse added in v1.0.874

type SetInstanceMaintenanceResponse struct {
	*tchttp.BaseResponse
	Response *SetInstanceMaintenanceResponseParams `json:"Response"`
}

func NewSetInstanceMaintenanceResponse added in v1.0.874

func NewSetInstanceMaintenanceResponse() (response *SetInstanceMaintenanceResponse)

func (*SetInstanceMaintenanceResponse) FromJsonString added in v1.0.874

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

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

func (*SetInstanceMaintenanceResponse) ToJsonString added in v1.0.874

func (r *SetInstanceMaintenanceResponse) ToJsonString() string

type SetInstanceMaintenanceResponseParams added in v1.0.874

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

Predefined struct for user

type ShardInfo

type ShardInfo struct {
	// 分片已使用容量
	UsedVolume *float64 `json:"UsedVolume,omitnil,omitempty" name:"UsedVolume"`

	// 分片ID
	ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"`

	// 分片名
	ReplicaSetName *string `json:"ReplicaSetName,omitnil,omitempty" name:"ReplicaSetName"`

	// 分片内存规格,单位为MB
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 分片磁盘规格,单位为MB
	Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"`

	// 分片Oplog大小,单位为MB
	OplogSize *uint64 `json:"OplogSize,omitnil,omitempty" name:"OplogSize"`

	// 分片从节点数
	SecondaryNum *uint64 `json:"SecondaryNum,omitnil,omitempty" name:"SecondaryNum"`

	// 分片物理id
	RealReplicaSetId *string `json:"RealReplicaSetId,omitnil,omitempty" name:"RealReplicaSetId"`
}

type SlowLogPattern

type SlowLogPattern struct {
	// 慢日志模式
	Pattern *string `json:"Pattern,omitnil,omitempty" name:"Pattern"`

	// 最大执行时间
	MaxTime *uint64 `json:"MaxTime,omitnil,omitempty" name:"MaxTime"`

	// 平均执行时间
	AverageTime *uint64 `json:"AverageTime,omitnil,omitempty" name:"AverageTime"`

	// 该模式慢日志条数
	Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"`
}

type SpecItem

type SpecItem struct {
	// 规格信息标识
	SpecCode *string `json:"SpecCode,omitnil,omitempty" name:"SpecCode"`

	// 规格有效标志,取值:0-停止售卖,1-开放售卖
	Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"`

	// 计算资源规格,单位为CPU核心数
	Cpu *uint64 `json:"Cpu,omitnil,omitempty" name:"Cpu"`

	// 内存规格,单位为MB
	Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"`

	// 默认磁盘规格,单位MB
	DefaultStorage *uint64 `json:"DefaultStorage,omitnil,omitempty" name:"DefaultStorage"`

	// 最大磁盘规格,单位MB
	MaxStorage *uint64 `json:"MaxStorage,omitnil,omitempty" name:"MaxStorage"`

	// 最小磁盘规格,单位MB
	MinStorage *uint64 `json:"MinStorage,omitnil,omitempty" name:"MinStorage"`

	// 可承载qps信息
	Qps *uint64 `json:"Qps,omitnil,omitempty" name:"Qps"`

	// 连接数限制
	Conns *uint64 `json:"Conns,omitnil,omitempty" name:"Conns"`

	// 实例mongodb版本信息
	MongoVersionCode *string `json:"MongoVersionCode,omitnil,omitempty" name:"MongoVersionCode"`

	// 实例mongodb版本号
	MongoVersionValue *uint64 `json:"MongoVersionValue,omitnil,omitempty" name:"MongoVersionValue"`

	// 实例mongodb版本号(短)
	Version *string `json:"Version,omitnil,omitempty" name:"Version"`

	// 存储引擎
	EngineName *string `json:"EngineName,omitnil,omitempty" name:"EngineName"`

	// 集群类型,取值:1-分片集群,0-副本集集群
	ClusterType *uint64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"`

	// 最小副本集从节点数
	MinNodeNum *uint64 `json:"MinNodeNum,omitnil,omitempty" name:"MinNodeNum"`

	// 最大副本集从节点数
	MaxNodeNum *uint64 `json:"MaxNodeNum,omitnil,omitempty" name:"MaxNodeNum"`

	// 最小分片数
	MinReplicateSetNum *uint64 `json:"MinReplicateSetNum,omitnil,omitempty" name:"MinReplicateSetNum"`

	// 最大分片数
	MaxReplicateSetNum *uint64 `json:"MaxReplicateSetNum,omitnil,omitempty" name:"MaxReplicateSetNum"`

	// 最小分片从节点数
	MinReplicateSetNodeNum *uint64 `json:"MinReplicateSetNodeNum,omitnil,omitempty" name:"MinReplicateSetNodeNum"`

	// 最大分片从节点数
	MaxReplicateSetNodeNum *uint64 `json:"MaxReplicateSetNodeNum,omitnil,omitempty" name:"MaxReplicateSetNodeNum"`

	// 机器类型,取值:0-HIO,4-HIO10G
	MachineType *string `json:"MachineType,omitnil,omitempty" name:"MachineType"`
}

type SpecificationInfo

type SpecificationInfo struct {
	// 地域信息
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// 可用区信息
	Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"`

	// 售卖规格信息
	SpecItems []*SpecItem `json:"SpecItems,omitnil,omitempty" name:"SpecItems"`

	// 是否支持跨可用区部署 1-支持,0-不支持
	SupportMultiAZ *int64 `json:"SupportMultiAZ,omitnil,omitempty" name:"SupportMultiAZ"`
}

type TagInfo

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

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

type TerminateDBInstancesRequest added in v1.0.474

type TerminateDBInstancesRequest struct {
	*tchttp.BaseRequest

	// 指定预隔离实例ID。格式如:cmgo-p8vnipr5。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

func NewTerminateDBInstancesRequest added in v1.0.474

func NewTerminateDBInstancesRequest() (request *TerminateDBInstancesRequest)

func (*TerminateDBInstancesRequest) FromJsonString added in v1.0.474

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

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

func (*TerminateDBInstancesRequest) ToJsonString added in v1.0.474

func (r *TerminateDBInstancesRequest) ToJsonString() string

type TerminateDBInstancesRequestParams added in v1.0.474

type TerminateDBInstancesRequestParams struct {
	// 指定预隔离实例ID。格式如:cmgo-p8vnipr5。
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`
}

Predefined struct for user

type TerminateDBInstancesResponse added in v1.0.474

type TerminateDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *TerminateDBInstancesResponseParams `json:"Response"`
}

func NewTerminateDBInstancesResponse added in v1.0.474

func NewTerminateDBInstancesResponse() (response *TerminateDBInstancesResponse)

func (*TerminateDBInstancesResponse) FromJsonString added in v1.0.474

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

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

func (*TerminateDBInstancesResponse) ToJsonString added in v1.0.474

func (r *TerminateDBInstancesResponse) ToJsonString() string

type TerminateDBInstancesResponseParams added in v1.0.474

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

Predefined struct for user

type UserInfo added in v1.0.501

type UserInfo struct {
	// 账号名。
	UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"`

	// 账号权限详情。
	AuthRole []*Auth `json:"AuthRole,omitnil,omitempty" name:"AuthRole"`

	// 账号创建时间。
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// 账号更新时间。
	UpdateTime *string `json:"UpdateTime,omitnil,omitempty" name:"UpdateTime"`

	// 备注信息。
	UserDesc *string `json:"UserDesc,omitnil,omitempty" name:"UserDesc"`
}

Jump to

Keyboard shortcuts

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