v20190725

package
v3.0.430+incompatible Latest Latest
Warning

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

 Go to latest Published: May 9, 2022 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// CAM signature/authentication error
	AUTHFAILURE = "AuthFailure"

	// Internal error
	INTERNALERROR = "InternalError"

	// `appId` verification failed.
	INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"

	// Failed to query the instance.
	INTERNALERROR_FINDINSTANCEFAILED = "InternalError.FindInstanceFailed"

	// Parameter error
	INVALIDPARAMETER = "InvalidParameter"

	// The instance does not support parameter setting.
	INVALIDPARAMETER_CURRENTINSTANCENOTSUPPORTMODIFYPARAMS = "InvalidParameter.CurrentInstanceNotSupportModifyParams"

	// Invalid Vip information
	INVALIDPARAMETER_INVALIDVIP = "InvalidParameter.InvalidVip"

	// The current subaccount has no permission to perform this operation.
	INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"

	// Instances are not purchasable in this AZ.
	INVALIDPARAMETER_ZONECLOSED = "InvalidParameter.ZoneClosed"

	// Invalid parameter value
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// The backup file was not found.
	INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"

	// `appId` verification failed.
	INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed"

	// Invalid instance type.
	INVALIDPARAMETERVALUE_CLUSTERTYPEERROR = "InvalidParameterValue.ClusterTypeError"

	// Invalid instance name
	INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName"

	// Invalid instance status
	INVALIDPARAMETERVALUE_ILLEGALINSTANCESTATUS = "InvalidParameterValue.IllegalInstanceStatus"

	// The instance cannot be deactivated in the current status. Only isolated instances can be deactivated.
	INVALIDPARAMETERVALUE_ILLEGALSTATUSTOOFFLINE = "InvalidParameterValue.IllegalStatusToOffline"

	// The instance has been deleted.
	INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted"

	// The instance has been isolated.
	INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated"

	// Billing error. Corresponding purchase/renewal/configuration change operations are not allowed for the current instance.
	INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation"

	// Instance lock failed.
	INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed"

	// Incorrect model.
	INVALIDPARAMETERVALUE_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError"

	// Memory and disk must be upgraded or degraded simultaneously.
	INVALIDPARAMETERVALUE_MODIFYMODEERROR = "InvalidParameterValue.ModifyModeError"

	// The instance version is incorrect.
	INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError"

	// The instance version does not support querying the instance client information.
	INVALIDPARAMETERVALUE_MONGOVERSIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.MongoVersionNotSupportQueryClient"

	// The instance was not found.
	INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

	// The `OplogSize` parameter is set incorrectly and should be between 10% and 90% of the disk capacity.
	INVALIDPARAMETERVALUE_OPLOGSIZEOUTOFRANGE = "InvalidParameterValue.OplogSizeOutOfRange"

	// The password is non-compliant.
	INVALIDPARAMETERVALUE_PASSWORDRULEFAILED = "InvalidParameterValue.PasswordRuleFailed"

	// The number of postpaid instances in a single region exceeds the limit.
	INVALIDPARAMETERVALUE_POSTPAIDINSTANCEBEYONDLIMIT = "InvalidParameterValue.PostPaidInstanceBeyondLimit"

	// Prepaid instances cannot be terminated.
	INVALIDPARAMETERVALUE_PREPAIDINSTANCEUNABLETOISOLATE = "InvalidParameterValue.PrePaidInstanceUnableToIsolate"

	// The project does not exist.
	INVALIDPARAMETERVALUE_PROJECTNOTFOUND = "InvalidParameterValue.ProjectNotFound"

	// The proxy version does not support querying the instance client information. Please submit a ticket for upgrade.
	INVALIDPARAMETERVALUE_PROXYNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.ProxyNotSupportQueryClient"

	// Only slow logs generated in the past seven days can be queried.
	INVALIDPARAMETERVALUE_QUERYTIMEOUTOFRANGE = "InvalidParameterValue.QueryTimeOutOfRange"

	// Only slow logs generated in the past seven days can be queried.
	INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit"

	// Invalid region
	INVALIDPARAMETERVALUE_REGIONERROR = "InvalidParameterValue.RegionError"

	// The region does not support querying the instance client information.
	INVALIDPARAMETERVALUE_REGIONNOTSUPPORTQUERYCLIENT = "InvalidParameterValue.RegionNotSupportQueryClient"

	// Incorrect number of replica sets (shards).
	INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"

	// Incorrect number of secondary nodes.
	INVALIDPARAMETERVALUE_SECONDARYNUMERROR = "InvalidParameterValue.SecondaryNumError"

	// The disk size to be set cannot be less than 1.2 times the used disk capacity.
	INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed"

	// The value of the `slowMS` parameter should be at least 100 ms.
	INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit"

	// Incorrect purchasable specification.
	INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"

	// The start time should be earlier than the end time.
	INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime"

	// The instance is in a status where operations are not allowed.
	INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"

	// The specified tag was not found.
	INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"

	// The user account does not exist.
	INVALIDPARAMETERVALUE_USERNOTFOUND = "InvalidParameterValue.UserNotFound"

	// The VPC (subnet) was not found.
	INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"

	// Instances are not purchasable in this AZ.
	INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"

	// Invalid availability zone
	INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

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

	// The current version does not support the operation.
	UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"
)
View Source 
const APIVersion = "2019-07-25"

Variables

This section is empty.

Functions

This section is empty.

Types

type AssignProjectRequest 

type AssignProjectRequest struct {
	*tchttp.BaseRequest

	// List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Unique ID of an existing project (instead of a new project).
	ProjectId *uint64 `json:"ProjectId,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 AssignProjectResponse 

type AssignProjectResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of the returned async task IDs
		FlowIds []*uint64 `json:"FlowIds,omitempty" name:"FlowIds"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 BackupDownloadTask 

type BackupDownloadTask struct {

	// Task creation time
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// Backup name
	BackupName *string `json:"BackupName,omitempty" name:"BackupName"`

	// Shard name
	ReplicaSetId *string `json:"ReplicaSetId,omitempty" name:"ReplicaSetId"`

	// Backup size in bytes
	BackupSize *int64 `json:"BackupSize,omitempty" name:"BackupSize"`

	// Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Task progress in percentage
	Percent *int64 `json:"Percent,omitempty" name:"Percent"`

	// Task duration in seconds
	TimeSpend *int64 `json:"TimeSpend,omitempty" name:"TimeSpend"`

	// Backup download address
	Url *string `json:"Url,omitempty" name:"Url"`

	// Backup type of the backup file. Valid values: `0` (logical backup), `1` (physical backup)
	BackupMethod *int64 `json:"BackupMethod,omitempty" name:"BackupMethod"`

	// Backup description you set when starting a backup task
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	BackupDesc *string `json:"BackupDesc,omitempty" name:"BackupDesc"`
}

type BackupDownloadTaskStatus 

type BackupDownloadTaskStatus struct {

	// Shard name
	ReplicaSetId *string `json:"ReplicaSetId,omitempty" name:"ReplicaSetId"`

	// Task status. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry)
	Status *int64 `json:"Status,omitempty" name:"Status"`
}

type BackupFile 

type BackupFile struct {

	// ID of the replica set/shard to which a backup file belongs
	ReplicateSetId *string `json:"ReplicateSetId,omitempty" name:"ReplicateSetId"`

	// Path to a backup file
	File *string `json:"File,omitempty" name:"File"`
}

type BackupInfo 

type BackupInfo struct {

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Backup mode. 0: automatic backup; 1: manual backup
	BackupType *uint64 `json:"BackupType,omitempty" name:"BackupType"`

	// Backup name
	BackupName *string `json:"BackupName,omitempty" name:"BackupName"`

	// Backup remarks
	// Note: This field may return null, indicating that no valid values can be obtained.
	BackupDesc *string `json:"BackupDesc,omitempty" name:"BackupDesc"`

	// Backup file size in KB
	// Note: This field may return null, indicating that no valid values can be obtained.
	BackupSize *uint64 `json:"BackupSize,omitempty" name:"BackupSize"`

	// Backup start time
	// Note: This field may return null, indicating that no valid values can be obtained.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// Backup end time
	// Note: This field may return null, indicating that no valid values can be obtained.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Backup status. 1: backing up; 2: backed up successful
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Backup method. 0: logical backup; 1: physical backup
	BackupMethod *uint64 `json:"BackupMethod,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 This API is used to specify the project to which a TencentDB instance belongs.

error code that may be returned: 

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

func (*Client) AssignProjectWithContext 

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

AssignProject This API is used to specify the project to which a TencentDB instance belongs.

error code that may be returned: 

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

func (*Client) CreateBackupDBInstance 

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

CreateBackupDBInstance This API is used to create instance backups.

error code that may be returned: 

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 

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

CreateBackupDBInstance This API is used to create instance backups.

error code that may be returned: 

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 This API is used to create a backup download task.

error code that may be returned: 

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

func (*Client) CreateBackupDownloadTaskWithContext 

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

CreateBackupDownloadTask This API is used to create a backup download task.

error code that may be returned: 

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 This API is used to create a monthly subscription TencentDB for MongoDB instance. The purchasable specifications supported by this API can be obtained through the `DescribeSpecInfo` API.

error code that may be returned: 

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 This API is used to create a pay-as-you-go TencentDB for MongoDB instance.

error code that may be returned: 

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_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) CreateDBInstanceHourWithContext 

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

CreateDBInstanceHour This API is used to create a pay-as-you-go TencentDB for MongoDB instance.

error code that may be returned: 

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_TAGNOTFOUND = "InvalidParameterValue.TagNotFound"
INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"

func (*Client) CreateDBInstanceWithContext 

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

CreateDBInstance This API is used to create a monthly subscription TencentDB for MongoDB instance. The purchasable specifications supported by this API can be obtained through the `DescribeSpecInfo` API.

error code that may be returned: 

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

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

DescribeAsyncRequestInfo This API is used to query async task status.

error code that may be returned: 

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

func (*Client) DescribeAsyncRequestInfoWithContext 

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

DescribeAsyncRequestInfo This API is used to query async task status.

error code that may be returned: 

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

func (*Client) DescribeBackupAccess 

func (c *Client) DescribeBackupAccess(request *DescribeBackupAccessRequest) (response *DescribeBackupAccessResponse, err error)

DescribeBackupAccess 备份下载功能已调整，此接口即将下线

TencentDB will soon stop supporting this API as the backup download feature has been modified.

This API is used to get the permission to download a backup file. The detailed backup file information can be obtained through the `DescribeDBBackups` API.

error code that may be returned: 

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeBackupAccessWithContext 

func (c *Client) DescribeBackupAccessWithContext(ctx context.Context, request *DescribeBackupAccessRequest) (response *DescribeBackupAccessResponse, err error)

DescribeBackupAccess 备份下载功能已调整，此接口即将下线

TencentDB will soon stop supporting this API as the backup download feature has been modified.

This API is used to get the permission to download a backup file. The detailed backup file information can be obtained through the `DescribeDBBackups` API.

error code that may be returned: 

INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_BACKUPFILENOTFOUND = "InvalidParameterValue.BackupFileNotFound"
INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) DescribeBackupDownloadTask 

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

DescribeBackupDownloadTask This API is used to query backup download task information.

error code that may be returned: 

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

func (*Client) DescribeBackupDownloadTaskWithContext 

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

DescribeBackupDownloadTask This API is used to query backup download task information.

error code that may be returned: 

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 This API is used to query the client connection information of an instance, including the IP and number of connections. Currently, only instances of MongoDB 3.2 are supported.

error code that may be returned: 

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

func (*Client) DescribeClientConnectionsWithContext 

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

DescribeClientConnections This API is used to query the client connection information of an instance, including the IP and number of connections. Currently, only instances of MongoDB 3.2 are supported.

error code that may be returned: 

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

func (*Client) DescribeDBBackups 

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

DescribeDBBackups This API is used to query the list of instance backups. Currently, only backups created in the last seven days can be queried.

error code that may be returned: 

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

func (*Client) DescribeDBBackupsWithContext 

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

DescribeDBBackups This API is used to query the list of instance backups. Currently, only backups created in the last seven days can be queried.

error code that may be returned: 

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

func (*Client) DescribeDBInstanceDeal 

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

DescribeDBInstanceDeal This API is used to get details of purchase, renewal, and specification adjustment orders of a MongoDB instance.

error code that may be returned: 

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

func (*Client) DescribeDBInstanceDealWithContext 

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

DescribeDBInstanceDeal This API is used to get details of purchase, renewal, and specification adjustment orders of a MongoDB instance.

error code that may be returned: 

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

func (*Client) DescribeDBInstances 

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

DescribeDBInstances This API is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances). It supports filtering instances by project ID, instance ID, and instance status.

error code that may be returned: 

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

func (*Client) DescribeDBInstancesWithContext 

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

DescribeDBInstances This API is used to query the list of TencentDB instances (which can be primary, disaster recovery, or read-only instances). It supports filtering instances by project ID, instance ID, and instance status.

error code that may be returned: 

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

func (*Client) DescribeInstanceParams 

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

DescribeInstanceParams This API is used to query the modifiable parameter list of an instance.

error code that may be returned: 

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

func (*Client) DescribeInstanceParamsWithContext 

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

DescribeInstanceParams This API is used to query the modifiable parameter list of an instance.

error code that may be returned: 

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 This API is used to query the security groups associated with an instance.

error code that may be returned: 

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

func (*Client) DescribeSecurityGroupWithContext 

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

DescribeSecurityGroup This API is used to query the security groups associated with an instance.

error code that may be returned: 

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

func (*Client) DescribeSlowLogPatterns 

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

DescribeSlowLogPatterns This API is used to get the slow log statistics of a database instance.

error code that may be returned: 

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 

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

DescribeSlowLogPatterns This API is used to get the slow log statistics of a database instance.

error code that may be returned: 

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 This API is used to get the slow log information of a TencentDB instance. Only slow logs for the last 7 days can be queried.

error code that may be returned: 

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 

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

DescribeSlowLogs This API is used to get the slow log information of a TencentDB instance. Only slow logs for the last 7 days can be queried.

error code that may be returned: 

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 This API is used to query the purchasable instance specifications.

error code that may be returned: 

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

func (*Client) DescribeSpecInfoWithContext 

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

DescribeSpecInfo This API is used to query the purchasable instance specifications.

error code that may be returned: 

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

func (*Client) FlushInstanceRouterConfig 

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

FlushInstanceRouterConfig This API is used to run the `FlushRouterConfig` command on all mongos instances.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) FlushInstanceRouterConfigWithContext 

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

FlushInstanceRouterConfig This API is used to run the `FlushRouterConfig` command on all mongos instances.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed"
INVALIDPARAMETERVALUE = "InvalidParameterValue"

func (*Client) InquirePriceCreateDBInstances 

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

InquirePriceCreateDBInstances This API is used to query price of instance creation. The `region` parameter must be passed in this API, otherwise verification will fail. This API allows queries only for purchasable instance specifications.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

func (*Client) InquirePriceCreateDBInstancesWithContext 

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

InquirePriceCreateDBInstances This API is used to query price of instance creation. The `region` parameter must be passed in this API, otherwise verification will fail. This API allows queries only for purchasable instance specifications.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError"
INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale"
INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"

func (*Client) InquirePriceModifyDBInstanceSpec 

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

InquirePriceModifyDBInstanceSpec This API is used to query price of instance specification adjustment.

error code that may be returned: 

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

func (*Client) InquirePriceModifyDBInstanceSpecWithContext 

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

InquirePriceModifyDBInstanceSpec This API is used to query price of instance specification adjustment.

error code that may be returned: 

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 This API is used to query the renewal price of a monthly subscription instance.

error code that may be returned: 

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

func (*Client) InquirePriceRenewDBInstancesWithContext 

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

InquirePriceRenewDBInstances This API is used to query the renewal price of a monthly subscription instance.

error code that may be returned: 

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 This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. An isolated instance is retained in the recycle bin and data can no longer be written to it. After it is isolated for a certain period of time, it will be completely deleted. For the retention period in the recycle bin, please see the terms of service for pay-as-you-go billing. Isolated pay-as-you-go instances cannot be recovered, so please proceed with caution.

error code that may be returned: 

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 

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

IsolateDBInstance This API is used to isolate a pay-as-you-go TencentDB for MongoDB instance. An isolated instance is retained in the recycle bin and data can no longer be written to it. After it is isolated for a certain period of time, it will be completely deleted. For the retention period in the recycle bin, please see the terms of service for pay-as-you-go billing. Isolated pay-as-you-go instances cannot be recovered, so please proceed with caution.

error code that may be returned: 

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

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

ModifyDBInstanceNetworkAddress This API is used to modify the network settings of a TencentDB instance, such as switching its network type from classic network to VPC or between VPCs.

error code that may be returned: 

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

func (*Client) ModifyDBInstanceNetworkAddressWithContext 

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

ModifyDBInstanceNetworkAddress This API is used to modify the network settings of a TencentDB instance, such as switching its network type from classic network to VPC or between VPCs.

error code that may be returned: 

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

func (*Client) ModifyDBInstanceSecurityGroup 

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

ModifyDBInstanceSecurityGroup This API is used to modify the security groups associated with an instance.

error code that may be returned: 

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

func (*Client) ModifyDBInstanceSecurityGroupWithContext 

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

ModifyDBInstanceSecurityGroup This API is used to modify the security groups associated with an instance.

error code that may be returned: 

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

func (*Client) ModifyDBInstanceSpec 

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

ModifyDBInstanceSpec This API is used to adjust the specification configuration of a TencentDB for MongoDB. The purchasable specifications supported by the API can be obtained through the DescribeSpecInfo API.

error code that may be returned: 

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 

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

ModifyDBInstanceSpec This API is used to adjust the specification configuration of a TencentDB for MongoDB. The purchasable specifications supported by the API can be obtained through the DescribeSpecInfo API.

error code that may be returned: 

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 This API is used to deactivate isolated TencentDB instances immediately. The instances must be in isolated status.

error code that may be returned: 

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

func (*Client) OfflineIsolatedDBInstanceWithContext 

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

OfflineIsolatedDBInstance This API is used to deactivate isolated TencentDB instances immediately. The instances must be in isolated status.

error code that may be returned: 

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

func (*Client) RenameInstance 

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

RenameInstance This API is used to rename a TencentDB instance.

error code that may be returned: 

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 

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

RenameInstance This API is used to rename a TencentDB instance.

error code that may be returned: 

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 This API is used to renew a monthly subscription TencentDB instance. Only monthly subscription instances are supported, while pay-as-you-go instances do not need to be renewed.

error code that may be returned: 

INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) RenewDBInstancesWithContext 

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

RenewDBInstances This API is used to renew a monthly subscription TencentDB instance. Only monthly subscription instances are supported, while pay-as-you-go instances do not need to be renewed.

error code that may be returned: 

INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"

func (*Client) ResetDBInstancePassword 

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

ResetDBInstancePassword This API is used to modify instance password.

error code that may be returned: 

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 

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

ResetDBInstancePassword This API is used to modify instance password.

error code that may be returned: 

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"

type ClientConnection 

type ClientConnection struct {

	// Client IP of a connection
	IP *string `json:"IP,omitempty" name:"IP"`

	// Number of connections corresponding to a client IP
	Count *uint64 `json:"Count,omitempty" name:"Count"`

	// Whether it is the Tencent Cloud IP for automated testing
	InternalService *bool `json:"InternalService,omitempty" name:"InternalService"`
}

type CreateBackupDBInstanceRequest 

type CreateBackupDBInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Valid values: 0 (logical backup), 1 (physical backup)
	BackupMethod *int64 `json:"BackupMethod,omitempty" name:"BackupMethod"`

	// Backup remarks
	BackupRemark *string `json:"BackupRemark,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 CreateBackupDBInstanceResponse 

type CreateBackupDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The status of the queried backup process.
		AsyncRequestId *string `json:"AsyncRequestId,omitempty" name:"AsyncRequestId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 CreateBackupDownloadTaskRequest 

type CreateBackupDownloadTaskRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// The name of the backup file to be downloaded, which can be obtained by the `DescribeDBBackups` API.
	BackupName *string `json:"BackupName,omitempty" name:"BackupName"`

	// Specify the node name of a replica set instance or the shard name list of a sharded cluster instance. Only backups of the specified node or shards will be downloaded.
	// Suppose you have a replica set instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0` to download the full backup. For a replica set instance, the parameter value must be in the format of "instance ID_0".
	// Suppose you have a sharded cluster instance (ID: cmgo-p8vnipr5), you can use the sample code `BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1` to download the backup data of shard 0 and shard 1. To download the full backup, please specify all shard names.
	BackupSets []*ReplicaSetInfo `json:"BackupSets,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 CreateBackupDownloadTaskResponse 

type CreateBackupDownloadTaskResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Download task status
		Tasks []*BackupDownloadTaskStatus `json:"Tasks,omitempty" name:"Tasks"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 CreateDBInstanceHourRequest 

type CreateDBInstanceHourRequest struct {
	*tchttp.BaseRequest

	// Instance memory size in GB
	Memory *uint64 `json:"Memory,omitempty" name:"Memory"`

	// Instance disk size in GB
	Volume *uint64 `json:"Volume,omitempty" name:"Volume"`

	// Number of replica sets. When a replica set instance is created, this parameter must be set to 1. When a sharding instance is created, please see the parameters returned by the DescribeSpecInfo API
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitempty" name:"ReplicateSetNum"`

	// The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition; MONGO_42_WT: MongoDB 4.2 WiredTiger Edition.
	MongoVersion *string `json:"MongoVersion,omitempty" name:"MongoVersion"`

	// Server type. HIO: high IO; HIO10G: 10-Gigabit high IO
	MachineCode *string `json:"MachineCode,omitempty" name:"MachineCode"`

	// Number of instances. Minimum value: 1. Maximum value: 10
	GoodsNum *uint64 `json:"GoodsNum,omitempty" name:"GoodsNum"`

	// AZ in the format of ap-guangzhou-2. If multi-AZ deployment is enabled, this parameter refers to the primary AZ and must be one of the values of `AvailabilityZoneList`.
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// Instance type. REPLSET: replica set; SHARD: sharding cluster
	ClusterType *string `json:"ClusterType,omitempty" name:"ClusterType"`

	// VPC ID. If this parameter is not set, the basic network will be selected by default
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// VPC subnet ID. If VpcId is set, then SubnetId will be required
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Instance password, which must contain 8 to 16 characters and comprise at least two of the following types: letters, digits, and symbols (!@#%^*()). If it is left empty, the password is in the format of "instance ID+@+root account UIN". For example, if the instance ID is "cmgo-higv73ed" and the root account UIN "100000001", the instance password will be "cmgo-higv73ed@100000001".
	Password *string `json:"Password,omitempty" name:"Password"`

	// Project ID. If this parameter is not set, the default project will be used
	ProjectId *int64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// Instance tag information
	Tags []*TagInfo `json:"Tags,omitempty" name:"Tags"`

	// Instance type. Valid values: `1` (primary instance), `2` (temp instance), `3` (read-only instance), `4` (disaster recovery instance), `5` (cloned instance).
	Clone *int64 `json:"Clone,omitempty" name:"Clone"`

	// Parent instance ID. It is required if the `Clone` is 3 or 4.
	Father *string `json:"Father,omitempty" name:"Father"`

	// Security group.
	SecurityGroup []*string `json:"SecurityGroup,omitempty" name:"SecurityGroup"`

	// The point in time to which the cloned instance will be rolled back. This parameter is required for a cloned instance. The point in time in the format of 2021-08-13 16:30:00 must be within the last seven days.
	RestoreTime *string `json:"RestoreTime,omitempty" name:"RestoreTime"`

	// Instance name, which can contain up to 60 letters, digits, or symbols (_-).
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// AZ list when multi-AZ deployment is enabled. For the specific purchasable versions which support multi-AZ deployment, please see the return result of the `DescribeSpecInfo` API. Notes: 1. Nodes of a multi-AZ instance must be deployed across three AZs. 2. To ensure a successful cross-AZ switch, you should not deploy most of the nodes to the same AZ. (For example, a three-node sharded cluster instance does not support deploying two or more nodes in the same AZ.) 3. MongoDB 4.2 and later versions do not support multi-AZ deployment. 4. Read-Only and disaster recovery instances do not support multi-AZ deployment. 5. Instances in the classic network do not support multi-AZ deployment.
	AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitempty" name:"AvailabilityZoneList"`

	// The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.
	MongosCpu *uint64 `json:"MongosCpu,omitempty" name:"MongosCpu"`

	// The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.
	MongosMemory *uint64 `json:"MongosMemory,omitempty" name:"MongosMemory"`

	// The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. Note: please purchase 3-32 mongos routers for high availability.
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitempty" name:"MongosNodeNum"`
}

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 CreateDBInstanceHourResponse 

type CreateDBInstanceHourResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Order ID
		DealId *string `json:"DealId,omitempty" name:"DealId"`

		// List of IDs of created instances
		InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 CreateDBInstanceRequest 

type CreateDBInstanceRequest struct {
	*tchttp.BaseRequest

	// The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Instance memory size in GB.
	Memory *uint64 `json:"Memory,omitempty" name:"Memory"`

	// Instance disk size in GB.
	Volume *uint64 `json:"Volume,omitempty" name:"Volume"`

	// Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition; MONGO_42_WT: MongoDB 4.2 WiredTiger Edition.
	MongoVersion *string `json:"MongoVersion,omitempty" name:"MongoVersion"`

	// Number of instances. Minimum value: 1. Maximum value: 10.
	GoodsNum *uint64 `json:"GoodsNum,omitempty" name:"GoodsNum"`

	// AZ in the format of ap-guangzhou-2. If multi-AZ deployment is enabled, this parameter refers to the primary AZ and must be one of the values of `AvailabilityZoneList`.
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
	Period *uint64 `json:"Period,omitempty" name:"Period"`

	// Server type. Valid values: HIO (high IO), HIO10G (10-gigabit high IO), STDS5 (standard).
	MachineCode *string `json:"MachineCode,omitempty" name:"MachineCode"`

	// Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).
	ClusterType *string `json:"ClusterType,omitempty" name:"ClusterType"`

	// Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitempty" name:"ReplicateSetNum"`

	// Project ID. If this parameter is not set, the default project will be used.
	ProjectId *int64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// VPC ID. If this parameter is not set, the classic network will be used. Please use the `DescribeVpcs` API to query the VPC list.
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// VPC subnet ID. If `UniqVpcId` is set, then `UniqSubnetId` will be required. Please use the `DescribeSubnets` API to query the subnet list.
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Instance password, which must contain 8 to 16 characters and comprise at least two of the following types: letters, digits, and symbols (!@#%^*()). If it is left empty, the password is in the format of "instance ID+@+root account UIN". For example, if the instance ID is "cmgo-higv73ed" and the root account UIN "100000001", the instance password will be "cmgo-higv73ed@100000001".
	Password *string `json:"Password,omitempty" name:"Password"`

	// Instance tag information.
	Tags []*TagInfo `json:"Tags,omitempty" name:"Tags"`

	// Auto-renewal flag. Valid values: 0 (auto-renewal not enabled), 1 (auto-renewal enabled). Default value: 0.
	AutoRenewFlag *uint64 `json:"AutoRenewFlag,omitempty" name:"AutoRenewFlag"`

	// Whether to automatically use a voucher. Valid values: 1 (yes), 0 (no). Default value: 0.
	AutoVoucher *uint64 `json:"AutoVoucher,omitempty" name:"AutoVoucher"`

	// Instance type. Valid values: `1` (primary instance), `2` (temp instance), `3` (read-only instance), `4` (disaster recovery instance), `5` (cloned instance).
	Clone *int64 `json:"Clone,omitempty" name:"Clone"`

	// Primary instance ID. It is required for read-only, disaster recovery, and cloned instances.
	Father *string `json:"Father,omitempty" name:"Father"`

	// Security group.
	SecurityGroup []*string `json:"SecurityGroup,omitempty" name:"SecurityGroup"`

	// The point in time to which the cloned instance will be rolled back. This parameter is required for a cloned instance. The point in time in the format of 2021-08-13 16:30:00 must be within the last seven days.
	RestoreTime *string `json:"RestoreTime,omitempty" name:"RestoreTime"`

	// Instance name, which can contain up to 60 letters, digits, or symbols (_-).
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// AZ list when multi-AZ deployment is enabled. For the specific purchasable versions which support multi-AZ deployment, please see the return result of the `DescribeSpecInfo` API. Notes: 1. Nodes of a multi-AZ instance must be deployed across three AZs. 2. To ensure a successful cross-AZ switch, you should not deploy most of the nodes to the same AZ. (For example, a three-node sharded cluster instance does not support deploying two or more nodes in the same AZ.) 3. MongoDB 4.2 and later versions do not support multi-AZ deployment. 4. Read-Only and disaster recovery instances do not support multi-AZ deployment. 5. Instances in the classic network do not support multi-AZ deployment.
	AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitempty" name:"AvailabilityZoneList"`

	// The number of mongos CPUs, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.
	MongosCpu *uint64 `json:"MongosCpu,omitempty" name:"MongosCpu"`

	// The size of mongos memory, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API.
	MongosMemory *uint64 `json:"MongosMemory,omitempty" name:"MongosMemory"`

	// The number of mongos routers, which is required for a sharded cluster instance of MongoDB 4.2 WiredTiger. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. Note: please purchase 3-32 mongos routers for high availability.
	MongosNodeNum *uint64 `json:"MongosNodeNum,omitempty" name:"MongosNodeNum"`
}

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 CreateDBInstanceResponse 

type CreateDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Order ID.
		DealId *string `json:"DealId,omitempty" name:"DealId"`

		// List of IDs of created instances.
		InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DBInstanceInfo 

type DBInstanceInfo struct {

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Region information
	Region *string `json:"Region,omitempty" name:"Region"`
}

type DBInstancePrice 

type DBInstancePrice struct {

	// Unit price.
	// Note: this field may return null, indicating that no valid values can be obtained.
	UnitPrice *float64 `json:"UnitPrice,omitempty" name:"UnitPrice"`

	// Original price.
	OriginalPrice *float64 `json:"OriginalPrice,omitempty" name:"OriginalPrice"`

	// Discounted price.
	DiscountPrice *float64 `json:"DiscountPrice,omitempty" name:"DiscountPrice"`
}

type DescribeAsyncRequestInfoRequest 

type DescribeAsyncRequestInfoRequest struct {
	*tchttp.BaseRequest

	// Async task ID, which is returned by APIs related to async tasks, such as `CreateBackupDBInstance`.
	AsyncRequestId *string `json:"AsyncRequestId,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 DescribeAsyncRequestInfoResponse 

type DescribeAsyncRequestInfoResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Status. Valid values: `initial` (initializing), `running`, `paused` (paused due to failure), `undoed` (rolled back due to failure), `failed` (ended due to failure), `success`
		Status *string `json:"Status,omitempty" name:"Status"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeBackupAccessRequest 

type DescribeBackupAccessRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Name of the backup file for which to get the download permission
	BackupName *string `json:"BackupName,omitempty" name:"BackupName"`
}

func NewDescribeBackupAccessRequest 

func NewDescribeBackupAccessRequest() (request *DescribeBackupAccessRequest)

func (*DescribeBackupAccessRequest) FromJsonString 

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

func (r *DescribeBackupAccessRequest) ToJsonString() string

type DescribeBackupAccessResponse 

type DescribeBackupAccessResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Instance region
		Region *string `json:"Region,omitempty" name:"Region"`

		// The bucket where a backup file is located
		Bucket *string `json:"Bucket,omitempty" name:"Bucket"`

		// Storage information of a backup file
		Files []*BackupFile `json:"Files,omitempty" name:"Files"`

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

func NewDescribeBackupAccessResponse 

func NewDescribeBackupAccessResponse() (response *DescribeBackupAccessResponse)

func (*DescribeBackupAccessResponse) FromJsonString 

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

func (r *DescribeBackupAccessResponse) ToJsonString() string

type DescribeBackupDownloadTaskRequest 

type DescribeBackupDownloadTaskRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of "cmgo-p8vnipr5", which is the same as the instance ID displayed in the TencentDB console
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// The name of a backup file with download tasks to be queried
	BackupName *string `json:"BackupName,omitempty" name:"BackupName"`

	// The start time of the query period. Tasks whose start time and end time fall within the query period will be queried. If it is left empty, the start time can be any time earlier than the end time.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// The end time of the query period. Tasks will be queried if their start and end times fall within the query period. If it is left empty, the end time can be any time later than the start time.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// The maximum number of results returned per page. Value range: 1-100. Default value: `20`.
	Limit *int64 `json:"Limit,omitempty" name:"Limit"`

	// Offset for pagination. Default value: `0`.
	Offset *int64 `json:"Offset,omitempty" name:"Offset"`

	// The field used to sort the results. Valid values: `createTime` (default), `finishTime`.
	OrderBy *string `json:"OrderBy,omitempty" name:"OrderBy"`

	// Sort order. Valid values: `asc`, `desc` (default).
	OrderByType *string `json:"OrderByType,omitempty" name:"OrderByType"`

	// The status of the tasks to be queried. Valid values: `0` (waiting for execution), `1` (downloading), `2` (downloaded), `3` (download failed), `4` (waiting for retry). If it is left empty, tasks in any status will be returned.
	Status []*int64 `json:"Status,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 DescribeBackupDownloadTaskResponse 

type DescribeBackupDownloadTaskResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of results
		TotalCount *int64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// The list of download tasks
		Tasks []*BackupDownloadTask `json:"Tasks,omitempty" name:"Tasks"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeClientConnectionsRequest 

type DescribeClientConnectionsRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Number of results to be returned for a single request. Value range: 1-1,000. Default value: 1,000
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. Default value: 0.
	Offset *uint64 `json:"Offset,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 DescribeClientConnectionsResponse 

type DescribeClientConnectionsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Client connection information, including client IP and number of connections
		Clients []*ClientConnection `json:"Clients,omitempty" name:"Clients"`

		// The total number of records that meet the query condition, which can be used for paginated queries.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeDBBackupsRequest 

type DescribeDBBackupsRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Backup mode. Valid values: `0` (logical backup), `1` (physical backup), `2` (both modes). Default value: `0`.
	BackupMethod *int64 `json:"BackupMethod,omitempty" name:"BackupMethod"`

	// Number of entries per page. Maximum value: `100`. If this parameter is left empty, all entries will be returned.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Pagination offset, starting from `0`. Default value: `0`.
	Offset *uint64 `json:"Offset,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 DescribeDBBackupsResponse 

type DescribeDBBackupsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Backup list
		BackupList []*BackupInfo `json:"BackupList,omitempty" name:"BackupList"`

		// Total number of backups
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeDBInstanceDealRequest 

type DescribeDBInstanceDealRequest struct {
	*tchttp.BaseRequest

	// Order ID. It is returned by the `CreateDBInstance` and other APIs.
	DealId *string `json:"DealId,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 DescribeDBInstanceDealResponse 

type DescribeDBInstanceDealResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Order status. Valid values: 1 (unpaid), 2 (paid), 3 (delivering), 4 (delivered), 5 (delivery failed), 6 (refunded), 7 (order closed), 8 (order closed because it failed to be paid within timeout period).
		Status *int64 `json:"Status,omitempty" name:"Status"`

		// Original price of the order.
		OriginalPrice *float64 `json:"OriginalPrice,omitempty" name:"OriginalPrice"`

		// Discounted price of the order.
		DiscountPrice *float64 `json:"DiscountPrice,omitempty" name:"DiscountPrice"`

		// Operation performed by the order. Valid values: purchase, renew, upgrade, downgrade, refund.
		Action *string `json:"Action,omitempty" name:"Action"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeDBInstancesRequest 

type DescribeDBInstancesRequest struct {
	*tchttp.BaseRequest

	// List of instance IDs in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// Instance type. Valid values: 0 (all instances), 1 (promoted), 2 (temp), 3 (read-only), -1 (promoted + read-only + disaster recovery)
	InstanceType *int64 `json:"InstanceType,omitempty" name:"InstanceType"`

	// Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance), -1 (all instances)
	ClusterType *int64 `json:"ClusterType,omitempty" name:"ClusterType"`

	// Instance status. Valid values: `0` (to be initialized), `1` (executing task), `2` (running), `-2` (isolated monthly-subscribed instance), `-3` (isolated pay-as-you-go instance)
	Status []*int64 `json:"Status,omitempty" name:"Status"`

	// VPC ID. This parameter can be left empty for the basic network
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// Subnet ID of VPC. This parameter can be left empty for the basic network. If it is passed in as an input parameter, the corresponding VpcId must be set
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Billing type. Valid value: 0 (pay-as-you-go)
	PayMode *int64 `json:"PayMode,omitempty" name:"PayMode"`

	// Number of results to be returned for a single request. Valid values: 1-100. Default value: 20
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Offset. Default value: 0
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Sort by field of the returned result set. Currently, supported values include "ProjectId", "InstanceName", and "CreateTime". The return results are sorted in ascending order by default.
	OrderBy *string `json:"OrderBy,omitempty" name:"OrderBy"`

	// Sorting method of the return result set. Currently, "ASC" or "DESC" is supported
	OrderByType *string `json:"OrderByType,omitempty" name:"OrderByType"`

	// Project ID
	ProjectIds []*uint64 `json:"ProjectIds,omitempty" name:"ProjectIds"`

	// Search keyword, which can be instance ID, instance name, or complete IP
	SearchKey *string `json:"SearchKey,omitempty" name:"SearchKey"`

	// Tag information
	Tags *TagInfo `json:"Tags,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 DescribeDBInstancesResponse 

type DescribeDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Number of eligible instances.
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

		// List of instance details
		InstanceDetails []*InstanceDetail `json:"InstanceDetails,omitempty" name:"InstanceDetails"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeInstanceParamsRequest 

type DescribeInstanceParamsRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`
}

func NewDescribeInstanceParamsRequest 

func NewDescribeInstanceParamsRequest() (request *DescribeInstanceParamsRequest)

func (*DescribeInstanceParamsRequest) FromJsonString 

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 

func (r *DescribeInstanceParamsRequest) ToJsonString() string

type DescribeInstanceParamsResponse 

type DescribeInstanceParamsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The collection of enum parameters
		InstanceEnumParam []*InstanceEnumParam `json:"InstanceEnumParam,omitempty" name:"InstanceEnumParam"`

		// The collection of integer parameters
		InstanceIntegerParam []*InstanceIntegerParam `json:"InstanceIntegerParam,omitempty" name:"InstanceIntegerParam"`

		// The collection of text parameters
		InstanceTextParam []*InstanceTextParam `json:"InstanceTextParam,omitempty" name:"InstanceTextParam"`

		// The collection of string parameters used to represent time ranges
		InstanceMultiParam []*InstanceMultiParam `json:"InstanceMultiParam,omitempty" name:"InstanceMultiParam"`

		// The total number of modifiable parameters of the instance, such as 0
		TotalCount *uint64 `json:"TotalCount,omitempty" name:"TotalCount"`

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

func NewDescribeInstanceParamsResponse 

func NewDescribeInstanceParamsResponse() (response *DescribeInstanceParamsResponse)

func (*DescribeInstanceParamsResponse) FromJsonString 

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 

func (r *DescribeInstanceParamsResponse) ToJsonString() string

type DescribeSecurityGroupRequest 

type DescribeSecurityGroupRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of "cmgo-p8vnipr5"
	InstanceId *string `json:"InstanceId,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 DescribeSecurityGroupResponse 

type DescribeSecurityGroupResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Security groups associated with the instance
		Groups []*SecurityGroup `json:"Groups,omitempty" name:"Groups"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeSlowLogPatternsRequest 

type DescribeSlowLogPatternsRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Threshold of slow log execution time in milliseconds. Minimum value: 100. Slow logs whose execution time exceeds the threshold will be returned.
	SlowMS *uint64 `json:"SlowMS,omitempty" name:"SlowMS"`

	// Offset. Minimum value: 0. Maximum value: 10000. Default value: 0.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Slow log format, which can be JSON. If this parameter is left empty, the slow log will be returned in its native format.
	Format *string `json:"Format,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 DescribeSlowLogPatternsResponse 

type DescribeSlowLogPatternsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of slow logs
		Count *uint64 `json:"Count,omitempty" name:"Count"`

		// Slow log statistics
		SlowLogPatterns []*SlowLogPattern `json:"SlowLogPatterns,omitempty" name:"SlowLogPatterns"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeSlowLogsRequest 

type DescribeSlowLogsRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of `cmgo-p8vnipr5`, which is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Start time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-01 10:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
	StartTime *string `json:"StartTime,omitempty" name:"StartTime"`

	// End time of slow log in the format of `yyyy-mm-dd hh:mm:ss`, such as 2019-06-02 12:00:00. The query time range cannot exceed 24 hours. Only slow logs for the last 7 days can be queried.
	EndTime *string `json:"EndTime,omitempty" name:"EndTime"`

	// Threshold of slow log execution time in milliseconds. Minimum value: 100. Slow logs whose execution time exceeds the threshold will be returned.
	SlowMS *uint64 `json:"SlowMS,omitempty" name:"SlowMS"`

	// Offset. Minimum value: 0. Maximum value: 10000. Default value: 0.
	Offset *uint64 `json:"Offset,omitempty" name:"Offset"`

	// Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20.
	Limit *uint64 `json:"Limit,omitempty" name:"Limit"`

	// Slow log format, which can be JSON. If this parameter is left empty, the slow log will be returned in its native format.
	Format *string `json:"Format,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 DescribeSlowLogsResponse 

type DescribeSlowLogsResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Total number of slow logs
		Count *uint64 `json:"Count,omitempty" name:"Count"`

		// Slow log details
		SlowLogs []*string `json:"SlowLogs,omitempty" name:"SlowLogs"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 DescribeSpecInfoRequest 

type DescribeSpecInfoRequest struct {
	*tchttp.BaseRequest

	// AZ to be queried
	Zone *string `json:"Zone,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 DescribeSpecInfoResponse 

type DescribeSpecInfoResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// List of purchasable instance specifications
		SpecInfoList []*SpecificationInfo `json:"SpecInfoList,omitempty" name:"SpecInfoList"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 FlushInstanceRouterConfigRequest 

type FlushInstanceRouterConfigRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,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 FlushInstanceRouterConfigResponse 

type FlushInstanceRouterConfigResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 InquirePriceCreateDBInstancesRequest 

type InquirePriceCreateDBInstancesRequest struct {
	*tchttp.BaseRequest

	// Instance region name in the format of ap-guangzhou-2.
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// The number of nodes in each replica set. The value range is subject to the response parameter of the `DescribeSpecInfo` API.
	NodeNum *int64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Instance memory size in GB.
	Memory *int64 `json:"Memory,omitempty" name:"Memory"`

	// Instance disk size in GB.
	Volume *int64 `json:"Volume,omitempty" name:"Volume"`

	// Version number. For the specific purchasable versions supported, please see the return result of the `DescribeSpecInfo` API. The correspondences between parameters and versions are as follows: MONGO_3_WT: MongoDB 3.2 WiredTiger Edition; MONGO_3_ROCKS: MongoDB 3.2 RocksDB Edition; MONGO_36_WT: MongoDB 3.6 WiredTiger Edition; MONGO_40_WT: MongoDB 4.0 WiredTiger Edition.
	MongoVersion *string `json:"MongoVersion,omitempty" name:"MongoVersion"`

	// Server type. Valid values: `HIO` (high IO), `HIO10G` (ten-gigabit high IO)
	MachineCode *string `json:"MachineCode,omitempty" name:"MachineCode"`

	// Number of instances. Minimum value: 1. Maximum value: 10.
	GoodsNum *int64 `json:"GoodsNum,omitempty" name:"GoodsNum"`

	// Instance validity period in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36.
	Period *int64 `json:"Period,omitempty" name:"Period"`

	// Instance type. Valid values: REPLSET (replica set), SHARD (sharded cluster), STANDALONE (single-node).
	ClusterType *string `json:"ClusterType,omitempty" name:"ClusterType"`

	// Number of replica sets. To create a replica set instance, set this parameter to 1; to create a shard instance, see the parameters returned by the `DescribeSpecInfo` API; to create a single-node instance, set this parameter to 0.
	ReplicateSetNum *int64 `json:"ReplicateSetNum,omitempty" name:"ReplicateSetNum"`
}

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 InquirePriceCreateDBInstancesResponse 

type InquirePriceCreateDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Price.
		Price *DBInstancePrice `json:"Price,omitempty" name:"Price"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 

func (r *InquirePriceCreateDBInstancesResponse) ToJsonString() string

type InquirePriceModifyDBInstanceSpecRequest 

type InquirePriceModifyDBInstanceSpecRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed in the TencentDB Console.
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Instance memory size in GB after specification adjustment.
	Memory *int64 `json:"Memory,omitempty" name:"Memory"`

	// Instance disk size in GB after specification adjustment.
	Volume *int64 `json:"Volume,omitempty" name:"Volume"`

	// Node quantity after configuration modification. The value range is subject to the response parameter of the `DescribeSpecInfo` API. If this parameter is left empty, the node quantity remains unchanged.
	NodeNum *int64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Shard quantity after configuration modification, which can only be increased rather than decreased. The value range is subject to the response parameter of the `DescribeSpecInfo` API. If this parameter is left empty, the shard quantity remains unchanged.
	ReplicateSetNum *int64 `json:"ReplicateSetNum,omitempty" name:"ReplicateSetNum"`
}

func NewInquirePriceModifyDBInstanceSpecRequest 

func NewInquirePriceModifyDBInstanceSpecRequest() (request *InquirePriceModifyDBInstanceSpecRequest)

func (*InquirePriceModifyDBInstanceSpecRequest) FromJsonString 

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

func (r *InquirePriceModifyDBInstanceSpecRequest) ToJsonString() string

type InquirePriceModifyDBInstanceSpecResponse 

type InquirePriceModifyDBInstanceSpecResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Price.
		Price *DBInstancePrice `json:"Price,omitempty" name:"Price"`

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

func NewInquirePriceModifyDBInstanceSpecResponse 

func NewInquirePriceModifyDBInstanceSpecResponse() (response *InquirePriceModifyDBInstanceSpecResponse)

func (*InquirePriceModifyDBInstanceSpecResponse) FromJsonString 

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

func (r *InquirePriceModifyDBInstanceSpecResponse) ToJsonString() string

type InquirePriceRenewDBInstancesRequest 

type InquirePriceRenewDBInstancesRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed in the TencentDB Console. This API supports operations on up to 5 instances at a time.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// The parameter setting for the prepaid mode (monthly subscription mode). This parameter can specify the renewal period, whether to set automatic renewal, and other attributes of the monthly subscription instance.
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,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 InquirePriceRenewDBInstancesResponse 

type InquirePriceRenewDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Price.
		Price *DBInstancePrice `json:"Price,omitempty" name:"Price"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 InstanceChargePrepaid 

type InstanceChargePrepaid struct {

	// Purchased usage period (in month). Valid values: `1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, 36`. Default value: `1`.
	// (This parameter is required in `InquirePriceRenewDBInstances` and `RenewDBInstances` APIs.)
	Period *int64 `json:"Period,omitempty" name:"Period"`

	// Auto-renewal flag. Valid values:
	// `NOTIFY_AND_AUTO_RENEW`: notify expiration and renew automatically
	// `NOTIFY_AND_MANUAL_RENEW`: notify expiration but not renew automatically
	// `DISABLE_NOTIFY_AND_MANUAL_RENEW`: neither notify expiration nor renew automatically
	//
	// Default value: `NOTIFY_AND_MANUAL_RENEW`. If this parameter is specified as `NOTIFY_AND_AUTO_RENEW`, the instance will be automatically renewed on a monthly basis when the account balance is sufficient.
	// (This parameter is required in `InquirePriceRenewDBInstances` and `RenewDBInstances` APIs.)
	RenewFlag *string `json:"RenewFlag,omitempty" name:"RenewFlag"`
}

type InstanceDetail 

type InstanceDetail struct {

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Instance name
	InstanceName *string `json:"InstanceName,omitempty" name:"InstanceName"`

	// Billing type. Valid value: 0 (pay-as-you-go)
	PayMode *uint64 `json:"PayMode,omitempty" name:"PayMode"`

	// Project ID
	ProjectId *uint64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// Cluster type. Valid values: 0 (replica set instance), 1 (sharding instance),
	ClusterType *uint64 `json:"ClusterType,omitempty" name:"ClusterType"`

	// Region information
	Region *string `json:"Region,omitempty" name:"Region"`

	// AZ information
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// Network type. Valid values: 0 (basic network), 1 (VPC)
	NetType *uint64 `json:"NetType,omitempty" name:"NetType"`

	// VPC ID
	VpcId *string `json:"VpcId,omitempty" name:"VpcId"`

	// Subnet ID of VPC
	SubnetId *string `json:"SubnetId,omitempty" name:"SubnetId"`

	// Instance status. Valid values: 0 (to be initialized), 1 (in process), 2 (running), -2 (expired)
	Status *int64 `json:"Status,omitempty" name:"Status"`

	// Instance IP
	Vip *string `json:"Vip,omitempty" name:"Vip"`

	// Port number
	Vport *uint64 `json:"Vport,omitempty" name:"Vport"`

	// Instance creation time
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// Instance expiration time
	DeadLine *string `json:"DeadLine,omitempty" name:"DeadLine"`

	// Instance version information
	MongoVersion *string `json:"MongoVersion,omitempty" name:"MongoVersion"`

	// Instance memory size in MB
	Memory *uint64 `json:"Memory,omitempty" name:"Memory"`

	// Instance disk size in MB
	Volume *uint64 `json:"Volume,omitempty" name:"Volume"`

	// Number of CPU cores of an instance
	CpuNum *uint64 `json:"CpuNum,omitempty" name:"CpuNum"`

	// Instance machine type
	MachineType *string `json:"MachineType,omitempty" name:"MachineType"`

	// Number of secondary nodes of an instance
	SecondaryNum *uint64 `json:"SecondaryNum,omitempty" name:"SecondaryNum"`

	// Number of instance shards
	ReplicationSetNum *uint64 `json:"ReplicationSetNum,omitempty" name:"ReplicationSetNum"`

	// Instance auto-renewal flag. Valid values: 0 (manual renewal), 1 (auto-renewal), 2 (no renewal upon expiration)
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitempty" name:"AutoRenewFlag"`

	// Used capacity in MB
	UsedVolume *uint64 `json:"UsedVolume,omitempty" name:"UsedVolume"`

	// Start time of the maintenance time window
	MaintenanceStart *string `json:"MaintenanceStart,omitempty" name:"MaintenanceStart"`

	// End time of the maintenance time window
	MaintenanceEnd *string `json:"MaintenanceEnd,omitempty" name:"MaintenanceEnd"`

	// Shard information
	ReplicaSets []*ShardInfo `json:"ReplicaSets,omitempty" name:"ReplicaSets"`

	// Information of read-only instances
	ReadonlyInstances []*DBInstanceInfo `json:"ReadonlyInstances,omitempty" name:"ReadonlyInstances"`

	// Information of disaster recovery instances
	StandbyInstances []*DBInstanceInfo `json:"StandbyInstances,omitempty" name:"StandbyInstances"`

	// Information of temp instances
	CloneInstances []*DBInstanceInfo `json:"CloneInstances,omitempty" name:"CloneInstances"`

	// Information of associated instances. For a promoted instance, this field represents information of its temp instance; for a temp instance, this field represents information of its promoted instance; and for a read-only/disaster recovery instance, this field represents information of its primary instance
	RelatedInstance *DBInstanceInfo `json:"RelatedInstance,omitempty" name:"RelatedInstance"`

	// Instance tag information set
	Tags []*TagInfo `json:"Tags,omitempty" name:"Tags"`

	// Instance version tag
	InstanceVer *uint64 `json:"InstanceVer,omitempty" name:"InstanceVer"`

	// Instance version tag
	ClusterVer *uint64 `json:"ClusterVer,omitempty" name:"ClusterVer"`

	// Protocol information. Valid values: 1 (mongodb), 2 (dynamodb)
	Protocol *uint64 `json:"Protocol,omitempty" name:"Protocol"`

	// Instance type. Valid values: 1 (promoted instance), 2 (temp instance), 3 (read-only instance), 4 (disaster recovery instance)
	InstanceType *uint64 `json:"InstanceType,omitempty" name:"InstanceType"`

	// Instance status description
	InstanceStatusDesc *string `json:"InstanceStatusDesc,omitempty" name:"InstanceStatusDesc"`

	// Physical instance ID. For an instance that has been rolled back and replaced, its InstanceId and RealInstanceId are different. The physical instance ID is needed in such scenarios as getting monitoring data from Barad
	RealInstanceId *string `json:"RealInstanceId,omitempty" name:"RealInstanceId"`
}

type InstanceEnumParam 

type InstanceEnumParam struct {

	// Current value
	CurrentValue *string `json:"CurrentValue,omitempty" name:"CurrentValue"`

	// Default value
	DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`

	// Acceptable values
	EnumValue []*string `json:"EnumValue,omitempty" name:"EnumValue"`

	// Whether to restart the instance for the parameter to take effect. Valid values: `1` (yes), `0` (no, which means the parameter setting takes effect immediately)
	NeedRestart *string `json:"NeedRestart,omitempty" name:"NeedRestart"`

	// Parameter name
	ParamName *string `json:"ParamName,omitempty" name:"ParamName"`

	// Parameter description
	Tips []*string `json:"Tips,omitempty" name:"Tips"`

	// Data type of the parameter
	ValueType *string `json:"ValueType,omitempty" name:"ValueType"`

	// Whether `CurrentValue` is the parameter value actually in use. Valid values: `1` (yes), `0` (no)
	Status *uint64 `json:"Status,omitempty" name:"Status"`
}

type InstanceIntegerParam 

type InstanceIntegerParam struct {

	// Current value
	CurrentValue *string `json:"CurrentValue,omitempty" name:"CurrentValue"`

	// Default value
	DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`

	// Maximum value
	Max *string `json:"Max,omitempty" name:"Max"`

	// Minimum value
	Min *string `json:"Min,omitempty" name:"Min"`

	// Whether to restart the instance for the parameter to take effect. Valid values: `1` (yes), `0` (no, which means the parameter setting takes effect immediately)
	NeedRestart *string `json:"NeedRestart,omitempty" name:"NeedRestart"`

	// Parameter name
	ParamName *string `json:"ParamName,omitempty" name:"ParamName"`

	// Parameter description
	Tips []*string `json:"Tips,omitempty" name:"Tips"`

	// Data type of the parameter
	ValueType *string `json:"ValueType,omitempty" name:"ValueType"`

	// Whether `CurrentValue` is the parameter value actually in use. Valid values: `1` (yes), `0` (no)
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Redundant field which can be ignored
	Unit *string `json:"Unit,omitempty" name:"Unit"`
}

type InstanceMultiParam 

type InstanceMultiParam struct {

	// Current value
	CurrentValue *string `json:"CurrentValue,omitempty" name:"CurrentValue"`

	// Default value
	DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`

	// Acceptable values
	EnumValue []*string `json:"EnumValue,omitempty" name:"EnumValue"`

	// Whether to restart the instance for the parameter to take effect. Valid values: `1` (yes), `0` (no, which means the parameter setting takes effect immediately)
	NeedRestart *string `json:"NeedRestart,omitempty" name:"NeedRestart"`

	// Parameter name
	ParamName *string `json:"ParamName,omitempty" name:"ParamName"`

	// Whether `CurrentValue` is the parameter value actually in use. Valid values: `1` (yes), `0` (no)
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Parameter description
	Tips []*string `json:"Tips,omitempty" name:"Tips"`

	// Data type of the current value. Default value: `multi`
	ValueType *string `json:"ValueType,omitempty" name:"ValueType"`
}

type InstanceTextParam 

type InstanceTextParam struct {

	// Current value
	CurrentValue *string `json:"CurrentValue,omitempty" name:"CurrentValue"`

	// Default value
	DefaultValue *string `json:"DefaultValue,omitempty" name:"DefaultValue"`

	// Whether to restart the instance for the parameter to take effect
	NeedRestart *string `json:"NeedRestart,omitempty" name:"NeedRestart"`

	// Parameter name
	ParamName *string `json:"ParamName,omitempty" name:"ParamName"`

	// Value of a text parameter
	TextValue *string `json:"TextValue,omitempty" name:"TextValue"`

	// Parameter description
	Tips []*string `json:"Tips,omitempty" name:"Tips"`

	// Value type
	ValueType *string `json:"ValueType,omitempty" name:"ValueType"`

	// Whether `CurrentValue` is the parameter value actually in use. Valid values: `1` (yes), `0` (no)
	Status *string `json:"Status,omitempty" name:"Status"`
}

type IsolateDBInstanceRequest 

type IsolateDBInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,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 IsolateDBInstanceResponse 

type IsolateDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Async task request ID, which can be used to query the execution result of an async task.
		AsyncRequestId *string `json:"AsyncRequestId,omitempty" name:"AsyncRequestId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 ModifyDBInstanceNetworkAddressRequest 

type ModifyDBInstanceNetworkAddressRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Old IP retention period in minutes. The old IP will be released after the specified time, and both the old and new IPs can be accessed before the release. The value `0` indicates that the old IP will be reclaimed immediately.
	OldIpExpiredTime *uint64 `json:"OldIpExpiredTime,omitempty" name:"OldIpExpiredTime"`

	// ID of the VPC to which the new IP belongs after the switch. When it is classic network, this field will be empty.
	NewUniqVpcId *string `json:"NewUniqVpcId,omitempty" name:"NewUniqVpcId"`

	// ID of the subnet to which the new IP belongs after the switch. When it is classic network, this field will be empty.
	NewUniqSubnetId *string `json:"NewUniqSubnetId,omitempty" name:"NewUniqSubnetId"`

	// IP information to be modified
	NetworkAddresses []*ModifyNetworkAddress `json:"NetworkAddresses,omitempty" name:"NetworkAddresses"`
}

func NewModifyDBInstanceNetworkAddressRequest 

func NewModifyDBInstanceNetworkAddressRequest() (request *ModifyDBInstanceNetworkAddressRequest)

func (*ModifyDBInstanceNetworkAddressRequest) FromJsonString 

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 

func (r *ModifyDBInstanceNetworkAddressRequest) ToJsonString() string

type ModifyDBInstanceNetworkAddressResponse 

type ModifyDBInstanceNetworkAddressResponse struct {
	*tchttp.BaseResponse
	Response *struct {

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

func NewModifyDBInstanceNetworkAddressResponse 

func NewModifyDBInstanceNetworkAddressResponse() (response *ModifyDBInstanceNetworkAddressResponse)

func (*ModifyDBInstanceNetworkAddressResponse) FromJsonString 

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

func (r *ModifyDBInstanceNetworkAddressResponse) ToJsonString() string

type ModifyDBInstanceSecurityGroupRequest 

type ModifyDBInstanceSecurityGroupRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Target security group IDs
	SecurityGroupIds []*string `json:"SecurityGroupIds,omitempty" name:"SecurityGroupIds"`
}

func NewModifyDBInstanceSecurityGroupRequest 

func NewModifyDBInstanceSecurityGroupRequest() (request *ModifyDBInstanceSecurityGroupRequest)

func (*ModifyDBInstanceSecurityGroupRequest) FromJsonString 

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 

func (r *ModifyDBInstanceSecurityGroupRequest) ToJsonString() string

type ModifyDBInstanceSecurityGroupResponse 

type ModifyDBInstanceSecurityGroupResponse struct {
	*tchttp.BaseResponse
	Response *struct {

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

func NewModifyDBInstanceSecurityGroupResponse 

func NewModifyDBInstanceSecurityGroupResponse() (response *ModifyDBInstanceSecurityGroupResponse)

func (*ModifyDBInstanceSecurityGroupResponse) FromJsonString 

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 

func (r *ModifyDBInstanceSecurityGroupResponse) ToJsonString() string

type ModifyDBInstanceSpecRequest 

type ModifyDBInstanceSpecRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Memory size after instance configuration change in GB. Memory and disk must be upgraded or degraded simultaneously
	Memory *uint64 `json:"Memory,omitempty" name:"Memory"`

	// Disk size after instance configuration change in GB. Memory and disk must be upgraded or degraded simultaneously. For degradation, the new disk capacity must be greater than 1.2 times the used disk capacity
	Volume *uint64 `json:"Volume,omitempty" name:"Volume"`

	// Oplog size after instance configuration change in GB, which ranges from 10% to 90% of the disk capacity and is 10% of the disk capacity by default
	OplogSize *uint64 `json:"OplogSize,omitempty" name:"OplogSize"`

	// Node quantity after configuration modification. The value range is subject to the response parameter of the `DescribeSpecInfo` API. If this parameter is left empty, the node quantity remains unchanged.
	NodeNum *uint64 `json:"NodeNum,omitempty" name:"NodeNum"`

	// Shard quantity after configuration modification, which can only be increased rather than decreased. The value range is subject to the response parameter of the `DescribeSpecInfo` API. If this parameter is left empty, the shard quantity remains unchanged.
	ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitempty" name:"ReplicateSetNum"`

	// Switch time. Valid values: `0` (upon modification completion), `1` (during maintenance time). Default value: `0`. If the quantity of nodes or shards is modified, the value will be `0`.
	InMaintenance *uint64 `json:"InMaintenance,omitempty" name:"InMaintenance"`
}

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 ModifyDBInstanceSpecResponse 

type ModifyDBInstanceSpecResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Order ID
		DealId *string `json:"DealId,omitempty" name:"DealId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 ModifyNetworkAddress 

type ModifyNetworkAddress struct {

	// New IP
	NewIPAddress *string `json:"NewIPAddress,omitempty" name:"NewIPAddress"`

	// Old IP
	OldIpAddress *string `json:"OldIpAddress,omitempty" name:"OldIpAddress"`
}

type OfflineIsolatedDBInstanceRequest 

type OfflineIsolatedDBInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,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 OfflineIsolatedDBInstanceResponse 

type OfflineIsolatedDBInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Async task request ID, which can be used to query the execution result of an async task.
		AsyncRequestId *string `json:"AsyncRequestId,omitempty" name:"AsyncRequestId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 RenameInstanceRequest 

type RenameInstanceRequest struct {
	*tchttp.BaseRequest

	// Instance ID in the format of cmgo-p8vnipr5. It is the same as the instance ID displayed on the TencentDB Console page
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Custom name of the instance, which can contain up to 60 letters, digits, or symbols (_-)
	NewName *string `json:"NewName,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 RenameInstanceResponse 

type RenameInstanceResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 RenewDBInstancesRequest 

type RenewDBInstancesRequest struct {
	*tchttp.BaseRequest

	// IDs of one or more instances to be operated. The value can be obtained from the `InstanceId` parameter returned by the `DescribeInstances` API. Up to 100 instances can be requested at a time.
	InstanceIds []*string `json:"InstanceIds,omitempty" name:"InstanceIds"`

	// The parameter setting for the prepaid mode (monthly subscription mode). This parameter can specify the renewal period, whether to set automatic renewal, and other attributes of the monthly subscription instance. This parameter is mandatory in monthly subscription.
	InstanceChargePrepaid *InstanceChargePrepaid `json:"InstanceChargePrepaid,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 RenewDBInstancesResponse 

type RenewDBInstancesResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 ReplicaSetInfo 

type ReplicaSetInfo struct {

	// Replica set ID
	ReplicaSetId *string `json:"ReplicaSetId,omitempty" name:"ReplicaSetId"`
}

type ResetDBInstancePasswordRequest 

type ResetDBInstancePasswordRequest struct {
	*tchttp.BaseRequest

	// Instance ID
	InstanceId *string `json:"InstanceId,omitempty" name:"InstanceId"`

	// Instance account name
	UserName *string `json:"UserName,omitempty" name:"UserName"`

	// New password, which must contain at least eight characters
	Password *string `json:"Password,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 ResetDBInstancePasswordResponse 

type ResetDBInstancePasswordResponse struct {
	*tchttp.BaseResponse
	Response *struct {

		// Async request ID, which is used to query the running status of the process.
		AsyncRequestId *string `json:"AsyncRequestId,omitempty" name:"AsyncRequestId"`

		// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
		RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
	} `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 SecurityGroup 

type SecurityGroup struct {

	// Project ID
	ProjectId *int64 `json:"ProjectId,omitempty" name:"ProjectId"`

	// Creation time
	CreateTime *string `json:"CreateTime,omitempty" name:"CreateTime"`

	// Inbound rule
	Inbound []*SecurityGroupBound `json:"Inbound,omitempty" name:"Inbound"`

	// Outbound rule
	Outbound []*SecurityGroupBound `json:"Outbound,omitempty" name:"Outbound"`

	// Security group ID
	SecurityGroupId *string `json:"SecurityGroupId,omitempty" name:"SecurityGroupId"`

	// Security group name
	SecurityGroupName *string `json:"SecurityGroupName,omitempty" name:"SecurityGroupName"`

	// Security group remarks
	SecurityGroupRemark *string `json:"SecurityGroupRemark,omitempty" name:"SecurityGroupRemark"`
}

type SecurityGroupBound 

type SecurityGroupBound struct {

	// Execution rule. Valid values: `ACCEPT`, `DROP`
	Action *string `json:"Action,omitempty" name:"Action"`

	// IP range
	CidrIp *string `json:"CidrIp,omitempty" name:"CidrIp"`

	// Port range
	PortRange *string `json:"PortRange,omitempty" name:"PortRange"`

	// Transport layer protocol. Valid values: `tcp`, `udp`, `ALL`
	IpProtocol *string `json:"IpProtocol,omitempty" name:"IpProtocol"`

	// All the addresses that the security group ID represents
	Id *string `json:"Id,omitempty" name:"Id"`

	// All the addresses that the address group ID represents
	AddressModule *string `json:"AddressModule,omitempty" name:"AddressModule"`

	// All the protocols and ports that the service group ID represents
	ServiceModule *string `json:"ServiceModule,omitempty" name:"ServiceModule"`

	// Description
	Desc *string `json:"Desc,omitempty" name:"Desc"`
}

type ShardInfo 

type ShardInfo struct {

	// Used shard capacity
	UsedVolume *float64 `json:"UsedVolume,omitempty" name:"UsedVolume"`

	// Shard ID
	ReplicaSetId *string `json:"ReplicaSetId,omitempty" name:"ReplicaSetId"`

	// Shard name
	ReplicaSetName *string `json:"ReplicaSetName,omitempty" name:"ReplicaSetName"`

	// Shard memory size in MB
	Memory *uint64 `json:"Memory,omitempty" name:"Memory"`

	// Shard disk size in MB
	Volume *uint64 `json:"Volume,omitempty" name:"Volume"`

	// Shard oplog size in MB
	OplogSize *uint64 `json:"OplogSize,omitempty" name:"OplogSize"`

	// Number of secondary nodes of a shard
	SecondaryNum *uint64 `json:"SecondaryNum,omitempty" name:"SecondaryNum"`

	// Shard physical ID
	RealReplicaSetId *string `json:"RealReplicaSetId,omitempty" name:"RealReplicaSetId"`
}

type SlowLogPattern 

type SlowLogPattern struct {

	// Slow log pattern
	Pattern *string `json:"Pattern,omitempty" name:"Pattern"`

	// Maximum execution time
	MaxTime *uint64 `json:"MaxTime,omitempty" name:"MaxTime"`

	// Average execution time
	AverageTime *uint64 `json:"AverageTime,omitempty" name:"AverageTime"`

	// Number of slow logs in this pattern
	Total *uint64 `json:"Total,omitempty" name:"Total"`
}

type SpecItem 

type SpecItem struct {

	// Specification information identifier
	SpecCode *string `json:"SpecCode,omitempty" name:"SpecCode"`

	// Specification purchasable flag. Valid values: 0 (not purchasable), 1 (purchasable)
	Status *uint64 `json:"Status,omitempty" name:"Status"`

	// Computing resource specification in terms of CPU core
	Cpu *uint64 `json:"Cpu,omitempty" name:"Cpu"`

	// Memory size in MB
	Memory *uint64 `json:"Memory,omitempty" name:"Memory"`

	// Default disk size in MB
	DefaultStorage *uint64 `json:"DefaultStorage,omitempty" name:"DefaultStorage"`

	// Maximum disk size in MB
	MaxStorage *uint64 `json:"MaxStorage,omitempty" name:"MaxStorage"`

	// Minimum disk size in MB
	MinStorage *uint64 `json:"MinStorage,omitempty" name:"MinStorage"`

	// Maximum QPS
	Qps *uint64 `json:"Qps,omitempty" name:"Qps"`

	// Maximum number of connections
	Conns *uint64 `json:"Conns,omitempty" name:"Conns"`

	// MongoDB version information of an instance
	MongoVersionCode *string `json:"MongoVersionCode,omitempty" name:"MongoVersionCode"`

	// MongoDB version number of an instance
	MongoVersionValue *uint64 `json:"MongoVersionValue,omitempty" name:"MongoVersionValue"`

	// MongoDB version number of an instance (short)
	Version *string `json:"Version,omitempty" name:"Version"`

	// Storage engine
	EngineName *string `json:"EngineName,omitempty" name:"EngineName"`

	// Cluster type. Valid values: 1 (sharding cluster), 0 (replica set cluster)
	ClusterType *uint64 `json:"ClusterType,omitempty" name:"ClusterType"`

	// Minimum number of secondary nodes in a replica set
	MinNodeNum *uint64 `json:"MinNodeNum,omitempty" name:"MinNodeNum"`

	// Maximum number of secondary nodes in a replica set
	MaxNodeNum *uint64 `json:"MaxNodeNum,omitempty" name:"MaxNodeNum"`

	// Minimum number of shards
	MinReplicateSetNum *uint64 `json:"MinReplicateSetNum,omitempty" name:"MinReplicateSetNum"`

	// Maximum number of shards
	MaxReplicateSetNum *uint64 `json:"MaxReplicateSetNum,omitempty" name:"MaxReplicateSetNum"`

	// Minimum number of secondary nodes in a shard
	MinReplicateSetNodeNum *uint64 `json:"MinReplicateSetNodeNum,omitempty" name:"MinReplicateSetNodeNum"`

	// Maximum number of secondary nodes in a shard
	MaxReplicateSetNodeNum *uint64 `json:"MaxReplicateSetNodeNum,omitempty" name:"MaxReplicateSetNodeNum"`

	// Server type. Valid values: 0 (HIO), 4 (HIO10G)
	MachineType *string `json:"MachineType,omitempty" name:"MachineType"`
}

type SpecificationInfo 

type SpecificationInfo struct {

	// Region information
	Region *string `json:"Region,omitempty" name:"Region"`

	// AZ information
	Zone *string `json:"Zone,omitempty" name:"Zone"`

	// Purchasable specification information
	SpecItems []*SpecItem `json:"SpecItems,omitempty" name:"SpecItems"`
}

type TagInfo 

type TagInfo struct {

	// Tag key
	TagKey *string `json:"TagKey,omitempty" name:"TagKey"`

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.