Documentation
¶
Index ¶
- Constants
- type AddNodeList
- type AssignProjectRequest
- type AssignProjectRequestParams
- type AssignProjectResponse
- type AssignProjectResponseParams
- type BackupDownloadTask
- type BackupDownloadTaskStatus
- type BackupInfo
- type Client
- func (c *Client) AssignProject(request *AssignProjectRequest) (response *AssignProjectResponse, err error)
- func (c *Client) AssignProjectWithContext(ctx context.Context, request *AssignProjectRequest) (response *AssignProjectResponse, err error)
- func (c *Client) CreateBackupDBInstance(request *CreateBackupDBInstanceRequest) (response *CreateBackupDBInstanceResponse, err error)
- func (c *Client) CreateBackupDBInstanceWithContext(ctx context.Context, request *CreateBackupDBInstanceRequest) (response *CreateBackupDBInstanceResponse, err error)
- func (c *Client) CreateBackupDownloadTask(request *CreateBackupDownloadTaskRequest) (response *CreateBackupDownloadTaskResponse, err error)
- func (c *Client) CreateBackupDownloadTaskWithContext(ctx context.Context, request *CreateBackupDownloadTaskRequest) (response *CreateBackupDownloadTaskResponse, err error)
- func (c *Client) CreateDBInstance(request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)
- func (c *Client) CreateDBInstanceHour(request *CreateDBInstanceHourRequest) (response *CreateDBInstanceHourResponse, err error)
- func (c *Client) CreateDBInstanceHourWithContext(ctx context.Context, request *CreateDBInstanceHourRequest) (response *CreateDBInstanceHourResponse, err error)
- func (c *Client) CreateDBInstanceWithContext(ctx context.Context, request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)
- func (c *Client) DescribeAsyncRequestInfo(request *DescribeAsyncRequestInfoRequest) (response *DescribeAsyncRequestInfoResponse, err error)
- func (c *Client) DescribeAsyncRequestInfoWithContext(ctx context.Context, request *DescribeAsyncRequestInfoRequest) (response *DescribeAsyncRequestInfoResponse, err error)
- func (c *Client) DescribeBackupDownloadTask(request *DescribeBackupDownloadTaskRequest) (response *DescribeBackupDownloadTaskResponse, err error)
- func (c *Client) DescribeBackupDownloadTaskWithContext(ctx context.Context, request *DescribeBackupDownloadTaskRequest) (response *DescribeBackupDownloadTaskResponse, err error)
- func (c *Client) DescribeClientConnections(request *DescribeClientConnectionsRequest) (response *DescribeClientConnectionsResponse, err error)
- func (c *Client) DescribeClientConnectionsWithContext(ctx context.Context, request *DescribeClientConnectionsRequest) (response *DescribeClientConnectionsResponse, err error)
- func (c *Client) DescribeDBBackups(request *DescribeDBBackupsRequest) (response *DescribeDBBackupsResponse, err error)
- func (c *Client) DescribeDBBackupsWithContext(ctx context.Context, request *DescribeDBBackupsRequest) (response *DescribeDBBackupsResponse, err error)
- func (c *Client) DescribeDBInstanceDeal(request *DescribeDBInstanceDealRequest) (response *DescribeDBInstanceDealResponse, err error)
- func (c *Client) DescribeDBInstanceDealWithContext(ctx context.Context, request *DescribeDBInstanceDealRequest) (response *DescribeDBInstanceDealResponse, err error)
- func (c *Client) DescribeDBInstanceNamespace(request *DescribeDBInstanceNamespaceRequest) (response *DescribeDBInstanceNamespaceResponse, err error)
- func (c *Client) DescribeDBInstanceNamespaceWithContext(ctx context.Context, request *DescribeDBInstanceNamespaceRequest) (response *DescribeDBInstanceNamespaceResponse, err error)
- func (c *Client) DescribeDBInstances(request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)
- func (c *Client) DescribeDBInstancesWithContext(ctx context.Context, request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)
- func (c *Client) DescribeDetailedSlowLogs(request *DescribeDetailedSlowLogsRequest) (response *DescribeDetailedSlowLogsResponse, err error)
- func (c *Client) DescribeDetailedSlowLogsWithContext(ctx context.Context, request *DescribeDetailedSlowLogsRequest) (response *DescribeDetailedSlowLogsResponse, err error)
- func (c *Client) DescribeInstanceParams(request *DescribeInstanceParamsRequest) (response *DescribeInstanceParamsResponse, err error)
- func (c *Client) DescribeInstanceParamsWithContext(ctx context.Context, request *DescribeInstanceParamsRequest) (response *DescribeInstanceParamsResponse, err error)
- func (c *Client) DescribeSecurityGroup(request *DescribeSecurityGroupRequest) (response *DescribeSecurityGroupResponse, err error)
- func (c *Client) DescribeSecurityGroupWithContext(ctx context.Context, request *DescribeSecurityGroupRequest) (response *DescribeSecurityGroupResponse, err error)
- func (c *Client) DescribeSlowLogPatterns(request *DescribeSlowLogPatternsRequest) (response *DescribeSlowLogPatternsResponse, err error)
- func (c *Client) DescribeSlowLogPatternsWithContext(ctx context.Context, request *DescribeSlowLogPatternsRequest) (response *DescribeSlowLogPatternsResponse, err error)
- func (c *Client) DescribeSlowLogs(request *DescribeSlowLogsRequest) (response *DescribeSlowLogsResponse, err error)
- func (c *Client) DescribeSlowLogsWithContext(ctx context.Context, request *DescribeSlowLogsRequest) (response *DescribeSlowLogsResponse, err error)
- func (c *Client) DescribeSpecInfo(request *DescribeSpecInfoRequest) (response *DescribeSpecInfoResponse, err error)
- func (c *Client) DescribeSpecInfoWithContext(ctx context.Context, request *DescribeSpecInfoRequest) (response *DescribeSpecInfoResponse, err error)
- func (c *Client) FlushInstanceRouterConfig(request *FlushInstanceRouterConfigRequest) (response *FlushInstanceRouterConfigResponse, err error)
- func (c *Client) FlushInstanceRouterConfigWithContext(ctx context.Context, request *FlushInstanceRouterConfigRequest) (response *FlushInstanceRouterConfigResponse, err error)
- func (c *Client) InquirePriceCreateDBInstances(request *InquirePriceCreateDBInstancesRequest) (response *InquirePriceCreateDBInstancesResponse, err error)
- func (c *Client) InquirePriceCreateDBInstancesWithContext(ctx context.Context, request *InquirePriceCreateDBInstancesRequest) (response *InquirePriceCreateDBInstancesResponse, err error)
- func (c *Client) InquirePriceModifyDBInstanceSpec(request *InquirePriceModifyDBInstanceSpecRequest) (response *InquirePriceModifyDBInstanceSpecResponse, err error)
- func (c *Client) InquirePriceModifyDBInstanceSpecWithContext(ctx context.Context, request *InquirePriceModifyDBInstanceSpecRequest) (response *InquirePriceModifyDBInstanceSpecResponse, err error)
- func (c *Client) InquirePriceRenewDBInstances(request *InquirePriceRenewDBInstancesRequest) (response *InquirePriceRenewDBInstancesResponse, err error)
- func (c *Client) InquirePriceRenewDBInstancesWithContext(ctx context.Context, request *InquirePriceRenewDBInstancesRequest) (response *InquirePriceRenewDBInstancesResponse, err error)
- func (c *Client) IsolateDBInstance(request *IsolateDBInstanceRequest) (response *IsolateDBInstanceResponse, err error)
- func (c *Client) IsolateDBInstanceWithContext(ctx context.Context, request *IsolateDBInstanceRequest) (response *IsolateDBInstanceResponse, err error)
- func (c *Client) ModifyDBInstanceNetworkAddress(request *ModifyDBInstanceNetworkAddressRequest) (response *ModifyDBInstanceNetworkAddressResponse, err error)
- func (c *Client) ModifyDBInstanceNetworkAddressWithContext(ctx context.Context, request *ModifyDBInstanceNetworkAddressRequest) (response *ModifyDBInstanceNetworkAddressResponse, err error)
- func (c *Client) ModifyDBInstanceSecurityGroup(request *ModifyDBInstanceSecurityGroupRequest) (response *ModifyDBInstanceSecurityGroupResponse, err error)
- func (c *Client) ModifyDBInstanceSecurityGroupWithContext(ctx context.Context, request *ModifyDBInstanceSecurityGroupRequest) (response *ModifyDBInstanceSecurityGroupResponse, err error)
- func (c *Client) ModifyDBInstanceSpec(request *ModifyDBInstanceSpecRequest) (response *ModifyDBInstanceSpecResponse, err error)
- func (c *Client) ModifyDBInstanceSpecWithContext(ctx context.Context, request *ModifyDBInstanceSpecRequest) (response *ModifyDBInstanceSpecResponse, err error)
- func (c *Client) OfflineIsolatedDBInstance(request *OfflineIsolatedDBInstanceRequest) (response *OfflineIsolatedDBInstanceResponse, err error)
- func (c *Client) OfflineIsolatedDBInstanceWithContext(ctx context.Context, request *OfflineIsolatedDBInstanceRequest) (response *OfflineIsolatedDBInstanceResponse, err error)
- func (c *Client) RenameInstance(request *RenameInstanceRequest) (response *RenameInstanceResponse, err error)
- func (c *Client) RenameInstanceWithContext(ctx context.Context, request *RenameInstanceRequest) (response *RenameInstanceResponse, err error)
- func (c *Client) RenewDBInstances(request *RenewDBInstancesRequest) (response *RenewDBInstancesResponse, err error)
- func (c *Client) RenewDBInstancesWithContext(ctx context.Context, request *RenewDBInstancesRequest) (response *RenewDBInstancesResponse, err error)
- func (c *Client) ResetDBInstancePassword(request *ResetDBInstancePasswordRequest) (response *ResetDBInstancePasswordResponse, err error)
- func (c *Client) ResetDBInstancePasswordWithContext(ctx context.Context, request *ResetDBInstancePasswordRequest) (response *ResetDBInstancePasswordResponse, err error)
- func (c *Client) SetDBInstanceDeletionProtection(request *SetDBInstanceDeletionProtectionRequest) (response *SetDBInstanceDeletionProtectionResponse, err error)
- func (c *Client) SetDBInstanceDeletionProtectionWithContext(ctx context.Context, request *SetDBInstanceDeletionProtectionRequest) (response *SetDBInstanceDeletionProtectionResponse, err error)
- func (c *Client) TerminateDBInstances(request *TerminateDBInstancesRequest) (response *TerminateDBInstancesResponse, err error)
- func (c *Client) TerminateDBInstancesWithContext(ctx context.Context, request *TerminateDBInstancesRequest) (response *TerminateDBInstancesResponse, err error)
- type ClientConnection
- type CreateBackupDBInstanceRequest
- type CreateBackupDBInstanceRequestParams
- type CreateBackupDBInstanceResponse
- type CreateBackupDBInstanceResponseParams
- type CreateBackupDownloadTaskRequest
- type CreateBackupDownloadTaskRequestParams
- type CreateBackupDownloadTaskResponse
- type CreateBackupDownloadTaskResponseParams
- type CreateDBInstanceHourRequest
- type CreateDBInstanceHourRequestParams
- type CreateDBInstanceHourResponse
- type CreateDBInstanceHourResponseParams
- type CreateDBInstanceRequest
- type CreateDBInstanceRequestParams
- type CreateDBInstanceResponse
- type CreateDBInstanceResponseParams
- type DBInstanceInfo
- type DBInstancePrice
- type DescribeAsyncRequestInfoRequest
- type DescribeAsyncRequestInfoRequestParams
- type DescribeAsyncRequestInfoResponse
- type DescribeAsyncRequestInfoResponseParams
- type DescribeBackupDownloadTaskRequest
- type DescribeBackupDownloadTaskRequestParams
- type DescribeBackupDownloadTaskResponse
- type DescribeBackupDownloadTaskResponseParams
- type DescribeClientConnectionsRequest
- type DescribeClientConnectionsRequestParams
- type DescribeClientConnectionsResponse
- type DescribeClientConnectionsResponseParams
- type DescribeDBBackupsRequest
- type DescribeDBBackupsRequestParams
- type DescribeDBBackupsResponse
- type DescribeDBBackupsResponseParams
- type DescribeDBInstanceDealRequest
- type DescribeDBInstanceDealRequestParams
- type DescribeDBInstanceDealResponse
- type DescribeDBInstanceDealResponseParams
- type DescribeDBInstanceNamespaceRequest
- type DescribeDBInstanceNamespaceRequestParams
- type DescribeDBInstanceNamespaceResponse
- type DescribeDBInstanceNamespaceResponseParams
- type DescribeDBInstancesRequest
- type DescribeDBInstancesRequestParams
- type DescribeDBInstancesResponse
- type DescribeDBInstancesResponseParams
- type DescribeDetailedSlowLogsRequest
- type DescribeDetailedSlowLogsRequestParams
- type DescribeDetailedSlowLogsResponse
- type DescribeDetailedSlowLogsResponseParams
- type DescribeInstanceParamsRequest
- type DescribeInstanceParamsRequestParams
- type DescribeInstanceParamsResponse
- type DescribeInstanceParamsResponseParams
- type DescribeSecurityGroupRequest
- type DescribeSecurityGroupRequestParams
- type DescribeSecurityGroupResponse
- type DescribeSecurityGroupResponseParams
- type DescribeSlowLogPatternsRequest
- type DescribeSlowLogPatternsRequestParams
- type DescribeSlowLogPatternsResponse
- type DescribeSlowLogPatternsResponseParams
- type DescribeSlowLogsRequest
- type DescribeSlowLogsRequestParams
- type DescribeSlowLogsResponse
- type DescribeSlowLogsResponseParams
- type DescribeSpecInfoRequest
- type DescribeSpecInfoRequestParams
- type DescribeSpecInfoResponse
- type DescribeSpecInfoResponseParams
- type FlushInstanceRouterConfigRequest
- type FlushInstanceRouterConfigRequestParams
- type FlushInstanceRouterConfigResponse
- type FlushInstanceRouterConfigResponseParams
- type InquirePriceCreateDBInstancesRequest
- type InquirePriceCreateDBInstancesRequestParams
- type InquirePriceCreateDBInstancesResponse
- type InquirePriceCreateDBInstancesResponseParams
- type InquirePriceModifyDBInstanceSpecRequest
- type InquirePriceModifyDBInstanceSpecRequestParams
- type InquirePriceModifyDBInstanceSpecResponse
- type InquirePriceModifyDBInstanceSpecResponseParams
- type InquirePriceRenewDBInstancesRequest
- type InquirePriceRenewDBInstancesRequestParams
- type InquirePriceRenewDBInstancesResponse
- type InquirePriceRenewDBInstancesResponseParams
- type InstanceChargePrepaid
- type InstanceDetail
- type InstanceEnumParam
- type InstanceIntegerParam
- type InstanceMultiParam
- type InstanceTextParam
- type IsolateDBInstanceRequest
- type IsolateDBInstanceRequestParams
- type IsolateDBInstanceResponse
- type IsolateDBInstanceResponseParams
- type ModifyDBInstanceNetworkAddressRequest
- type ModifyDBInstanceNetworkAddressRequestParams
- type ModifyDBInstanceNetworkAddressResponse
- type ModifyDBInstanceNetworkAddressResponseParams
- type ModifyDBInstanceSecurityGroupRequest
- type ModifyDBInstanceSecurityGroupRequestParams
- type ModifyDBInstanceSecurityGroupResponse
- type ModifyDBInstanceSecurityGroupResponseParams
- type ModifyDBInstanceSpecRequest
- type ModifyDBInstanceSpecRequestParams
- type ModifyDBInstanceSpecResponse
- type ModifyDBInstanceSpecResponseParams
- type ModifyNetworkAddress
- type OfflineIsolatedDBInstanceRequest
- type OfflineIsolatedDBInstanceRequestParams
- type OfflineIsolatedDBInstanceResponse
- type OfflineIsolatedDBInstanceResponseParams
- type RemoveNodeList
- type RenameInstanceRequest
- type RenameInstanceRequestParams
- type RenameInstanceResponse
- type RenameInstanceResponseParams
- type RenewDBInstancesRequest
- type RenewDBInstancesRequestParams
- type RenewDBInstancesResponse
- type RenewDBInstancesResponseParams
- type ReplicaSetInfo
- type ResetDBInstancePasswordRequest
- type ResetDBInstancePasswordRequestParams
- type ResetDBInstancePasswordResponse
- type ResetDBInstancePasswordResponseParams
- type SecurityGroup
- type SecurityGroupBound
- type SetDBInstanceDeletionProtectionRequest
- type SetDBInstanceDeletionProtectionRequestParams
- type SetDBInstanceDeletionProtectionResponse
- type SetDBInstanceDeletionProtectionResponseParams
- type ShardInfo
- type SlowLogItem
- type SlowLogPattern
- type SpecItem
- type SpecificationInfo
- type TagInfo
- type TerminateDBInstancesRequest
- type TerminateDBInstancesRequestParams
- type TerminateDBInstancesResponse
- type TerminateDBInstancesResponseParams
Constants ¶
const ( // CAM signature/authentication error AUTHFAILURE = "AuthFailure" // Termination protection is enabled for the instance. destruction is not allowed. FAILEDOPERATION_DELETIONPROTECTIONENABLED = "FailedOperation.DeletionProtectionEnabled" // Public network access has been enabled for the current instance. FAILEDOPERATION_NOTALLOWMODIFYADDRAFTEROPENWANSERVICE = "FailedOperation.NotAllowModifyAddrAfterOpenWanService" // Physical backup is not supported when transparent data encryption is enabled for the instance. FAILEDOPERATION_TRANSPARENTDATAENCRYPTIONALREADYOPEN = "FailedOperation.TransparentDataEncryptionAlreadyOpen" // 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 sub-account 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" // limit value ranges from 1 to 100. INVALIDPARAMETERVALUE_LIMITPARAOUTOFRANGE = "InvalidParameterValue.LimitParaOutOfRange" // 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" // offset value ranges from 0 to 10000. INVALIDPARAMETERVALUE_OFFSETPARAOUTOFRANGE = "InvalidParameterValue.OffsetParaOutOfRange" // 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" // Invalid security group ID INVALIDPARAMETERVALUE_SECURITYGROUPID = "InvalidParameterValue.SecurityGroupId" // The disk size to be set cannot be less than 1.2 times the used disk capacity. INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed" // The value range of the slowMS parameter is [100,65536]. 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" // Illegal time format. INVALIDPARAMETERVALUE_TIMEFORMATERR = "InvalidParameterValue.TimeFormatErr" // 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 API frequency limit is triggered due to frequent requests. LIMITEXCEEDED_TOOMANYREQUESTS = "LimitExceeded.TooManyRequests" // The resource does not exist. RESOURCENOTFOUND = "ResourceNotFound" // Unsupported operation UNSUPPORTEDOPERATION = "UnsupportedOperation" // The current version does not support the operation. UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport" )
const APIVersion = "2019-07-25"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AddNodeList ¶
type AddNodeList struct { // Roles of nodes to be added. // - SECONDARY: Mongod node. // - READONLY: read-only node. // - MONGOS: Mongos node. Role *string `json:"Role,omitnil,omitempty" name:"Role"` // AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1). // - Single AZ: All nodes are in the same AZ. // - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be added should be specified. After addition, the number of nodes in any 2 AZs should be greater than that in the third AZ. Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` }
type AssignProjectRequest ¶
type AssignProjectRequest struct { *tchttp.BaseRequest // Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // Project ID, the unique ID of the project created by the user. Go to the [project management](https://console.cloud.tencent.com/project) area of the account center in the console to copy the project ID. ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` }
func NewAssignProjectRequest ¶
func NewAssignProjectRequest() (request *AssignProjectRequest)
func (*AssignProjectRequest) FromJsonString ¶
func (r *AssignProjectRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AssignProjectRequest) ToJsonString ¶
func (r *AssignProjectRequest) ToJsonString() string
type AssignProjectRequestParams ¶
type AssignProjectRequestParams struct { // Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // Project ID, the unique ID of the project created by the user. Go to the [project management](https://console.cloud.tencent.com/project) area of the account center in the console to copy the project ID. ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` }
Predefined struct for user
type AssignProjectResponse ¶
type AssignProjectResponse struct { *tchttp.BaseResponse Response *AssignProjectResponseParams `json:"Response"` }
func NewAssignProjectResponse ¶
func NewAssignProjectResponse() (response *AssignProjectResponse)
func (*AssignProjectResponse) FromJsonString ¶
func (r *AssignProjectResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*AssignProjectResponse) ToJsonString ¶
func (r *AssignProjectResponse) ToJsonString() string
type AssignProjectResponseParams ¶
type AssignProjectResponseParams struct { // Lists async task ids returned. FlowIds []*uint64 `json:"FlowIds,omitnil,omitempty" name:"FlowIds"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type BackupDownloadTask ¶
type BackupDownloadTask struct { // Task creation time. CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"` // Backup file name. BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"` // Shard name. ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"` // Backup data size, in bytes. BackupSize *int64 `json:"BackupSize,omitnil,omitempty" name:"BackupSize"` // Task status. // - 0: wait for execution. // - 1: downloading. // - 2: download completed. // - 3: download failed. // - 4: wait for retry. Status *int64 `json:"Status,omitnil,omitempty" name:"Status"` // Task progress percentage. Percent *int64 `json:"Percent,omitnil,omitempty" name:"Percent"` // Duration, in seconds. TimeSpend *int64 `json:"TimeSpend,omitnil,omitempty" name:"TimeSpend"` // Download link for backup data. Url *string `json:"Url,omitnil,omitempty" name:"Url"` // Backup method. // - 0: logical backup. // - 1: physical backup. // - 3: snapshot backup. // **Note**: // 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. // 2. Physical backup is not supported when storage encryption is enabled for the instance. BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"` // Specified remarks for initiating backup tasks. BackupDesc *string `json:"BackupDesc,omitnil,omitempty" name:"BackupDesc"` // Region information. Region *string `json:"Region,omitnil,omitempty" name:"Region"` // Bucket information. Bucket *string `json:"Bucket,omitnil,omitempty" name:"Bucket"` }
type BackupDownloadTaskStatus ¶
type BackupDownloadTaskStatus struct { // Shard name. ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"` // Current status of the task. // - 0: wait for execution. // - 1: downloading. // - 2: download completed. // - 3: download failed. // - 4: wait for retry. Status *int64 `json:"Status,omitnil,omitempty" name:"Status"` }
type BackupInfo ¶
type BackupInfo struct { // Instance ID. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Backup method. // - 0: automatic backup. // - 1: manual backup. BackupType *uint64 `json:"BackupType,omitnil,omitempty" name:"BackupType"` // Backup file name. BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"` // Backup task remarks. BackupDesc *string `json:"BackupDesc,omitnil,omitempty" name:"BackupDesc"` // Backup file size, in KB. BackupSize *uint64 `json:"BackupSize,omitnil,omitempty" name:"BackupSize"` // Backup start time. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Backup end time. EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // Backup status. // - 1: backing up. // - 2: backup successful. Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"` // Backup method. // - 0: logical backup. // - 1: physical backup. // - 3: snapshot backup. // **Note:** // - The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. // - Physical backup is not supported when storage encryption is enabled for the instance. BackupMethod *uint64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"` // Backup record ID. BackId *int64 `json:"BackId,omitnil,omitempty" name:"BackId"` // Backup deletion time. DeleteTime *string `json:"DeleteTime,omitnil,omitempty" name:"DeleteTime"` // Cross-region backup region. BackupRegion *string `json:"BackupRegion,omitnil,omitempty" name:"BackupRegion"` // Rollback time supported by the backup. RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"` }
type Client ¶
func NewClient ¶
func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)
func NewClientWithSecretId ¶
Deprecated
func (*Client) AssignProject ¶
func (c *Client) AssignProject(request *AssignProjectRequest) (response *AssignProjectResponse, err error)
AssignProject This API is used to specify the project of a TencentDB for MongoDB instance.
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 of a TencentDB for MongoDB instance.
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 back up an instance.
error code that may be returned:
FAILEDOPERATION_TRANSPARENTDATAENCRYPTIONALREADYOPEN = "FailedOperation.TransparentDataEncryptionAlreadyOpen" 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 back up an instance.
error code that may be returned:
FAILEDOPERATION_TRANSPARENTDATAENCRYPTIONALREADYOPEN = "FailedOperation.TransparentDataEncryptionAlreadyOpen" 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 yearly/monthly subscription TencentDB for MongoDB instance. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/35767?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.
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_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal" INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound" INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound" INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed" INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError" UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"
func (*Client) CreateDBInstanceHourWithContext ¶
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_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal" INVALIDPARAMETERVALUE_TAGNOTFOUND = "InvalidParameterValue.TagNotFound" INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound" INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed" INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError" UNSUPPORTEDOPERATION_VERSIONNOTSUPPORT = "UnsupportedOperation.VersionNotSupport"
func (*Client) CreateDBInstanceWithContext ¶
func (c *Client) CreateDBInstanceWithContext(ctx context.Context, request *CreateDBInstanceRequest) (response *CreateDBInstanceResponse, err error)
CreateDBInstance This API is used to create a yearly/monthly subscription TencentDB for MongoDB instance. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/35767?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.
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 the asynchronous 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 the asynchronous task status.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
func (*Client) DescribeBackupDownloadTask ¶
func (c *Client) DescribeBackupDownloadTask(request *DescribeBackupDownloadTaskRequest) (response *DescribeBackupDownloadTaskResponse, err error)
DescribeBackupDownloadTask This API is used to query information about the backup download task.
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 information about the backup download task.
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 on an instance, including the IP address for connection and the number of connections.
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 on an instance, including the IP address for connection and the number of connections.
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 order details of purchase, renewal, and specification adjustment 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 order details of purchase, renewal, and specification adjustment of a MongoDB instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied"
func (*Client) DescribeDBInstanceNamespace ¶
func (c *Client) DescribeDBInstanceNamespace(request *DescribeDBInstanceNamespaceRequest) (response *DescribeDBInstanceNamespaceResponse, err error)
DescribeDBInstanceNamespace This API is used to query the table information on a database.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter"
func (*Client) DescribeDBInstanceNamespaceWithContext ¶
func (c *Client) DescribeDBInstanceNamespaceWithContext(ctx context.Context, request *DescribeDBInstanceNamespaceRequest) (response *DescribeDBInstanceNamespaceResponse, err error)
DescribeDBInstanceNamespace This API is used to query the table information on a database.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter"
func (*Client) DescribeDBInstances ¶
func (c *Client) DescribeDBInstances(request *DescribeDBInstancesRequest) (response *DescribeDBInstancesResponse, err error)
DescribeDBInstances This API is used to query the list of TencentDB for MongoDB instances. It supports filtering primary instances, disaster recovery instances, and read-only instances by project ID, instance ID, instance status, and other conditions.
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" LIMITEXCEEDED_TOOMANYREQUESTS = "LimitExceeded.TooManyRequests" UNSUPPORTEDOPERATION = "UnsupportedOperation"
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 for MongoDB instances. It supports filtering primary instances, disaster recovery instances, and read-only instances by project ID, instance ID, instance status, and other conditions.
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" LIMITEXCEEDED_TOOMANYREQUESTS = "LimitExceeded.TooManyRequests" UNSUPPORTEDOPERATION = "UnsupportedOperation"
func (*Client) DescribeDetailedSlowLogs ¶
func (c *Client) DescribeDetailedSlowLogs(request *DescribeDetailedSlowLogsRequest) (response *DescribeDetailedSlowLogsResponse, err error)
DescribeDetailedSlowLogs This API is used to query slow log details of the instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITPARAOUTOFRANGE = "InvalidParameterValue.LimitParaOutOfRange" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_OFFSETPARAOUTOFRANGE = "InvalidParameterValue.OffsetParaOutOfRange" INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit" INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit" INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime" INVALIDPARAMETERVALUE_TIMEFORMATERR = "InvalidParameterValue.TimeFormatErr"
func (*Client) DescribeDetailedSlowLogsWithContext ¶
func (c *Client) DescribeDetailedSlowLogsWithContext(ctx context.Context, request *DescribeDetailedSlowLogsRequest) (response *DescribeDetailedSlowLogsResponse, err error)
DescribeDetailedSlowLogs This API is used to query slow log details of the instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETERVALUE_LIMITPARAOUTOFRANGE = "InvalidParameterValue.LimitParaOutOfRange" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_OFFSETPARAOUTOFRANGE = "InvalidParameterValue.OffsetParaOutOfRange" INVALIDPARAMETERVALUE_QUERYTIMERANGEBEYONDLIMIT = "InvalidParameterValue.QueryTimeRangeBeyondLimit" INVALIDPARAMETERVALUE_SLOWMSBELOWLIMIT = "InvalidParameterValue.SlowMSBelowLimit" INVALIDPARAMETERVALUE_STARTTIMENOTBEFORETHANENDTIME = "InvalidParameterValue.StartTimeNotBeforeThanEndTime" INVALIDPARAMETERVALUE_TIMEFORMATERR = "InvalidParameterValue.TimeFormatErr"
func (*Client) DescribeInstanceParams ¶
func (c *Client) DescribeInstanceParams(request *DescribeInstanceParamsRequest) (response *DescribeInstanceParamsResponse, err error)
DescribeInstanceParams This API is used to query the list of parameters that can be modified for the current 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 list of parameters that can be modified for the current 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 security groups bound to an instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" 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 security groups bound to an instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
func (*Client) DescribeSlowLogPatterns ¶
func (c *Client) DescribeSlowLogPatterns(request *DescribeSlowLogPatternsRequest) (response *DescribeSlowLogPatternsResponse, err error)
DescribeSlowLogPatterns 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 sales specification of an instance.
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 sales specification of an instance.
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" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" 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" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" 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_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError" INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError" INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError" INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale" INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed" INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
func (*Client) InquirePriceCreateDBInstancesWithContext ¶
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_MACHINETYPEERROR = "InvalidParameterValue.MachineTypeError" INVALIDPARAMETERVALUE_MONGOVERSIONERROR = "InvalidParameterValue.MongoVersionError" INVALIDPARAMETERVALUE_REPLICASETNUMERROR = "InvalidParameterValue.ReplicaSetNumError" INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale" INVALIDPARAMETERVALUE_ZONECLOSED = "InvalidParameterValue.ZoneClosed" INVALIDPARAMETERVALUE_ZONEERROR = "InvalidParameterValue.ZoneError"
func (*Client) InquirePriceModifyDBInstanceSpec ¶
func (c *Client) InquirePriceModifyDBInstanceSpec(request *InquirePriceModifyDBInstanceSpecRequest) (response *InquirePriceModifyDBInstanceSpecResponse, err error)
InquirePriceModifyDBInstanceSpec This API is used to query the 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 the 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_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation" 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_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation" 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. After isolation, the instance is retained in the recycle bin, and data cannot be written into it. After a certain period of isolation, the instance is deleted permanently. For the retention time in the recycle bin, see the pay-as-you-go service terms. The deleted pay-as-you-go instance cannot be recovered. Proceed with caution.
error code that may be returned:
FAILEDOPERATION_DELETIONPROTECTIONENABLED = "FailedOperation.DeletionProtectionEnabled" 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. After isolation, the instance is retained in the recycle bin, and data cannot be written into it. After a certain period of isolation, the instance is deleted permanently. For the retention time in the recycle bin, see the pay-as-you-go service terms. The deleted pay-as-you-go instance cannot be recovered. Proceed with caution.
error code that may be returned:
FAILEDOPERATION_DELETIONPROTECTIONENABLED = "FailedOperation.DeletionProtectionEnabled" 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 information on a TencentDB for MongoDB instance. It supports switching from a basic network to a VPC network or from one VPC network to another VPC network.
error code that may be returned:
FAILEDOPERATION_NOTALLOWMODIFYADDRAFTEROPENWANSERVICE = "FailedOperation.NotAllowModifyAddrAfterOpenWanService" INTERNALERROR = "InternalError" INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_INVALIDVIP = "InvalidParameter.InvalidVip" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal" INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
func (*Client) ModifyDBInstanceNetworkAddressWithContext ¶
func (c *Client) ModifyDBInstanceNetworkAddressWithContext(ctx context.Context, request *ModifyDBInstanceNetworkAddressRequest) (response *ModifyDBInstanceNetworkAddressResponse, err error)
ModifyDBInstanceNetworkAddress This API is used to modify the network information on a TencentDB for MongoDB instance. It supports switching from a basic network to a VPC network or from one VPC network to another VPC network.
error code that may be returned:
FAILEDOPERATION_NOTALLOWMODIFYADDRAFTEROPENWANSERVICE = "FailedOperation.NotAllowModifyAddrAfterOpenWanService" INTERNALERROR = "InternalError" INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_INVALIDVIP = "InvalidParameter.InvalidVip" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal" INVALIDPARAMETERVALUE_VPCIDORSUBNETIDNOTFOUND = "InvalidParameterValue.VpcIdOrSubnetIdNotFound"
func (*Client) ModifyDBInstanceSecurityGroup ¶
func (c *Client) ModifyDBInstanceSecurityGroup(request *ModifyDBInstanceSecurityGroupRequest) (response *ModifyDBInstanceSecurityGroupResponse, err error)
ModifyDBInstanceSecurityGroup This API is used to modify security groups bound to an instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_SECURITYGROUPID = "InvalidParameterValue.SecurityGroupId" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
func (*Client) ModifyDBInstanceSecurityGroupWithContext ¶
func (c *Client) ModifyDBInstanceSecurityGroupWithContext(ctx context.Context, request *ModifyDBInstanceSecurityGroupRequest) (response *ModifyDBInstanceSecurityGroupResponse, err error)
ModifyDBInstanceSecurityGroup This API is used to modify security groups bound to an instance.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_LOCKFAILED = "InvalidParameterValue.LockFailed" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_SECURITYGROUPID = "InvalidParameterValue.SecurityGroupId" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
func (*Client) ModifyDBInstanceSpec ¶
func (c *Client) ModifyDBInstanceSpec(request *ModifyDBInstanceSpecRequest) (response *ModifyDBInstanceSpecResponse, err error)
ModifyDBInstanceSpec This API is used to adjust the TencentDB for MongoDB instance configuration. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.
error code that may be returned:
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETER_ZONECLOSED = "InvalidParameter.ZoneClosed" INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation" INVALIDPARAMETERVALUE_MODIFYMODEERROR = "InvalidParameterValue.ModifyModeError" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_OPLOGSIZEOUTOFRANGE = "InvalidParameterValue.OplogSizeOutOfRange" INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed" INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
func (*Client) ModifyDBInstanceSpecWithContext ¶
func (c *Client) ModifyDBInstanceSpecWithContext(ctx context.Context, request *ModifyDBInstanceSpecRequest) (response *ModifyDBInstanceSpecResponse, err error)
ModifyDBInstanceSpec This API is used to adjust the TencentDB for MongoDB instance configuration. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to query and obtain the supported sales specifications.
error code that may be returned:
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETER_ZONECLOSED = "InvalidParameter.ZoneClosed" INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation" INVALIDPARAMETERVALUE_MODIFYMODEERROR = "InvalidParameterValue.ModifyModeError" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_OPLOGSIZEOUTOFRANGE = "InvalidParameterValue.OplogSizeOutOfRange" INVALIDPARAMETERVALUE_SETDISKLESSTHANUSED = "InvalidParameterValue.SetDiskLessThanUsed" INVALIDPARAMETERVALUE_SPECNOTONSALE = "InvalidParameterValue.SpecNotOnSale" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
func (*Client) OfflineIsolatedDBInstance ¶
func (c *Client) OfflineIsolatedDBInstance(request *OfflineIsolatedDBInstanceRequest) (response *OfflineIsolatedDBInstanceResponse, err error)
OfflineIsolatedDBInstance 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" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
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" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
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:
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation" 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:
INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_INVALIDTRADEOPERATION = "InvalidParameterValue.InvalidTradeOperation" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
func (*Client) ResetDBInstancePassword ¶
func (c *Client) ResetDBInstancePassword(request *ResetDBInstancePasswordRequest) (response *ResetDBInstancePasswordResponse, err error)
ResetDBInstancePassword This API is used to reset the instance access 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 reset the instance access 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) SetDBInstanceDeletionProtection ¶
func (c *Client) SetDBInstanceDeletionProtection(request *SetDBInstanceDeletionProtectionRequest) (response *SetDBInstanceDeletionProtectionResponse, err error)
SetDBInstanceDeletionProtection This API is used to set instance termination protection.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted" INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
func (*Client) SetDBInstanceDeletionProtectionWithContext ¶
func (c *Client) SetDBInstanceDeletionProtectionWithContext(ctx context.Context, request *SetDBInstanceDeletionProtectionRequest) (response *SetDBInstanceDeletionProtectionResponse, err error)
SetDBInstanceDeletionProtection This API is used to set instance termination protection.
error code that may be returned:
INTERNALERROR = "InternalError" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_INSTANCEHASBEENDELETED = "InvalidParameterValue.InstanceHasBeenDeleted" INVALIDPARAMETERVALUE_INSTANCEHASBEENISOLATED = "InvalidParameterValue.InstanceHasBeenIsolated" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance"
func (*Client) TerminateDBInstances ¶
func (c *Client) TerminateDBInstances(request *TerminateDBInstancesRequest) (response *TerminateDBInstancesResponse, err error)
TerminateDBInstances This API is used to terminate monthly subscription billing instances.
error code that may be returned:
FAILEDOPERATION_DELETIONPROTECTIONENABLED = "FailedOperation.DeletionProtectionEnabled" INTERNALERROR = "InternalError" INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed" INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
func (*Client) TerminateDBInstancesWithContext ¶
func (c *Client) TerminateDBInstancesWithContext(ctx context.Context, request *TerminateDBInstancesRequest) (response *TerminateDBInstancesResponse, err error)
TerminateDBInstances This API is used to terminate monthly subscription billing instances.
error code that may be returned:
FAILEDOPERATION_DELETIONPROTECTIONENABLED = "FailedOperation.DeletionProtectionEnabled" INTERNALERROR = "InternalError" INTERNALERROR_CHECKAPPIDFAILED = "InternalError.CheckAppIdFailed" INVALIDPARAMETER = "InvalidParameter" INVALIDPARAMETER_PERMISSIONDENIED = "InvalidParameter.PermissionDenied" INVALIDPARAMETERVALUE_CHECKAPPIDFAILED = "InvalidParameterValue.CheckAppIdFailed" INVALIDPARAMETERVALUE_ILLEGALINSTANCENAME = "InvalidParameterValue.IllegalInstanceName" INVALIDPARAMETERVALUE_NOTFOUNDINSTANCE = "InvalidParameterValue.NotFoundInstance" INVALIDPARAMETERVALUE_STATUSABNORMAL = "InvalidParameterValue.StatusAbnormal"
type ClientConnection ¶
type ClientConnection struct { // IP address of the connected client. IP *string `json:"IP,omitnil,omitempty" name:"IP"` // Number of connections corresponding to the client IP address. Count *uint64 `json:"Count,omitnil,omitempty" name:"Count"` // Whether it is an internal IP address. InternalService *bool `json:"InternalService,omitnil,omitempty" name:"InternalService"` }
type CreateBackupDBInstanceRequest ¶
type CreateBackupDBInstanceRequest struct { *tchttp.BaseRequest // Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Sets the backup method. // - 0: logical backup. // - 1: physical backup. // - 3: snapshot backup. // **Note**: // 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. // 2. Physical backup is not supported when storage encryption is enabled for the instance. BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"` // Backup remarks information. BackupRemark *string `json:"BackupRemark,omitnil,omitempty" name:"BackupRemark"` }
func NewCreateBackupDBInstanceRequest ¶
func NewCreateBackupDBInstanceRequest() (request *CreateBackupDBInstanceRequest)
func (*CreateBackupDBInstanceRequest) FromJsonString ¶
func (r *CreateBackupDBInstanceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateBackupDBInstanceRequest) ToJsonString ¶
func (r *CreateBackupDBInstanceRequest) ToJsonString() string
type CreateBackupDBInstanceRequestParams ¶
type CreateBackupDBInstanceRequestParams struct { // Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Sets the backup method. // - 0: logical backup. // - 1: physical backup. // - 3: snapshot backup. // **Note**: // 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. // 2. Physical backup is not supported when storage encryption is enabled for the instance. BackupMethod *int64 `json:"BackupMethod,omitnil,omitempty" name:"BackupMethod"` // Backup remarks information. BackupRemark *string `json:"BackupRemark,omitnil,omitempty" name:"BackupRemark"` }
Predefined struct for user
type CreateBackupDBInstanceResponse ¶
type CreateBackupDBInstanceResponse struct { *tchttp.BaseResponse Response *CreateBackupDBInstanceResponseParams `json:"Response"` }
func NewCreateBackupDBInstanceResponse ¶
func NewCreateBackupDBInstanceResponse() (response *CreateBackupDBInstanceResponse)
func (*CreateBackupDBInstanceResponse) FromJsonString ¶
func (r *CreateBackupDBInstanceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateBackupDBInstanceResponse) ToJsonString ¶
func (r *CreateBackupDBInstanceResponse) ToJsonString() string
type CreateBackupDBInstanceResponseParams ¶
type CreateBackupDBInstanceResponseParams struct { // Request ID. AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type CreateBackupDownloadTaskRequest ¶
type CreateBackupDownloadTaskRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Name of the backup file to be downloaded. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain it. BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"` // Specifies the node ID of the replica set to be downloaded or the shard node ID list of the sharded cluster. // - If the replica set instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0, full data can be downloaded. // - If the sharded cluster instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1, download the data of Shard 0 and Shard 1. If a full download is needed for the sharded cluster, import all shard names as shown in the example. BackupSets []*ReplicaSetInfo `json:"BackupSets,omitnil,omitempty" name:"BackupSets"` }
func NewCreateBackupDownloadTaskRequest ¶
func NewCreateBackupDownloadTaskRequest() (request *CreateBackupDownloadTaskRequest)
func (*CreateBackupDownloadTaskRequest) FromJsonString ¶
func (r *CreateBackupDownloadTaskRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateBackupDownloadTaskRequest) ToJsonString ¶
func (r *CreateBackupDownloadTaskRequest) ToJsonString() string
type CreateBackupDownloadTaskRequestParams ¶
type CreateBackupDownloadTaskRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Name of the backup file to be downloaded. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain it. BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"` // Specifies the node ID of the replica set to be downloaded or the shard node ID list of the sharded cluster. // - If the replica set instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0, full data can be downloaded. // - If the sharded cluster instance ID is cmgo-p8vnipr5, for example, BackupSets.0=cmgo-p8vnipr5_0&BackupSets.1=cmgo-p8vnipr5_1, download the data of Shard 0 and Shard 1. If a full download is needed for the sharded cluster, import all shard names as shown in the example. BackupSets []*ReplicaSetInfo `json:"BackupSets,omitnil,omitempty" name:"BackupSets"` }
Predefined struct for user
type CreateBackupDownloadTaskResponse ¶
type CreateBackupDownloadTaskResponse struct { *tchttp.BaseResponse Response *CreateBackupDownloadTaskResponseParams `json:"Response"` }
func NewCreateBackupDownloadTaskResponse ¶
func NewCreateBackupDownloadTaskResponse() (response *CreateBackupDownloadTaskResponse)
func (*CreateBackupDownloadTaskResponse) FromJsonString ¶
func (r *CreateBackupDownloadTaskResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateBackupDownloadTaskResponse) ToJsonString ¶
func (r *CreateBackupDownloadTaskResponse) ToJsonString() string
type CreateBackupDownloadTaskResponseParams ¶
type CreateBackupDownloadTaskResponseParams struct { // Status of the download task. Tasks []*BackupDownloadTaskStatus `json:"Tasks,omitnil,omitempty" name:"Tasks"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type CreateDBInstanceHourRequest ¶
type CreateDBInstanceHourRequest struct { *tchttp.BaseRequest // Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum disk sizes corresponding to each CPU specification. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1. // - Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively. ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set. // - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard. NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions. // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Product specification type. // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk type. MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"` // Number of instances. The minimum value is 1, and the maximum value is 30. GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"` // AZ information in the format of ap-guangzhou-2 // - For more information, query through the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. // - 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,omitnil,omitempty" name:"Zone"` // Instance architecture type // - REPLSET: Replica set // - SHARD: Sharded cluster ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // VPC ID. // - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID. // - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // Subnet ID of the VPC. // - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID. // - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Instance password. The requirements are as follows: // - The number of characters should be in the range of [8, 32]. // - Characters within the ranges [A,Z], [a,z], and [0,9] are allowed. // - Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_). // - It cannot contain only the same letters or digits. Password *string `json:"Password,omitnil,omitempty" name:"Password"` // Project ID. - The default project is used if this parameter is not specified. // - The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project). ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` // Instance tag information Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` // Instance type. // - 1: formal instance. // - 3: read-only instance. // - 4: disaster recovery instance. // - 5. cloned instance. Note: For a cloned instance, RestoreTime is required. Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"` // Parent instance ID. // - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list. Father *string `json:"Father,omitnil,omitempty" name:"Father"` // Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance. SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"` // Rollback time of the cloned instance // - This parameter is required for a cloned instance in the format of 2021-08-13 16:30:00. // - Time range for rollback: You can roll back data in the last 7 days. RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"` // Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently. // - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively. // - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7. // - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db. InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"` // Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances. // - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]. // - The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs. // - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ. AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"` // Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"` // Mongos node memory size. // - This parameter is required during sharded cluster instance purchase. // - Unit: GB. 1-core 2 GB, 2-core 4 GB, 4-core 8 GB, 8-core 16 GB, and 16-core 32 GB are supported. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Number of Mongos nodes. This parameter is required during sharded cluster instance purchase. // - For instances in single-AZ deployment mode, the value range is [3,32]. // - For instances in multi-AZ deployment mode, the value range is [6,32]. MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"` // Number of read-only nodes. Value ranges: [0,5]. ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"` // Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**. ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"` // AZ where the hidden node resides, which is required in cross-AZ instance deployment. HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"` // Parameter template ID. // - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database. // - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture. ParamTemplateId *string `json:"ParamTemplateId,omitnil,omitempty" name:"ParamTemplateId"` }
func NewCreateDBInstanceHourRequest ¶
func NewCreateDBInstanceHourRequest() (request *CreateDBInstanceHourRequest)
func (*CreateDBInstanceHourRequest) FromJsonString ¶
func (r *CreateDBInstanceHourRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateDBInstanceHourRequest) ToJsonString ¶
func (r *CreateDBInstanceHourRequest) ToJsonString() string
type CreateDBInstanceHourRequestParams ¶
type CreateDBInstanceHourRequestParams struct { // Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum disk sizes corresponding to each CPU specification. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1. // - Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively. ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set. // - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard. NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions. // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Product specification type. // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk type. MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"` // Number of instances. The minimum value is 1, and the maximum value is 30. GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"` // AZ information in the format of ap-guangzhou-2 // - For more information, query through the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. // - 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,omitnil,omitempty" name:"Zone"` // Instance architecture type // - REPLSET: Replica set // - SHARD: Sharded cluster ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // VPC ID. // - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID. // - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // Subnet ID of the VPC. // - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID. // - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Instance password. The requirements are as follows: // - The number of characters should be in the range of [8, 32]. // - Characters within the ranges [A,Z], [a,z], and [0,9] are allowed. // - Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_). // - It cannot contain only the same letters or digits. Password *string `json:"Password,omitnil,omitempty" name:"Password"` // Project ID. - The default project is used if this parameter is not specified. // - The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project). ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` // Instance tag information Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` // Instance type. // - 1: formal instance. // - 3: read-only instance. // - 4: disaster recovery instance. // - 5. cloned instance. Note: For a cloned instance, RestoreTime is required. Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"` // Parent instance ID. // - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list. Father *string `json:"Father,omitnil,omitempty" name:"Father"` // Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance. SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"` // Rollback time of the cloned instance // - This parameter is required for a cloned instance in the format of 2021-08-13 16:30:00. // - Time range for rollback: You can roll back data in the last 7 days. RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"` // Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently. // - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively. // - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7. // - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db. InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"` // Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances. // - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]. // - The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs. // - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ. AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"` // Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"` // Mongos node memory size. // - This parameter is required during sharded cluster instance purchase. // - Unit: GB. 1-core 2 GB, 2-core 4 GB, 4-core 8 GB, 8-core 16 GB, and 16-core 32 GB are supported. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Number of Mongos nodes. This parameter is required during sharded cluster instance purchase. // - For instances in single-AZ deployment mode, the value range is [3,32]. // - For instances in multi-AZ deployment mode, the value range is [6,32]. MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"` // Number of read-only nodes. Value ranges: [0,5]. ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"` // Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**. ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"` // AZ where the hidden node resides, which is required in cross-AZ instance deployment. HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"` // Parameter template ID. // - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database. // - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture. ParamTemplateId *string `json:"ParamTemplateId,omitnil,omitempty" name:"ParamTemplateId"` }
Predefined struct for user
type CreateDBInstanceHourResponse ¶
type CreateDBInstanceHourResponse struct { *tchttp.BaseResponse Response *CreateDBInstanceHourResponseParams `json:"Response"` }
func NewCreateDBInstanceHourResponse ¶
func NewCreateDBInstanceHourResponse() (response *CreateDBInstanceHourResponse)
func (*CreateDBInstanceHourResponse) FromJsonString ¶
func (r *CreateDBInstanceHourResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateDBInstanceHourResponse) ToJsonString ¶
func (r *CreateDBInstanceHourResponse) ToJsonString() string
type CreateDBInstanceHourResponseParams ¶
type CreateDBInstanceHourResponseParams struct { // Order ID DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"` // List of IDs of the created instances InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type CreateDBInstanceRequest ¶
type CreateDBInstanceRequest struct { *tchttp.BaseRequest // - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set. // - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard. NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum disk sizes corresponding to each CPU specification. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions. // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Number of instances. The minimum value is 1, and the maximum value is 30. GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"` // AZ information. Format: ap-guangzhou-2. // - Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the specific information. // - This parameter indicates the primary AZ. If multi-AZ deployment is adopted, the value of Zone should be one of the values of AvailabilityZoneList. Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` // Specifies the purchase duration during the instance purchase, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Period *uint64 `json:"Period,omitnil,omitempty" name:"Period"` // Product specification type. // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk type. MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"` // Instance architecture type. // - REPLSET: replica set. // - SHARD: sharded cluster. ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1. // - Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively. ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // Project ID. - The default project is used if this parameter is not specified. // - The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project). ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` // VPC ID. // - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID. // - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // Subnet ID of the VPC. // - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID. // - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Instance password. The requirements are as follows: // - The number of characters should be in the range of [8, 32]. // - Characters within the ranges [A,Z], [a,z], and [0,9] are allowed. // - Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_). // - It cannot contain only the same letters or digits. Password *string `json:"Password,omitnil,omitempty" name:"Password"` // Instance tag information. Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` // Automatic renewal flag. // - 0: no automatic renewal. // - 1: automatic renewal. AutoRenewFlag *uint64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"` // Whether to automatically select a voucher. // - 1: yes. // - 0: no. Default value: 0. AutoVoucher *uint64 `json:"AutoVoucher,omitnil,omitempty" name:"AutoVoucher"` // Instance type. // - 1: formal instance. // - 3: read-only instance. // - 4: disaster recovery instance. // - 5: cloned instance. Note: For a cloned instance, RestoreTime is required. Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"` // Parent instance ID. // - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list. Father *string `json:"Father,omitnil,omitempty" name:"Father"` // Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance. SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"` // Rollback time of the cloned instance. It is required when the Clone value is 5 or 6. - This parameter is required for cloned instances. Format: 2021-08-13 16:30:00. - Rollback time range: Only data within the last 7 days can be rolled back. RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"` // Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently. // - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively. // - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7. // - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db. InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"` // Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances. // - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]. // - The [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs. // - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ. AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"` // Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"` // Mongos node memory size. // - This parameter is required during sharded cluster instance purchase. // - Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Number of Mongos nodes. This parameter is required during sharded cluster instance purchase. // - For instances in single-AZ deployment mode, the value range is [3,32]. // - For instances in multi-AZ deployment mode, the value range is [6,32]. MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"` // Number of read-only nodes. Value ranges: [0,5]. ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"` // Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**. ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"` // AZ of the hidden node. This parameter is required for instances in multi-AZ deployment mode. HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"` // Parameter template ID. // - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database. // - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture. ParamTemplateId *string `json:"ParamTemplateId,omitnil,omitempty" name:"ParamTemplateId"` }
func NewCreateDBInstanceRequest ¶
func NewCreateDBInstanceRequest() (request *CreateDBInstanceRequest)
func (*CreateDBInstanceRequest) FromJsonString ¶
func (r *CreateDBInstanceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateDBInstanceRequest) ToJsonString ¶
func (r *CreateDBInstanceRequest) ToJsonString() string
type CreateDBInstanceRequestParams ¶
type CreateDBInstanceRequestParams struct { // - Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set. // - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard. NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Instance memory size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain specific saleable memory specifications. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size. Unit: GB. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum disk sizes corresponding to each CPU specification. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Refers to version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain detailed information about the supported versions. // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Number of instances. The minimum value is 1, and the maximum value is 30. GoodsNum *uint64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"` // AZ information. Format: ap-guangzhou-2. // - Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to obtain the specific information. // - This parameter indicates the primary AZ. If multi-AZ deployment is adopted, the value of Zone should be one of the values of AvailabilityZoneList. Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` // Specifies the purchase duration during the instance purchase, in months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Period *uint64 `json:"Period,omitnil,omitempty" name:"Period"` // Product specification type. // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk type. MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"` // Instance architecture type. // - REPLSET: replica set. // - SHARD: sharded cluster. ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1. // - Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively. ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // Project ID. - The default project is used if this parameter is not specified. // - The project ID can be obtained on the [project management page in the TencentDB for MongoDB console](https://console.cloud.tencent.com/project). ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` // VPC ID. // - Only VPC configuration is supported, and a VPC in the same region as the instance should be selected. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available VPC ID. // - After successful instance creation, VPCs can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // Subnet ID of the VPC. // - A subnet should be specified within the selected VPC. Log in to the [VPC console](https://console.cloud.tencent.com/vpc) to obtain the available subnet ID. // - After successful instance creation, VPCs and subnets can be changed. For detailed operations, see [Changing the Network](https://www.tencentcloud.comom/document/product/239/30910?from_cn_redirect=1). SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Instance password. The requirements are as follows: // - The number of characters should be in the range of [8, 32]. // - Characters within the ranges [A,Z], [a,z], and [0,9] are allowed. // - Special characters that can be entered include exclamation marks (!), at signs (@), number signs (#), percent signs (%), carets (^), asterisks (\*), brackets (()), and underscores (_). // - It cannot contain only the same letters or digits. Password *string `json:"Password,omitnil,omitempty" name:"Password"` // Instance tag information. Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` // Automatic renewal flag. // - 0: no automatic renewal. // - 1: automatic renewal. AutoRenewFlag *uint64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"` // Whether to automatically select a voucher. // - 1: yes. // - 0: no. Default value: 0. AutoVoucher *uint64 `json:"AutoVoucher,omitnil,omitempty" name:"AutoVoucher"` // Instance type. // - 1: formal instance. // - 3: read-only instance. // - 4: disaster recovery instance. // - 5: cloned instance. Note: For a cloned instance, RestoreTime is required. Clone *int64 `json:"Clone,omitnil,omitempty" name:"Clone"` // Parent instance ID. // - This parameter is required when the value of the **Clone** parameter is set to 3 or 4, indicating a read-only or disaster recovery instance. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the parent instance ID from the instance list. Father *string `json:"Father,omitnil,omitempty" name:"Father"` // Security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) to obtain the ID of the security group in the same region as the database instance. SecurityGroup []*string `json:"SecurityGroup,omitnil,omitempty" name:"SecurityGroup"` // Rollback time of the cloned instance. It is required when the Clone value is 5 or 6. - This parameter is required for cloned instances. Format: 2021-08-13 16:30:00. - Rollback time range: Only data within the last 7 days can be rolled back. RestoreTime *string `json:"RestoreTime,omitnil,omitempty" name:"RestoreTime"` // Instance name. Only Chinese characters, letters, digits, underscores (_), and delimiters (-) are supported, with a length of 128 characters. When database instances are purchased in batches, the automatic ascending feature is supported through the custom naming pattern string and numeric suffix to set instance names efficiently. // - Basic mode: prefix + automatic ascending number (starting from 1 by default). Only a custom instance name prefix is required for **lnstanceName**. For example, it can be set to cmgo. If the purchase quantity is set to 5, after purchase, the instances will be sequentially named cmgo1, cmgo2, cmgo3, cmgo4, and cmgo5, respectively. // - Custom starting number mode: prefix + {R:x} (x is the custom starting number). Prefix{R:x} is required for **InstanceName**. For example, cmgo{R:3}. If the purchase quantity is set to 5, the instance names will be sequentially named cmgo3, cmgo4, cmgo5, cmgo6, and cmgo7. // - Composite pattern string: prefix 1{R:x} + prefix 2{R:y}+ ⋯ + fixed suffix, where x and y are the starting numbers of each prefix. A composite pattern string is required for **instanceName**. For example, cmgo{R:10}\_node{R:12}\_db. If the batch purchase quantity is set to 5, the instances will be sequentially named cmgo10\_node12\_db, cmgo11\_node13\_db, cmgo12\_node14\_db, cmgo13\_node15\_db, and cmgo14\_node16\_db. InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"` // Specifies the list of AZs during multi-AZ deployment of TencentDB for MongoDB instances. // - For instances in multi-AZ deployment mode, the **Zone** parameter specifies the primary AZ, and **AvailabilityZoneList** specifies all AZs, including the primary AZ. Format: [ap-guangzhou-2,ap-guangzhou-3,ap-guangzhou-4]. // - The [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API can be called to obtain AZs planned for TencentDB for MongoDB instances in different regions, helping you specify valid AZs. // - Nodes in multi-AZ deployment mode can only be deployed in 3 different AZs. Deploying most nodes of a cluster in the same AZ is not supported. For example, a 3-node cluster does not support deploying 2 nodes in the same AZ. AvailabilityZoneList []*string `json:"AvailabilityZoneList,omitnil,omitempty" name:"AvailabilityZoneList"` // Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"` // Mongos node memory size. // - This parameter is required during sharded cluster instance purchase. // - Unit: GB. 1-core 2GB, 2-core 4GB, 4-core 8GB, 8-core 16GB, and 16-core 32GB are supported. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Number of Mongos nodes. This parameter is required during sharded cluster instance purchase. // - For instances in single-AZ deployment mode, the value range is [3,32]. // - For instances in multi-AZ deployment mode, the value range is [6,32]. MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"` // Number of read-only nodes. Value ranges: [0,5]. ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"` // Array of AZs of read-only nodes. This parameter is required for instances in multi-AZ deployment mode when **ReadonlyNodeNum** is not set to **0**. ReadonlyNodeAvailabilityZoneList []*string `json:"ReadonlyNodeAvailabilityZoneList,omitnil,omitempty" name:"ReadonlyNodeAvailabilityZoneList"` // AZ of the hidden node. This parameter is required for instances in multi-AZ deployment mode. HiddenZone *string `json:"HiddenZone,omitnil,omitempty" name:"HiddenZone"` // Parameter template ID. // - A parameter template is a collection of predefined parameter values that can be used to quickly configure new MongoDB instances. Proper use of parameter templates can significantly enhance the deployment efficiency and operational performance of the database. // - The [DescribeDBInstanceParamTpl](https://www.tencentcloud.comom/document/product/240/109155?from_cn_redirect=1) API can be called to obtain the parameter template ID. Select the parameter template ID corresponding to the instance version and architecture. ParamTemplateId *string `json:"ParamTemplateId,omitnil,omitempty" name:"ParamTemplateId"` }
Predefined struct for user
type CreateDBInstanceResponse ¶
type CreateDBInstanceResponse struct { *tchttp.BaseResponse Response *CreateDBInstanceResponseParams `json:"Response"` }
func NewCreateDBInstanceResponse ¶
func NewCreateDBInstanceResponse() (response *CreateDBInstanceResponse)
func (*CreateDBInstanceResponse) FromJsonString ¶
func (r *CreateDBInstanceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*CreateDBInstanceResponse) ToJsonString ¶
func (r *CreateDBInstanceResponse) ToJsonString() string
type CreateDBInstanceResponseParams ¶
type CreateDBInstanceResponseParams struct { // Order ID. DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"` // List of IDs of created instances. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DBInstanceInfo ¶
type DBInstancePrice ¶
type DBInstancePrice struct { // Unit price of the instance, in USD. UnitPrice *float64 `json:"UnitPrice,omitnil,omitempty" name:"UnitPrice"` // Original price of the instance, in USD. OriginalPrice *float64 `json:"OriginalPrice,omitnil,omitempty" name:"OriginalPrice"` // Discount price of the instance, in USD. DiscountPrice *float64 `json:"DiscountPrice,omitnil,omitempty" name:"DiscountPrice"` }
type DescribeAsyncRequestInfoRequest ¶
type DescribeAsyncRequestInfoRequest struct { *tchttp.BaseRequest // Specifies the ID of the asynchronous request to be queried. When an asynchronous process is involved in the API operation (such as [CreateBackupDBInstance](https://www.tencentcloud.comom/document/product/240/46599?from_cn_redirect=1)), the response value of AsyncRequestId is the ID to be filled in for this parameter. AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"` }
func NewDescribeAsyncRequestInfoRequest ¶
func NewDescribeAsyncRequestInfoRequest() (request *DescribeAsyncRequestInfoRequest)
func (*DescribeAsyncRequestInfoRequest) FromJsonString ¶
func (r *DescribeAsyncRequestInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAsyncRequestInfoRequest) ToJsonString ¶
func (r *DescribeAsyncRequestInfoRequest) ToJsonString() string
type DescribeAsyncRequestInfoRequestParams ¶
type DescribeAsyncRequestInfoRequestParams struct { // Specifies the ID of the asynchronous request to be queried. When an asynchronous process is involved in the API operation (such as [CreateBackupDBInstance](https://www.tencentcloud.comom/document/product/240/46599?from_cn_redirect=1)), the response value of AsyncRequestId is the ID to be filled in for this parameter. AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"` }
Predefined struct for user
type DescribeAsyncRequestInfoResponse ¶
type DescribeAsyncRequestInfoResponse struct { *tchttp.BaseResponse Response *DescribeAsyncRequestInfoResponseParams `json:"Response"` }
func NewDescribeAsyncRequestInfoResponse ¶
func NewDescribeAsyncRequestInfoResponse() (response *DescribeAsyncRequestInfoResponse)
func (*DescribeAsyncRequestInfoResponse) FromJsonString ¶
func (r *DescribeAsyncRequestInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeAsyncRequestInfoResponse) ToJsonString ¶
func (r *DescribeAsyncRequestInfoResponse) ToJsonString() string
type DescribeAsyncRequestInfoResponseParams ¶
type DescribeAsyncRequestInfoResponseParams 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,omitnil,omitempty" name:"Status"` // Task execution start time. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Task execution end time. EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeBackupDownloadTaskRequest ¶
type DescribeBackupDownloadTaskRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name. BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"` // Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default. EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // Number of entries returned for this query. Value range: 1–100. The default value is 20. Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Specifies the number of pages returned for this query. The default value is 0. Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Sorting field. // - createTime: sort by the creation time of the backup download task. The default value is createTime. // - finishTime: sort by the completion time of the backup download task. OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"` // Sorting method. // - asc: ascending order. // - desc: descending order. The default value is desc. OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"` // Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. // - 0: wait for execution. // - 1: downloading. // - 2: download completed. // - 3: download failed. // - 4: wait for retry. Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"` }
func NewDescribeBackupDownloadTaskRequest ¶
func NewDescribeBackupDownloadTaskRequest() (request *DescribeBackupDownloadTaskRequest)
func (*DescribeBackupDownloadTaskRequest) FromJsonString ¶
func (r *DescribeBackupDownloadTaskRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeBackupDownloadTaskRequest) ToJsonString ¶
func (r *DescribeBackupDownloadTaskRequest) ToJsonString() string
type DescribeBackupDownloadTaskRequestParams ¶
type DescribeBackupDownloadTaskRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the backup file name for filtering download tasks of the specified file. The [DescribeDBBackups](https://www.tencentcloud.comom/document/product/240/38574?from_cn_redirect=1) API can be called to obtain the backup file name. BackupName *string `json:"BackupName,omitnil,omitempty" name:"BackupName"` // Specifies the task within the query time range, and StartTime specifies the start time. If not specified, there are no limitations on the start time by default. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Specifies the task within the query time range, and EndTime specifies the end time. If not specified, there are no limitations on the end time by default. EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // Number of entries returned for this query. Value range: 1–100. The default value is 20. Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Specifies the number of pages returned for this query. The default value is 0. Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Sorting field. // - createTime: sort by the creation time of the backup download task. The default value is createTime. // - finishTime: sort by the completion time of the backup download task. OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"` // Sorting method. // - asc: ascending order. // - desc: descending order. The default value is desc. OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"` // Specifies the task status for filtering download tasks. If this parameter is not configured, tasks of all status types will be returned. // - 0: wait for execution. // - 1: downloading. // - 2: download completed. // - 3: download failed. // - 4: wait for retry. Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"` }
Predefined struct for user
type DescribeBackupDownloadTaskResponse ¶
type DescribeBackupDownloadTaskResponse struct { *tchttp.BaseResponse Response *DescribeBackupDownloadTaskResponseParams `json:"Response"` }
func NewDescribeBackupDownloadTaskResponse ¶
func NewDescribeBackupDownloadTaskResponse() (response *DescribeBackupDownloadTaskResponse)
func (*DescribeBackupDownloadTaskResponse) FromJsonString ¶
func (r *DescribeBackupDownloadTaskResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeBackupDownloadTaskResponse) ToJsonString ¶
func (r *DescribeBackupDownloadTaskResponse) ToJsonString() string
type DescribeBackupDownloadTaskResponseParams ¶
type DescribeBackupDownloadTaskResponseParams struct { // All entries that meet the query conditions. TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"` // Download task list. Tasks []*BackupDownloadTask `json:"Tasks,omitnil,omitempty" name:"Tasks"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeClientConnectionsRequest ¶
type DescribeClientConnectionsRequest struct { *tchttp.BaseRequest // Specifies the ID of the instance to be queried. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Number of entries returned per request. Minimum value: 1. Maximum value: 1000. Default value: 1000. Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Offset. Default value: 0. Offset = Limit x (page number - 1). Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` }
func NewDescribeClientConnectionsRequest ¶
func NewDescribeClientConnectionsRequest() (request *DescribeClientConnectionsRequest)
func (*DescribeClientConnectionsRequest) FromJsonString ¶
func (r *DescribeClientConnectionsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeClientConnectionsRequest) ToJsonString ¶
func (r *DescribeClientConnectionsRequest) ToJsonString() string
type DescribeClientConnectionsRequestParams ¶
type DescribeClientConnectionsRequestParams struct { // Specifies the ID of the instance to be queried. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Number of entries returned per request. Minimum value: 1. Maximum value: 1000. Default value: 1000. Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Offset. Default value: 0. Offset = Limit x (page number - 1). Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` }
Predefined struct for user
type DescribeClientConnectionsResponse ¶
type DescribeClientConnectionsResponse struct { *tchttp.BaseResponse Response *DescribeClientConnectionsResponseParams `json:"Response"` }
func NewDescribeClientConnectionsResponse ¶
func NewDescribeClientConnectionsResponse() (response *DescribeClientConnectionsResponse)
func (*DescribeClientConnectionsResponse) FromJsonString ¶
func (r *DescribeClientConnectionsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeClientConnectionsResponse) ToJsonString ¶
func (r *DescribeClientConnectionsResponse) ToJsonString() string
type DescribeClientConnectionsResponseParams ¶
type DescribeClientConnectionsResponseParams struct { // Client connection information, including the numbers of connections of the client IP address and the database access IP address. Clients []*ClientConnection `json:"Clients,omitnil,omitempty" name:"Clients"` // The total number of records that meet the query condition, which can be used for paginated queries. TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeDBBackupsRequest ¶
type DescribeDBBackupsRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Backup method. // - 0: logical backup. // - 1: physical backup. // - 3: snapshot backup. // **Note**: // 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. // 2. Physical backup is not supported when storage encryption is enabled for the instance. BackupMethod *int64 `json:"BackupMethod,omitnil,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,omitnil,omitempty" name:"Limit"` // Pagination offset, starting from `0`. Default value: `0`. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` }
func NewDescribeDBBackupsRequest ¶
func NewDescribeDBBackupsRequest() (request *DescribeDBBackupsRequest)
func (*DescribeDBBackupsRequest) FromJsonString ¶
func (r *DescribeDBBackupsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDBBackupsRequest) ToJsonString ¶
func (r *DescribeDBBackupsRequest) ToJsonString() string
type DescribeDBBackupsRequestParams ¶
type DescribeDBBackupsRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Backup method. // - 0: logical backup. // - 1: physical backup. // - 3: snapshot backup. // **Note**: // 1. The General Edition instance supports logical and physical backup. The Cloud Disk Edition instance supports physical and snapshot backup, but does not support logical backup currently. // 2. Physical backup is not supported when storage encryption is enabled for the instance. BackupMethod *int64 `json:"BackupMethod,omitnil,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,omitnil,omitempty" name:"Limit"` // Pagination offset, starting from `0`. Default value: `0`. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` }
Predefined struct for user
type DescribeDBBackupsResponse ¶
type DescribeDBBackupsResponse struct { *tchttp.BaseResponse Response *DescribeDBBackupsResponseParams `json:"Response"` }
func NewDescribeDBBackupsResponse ¶
func NewDescribeDBBackupsResponse() (response *DescribeDBBackupsResponse)
func (*DescribeDBBackupsResponse) FromJsonString ¶
func (r *DescribeDBBackupsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDBBackupsResponse) ToJsonString ¶
func (r *DescribeDBBackupsResponse) ToJsonString() string
type DescribeDBBackupsResponseParams ¶
type DescribeDBBackupsResponseParams struct { // Backup list. BackupList []*BackupInfo `json:"BackupList,omitnil,omitempty" name:"BackupList"` // Number of backups. TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeDBInstanceDealRequest ¶
type DescribeDBInstanceDealRequest struct { *tchttp.BaseRequest // Order ID. // - Pay-as-you-go instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstanceHour](https://www.tencentcloud.comom/document/product/240/38570?from_cn_redirect=1) API. // - Yearly/monthly subscription instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstance](https://www.tencentcloud.comom/document/product/240/38571?from_cn_redirect=1) API. DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"` }
func NewDescribeDBInstanceDealRequest ¶
func NewDescribeDBInstanceDealRequest() (request *DescribeDBInstanceDealRequest)
func (*DescribeDBInstanceDealRequest) FromJsonString ¶
func (r *DescribeDBInstanceDealRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDBInstanceDealRequest) ToJsonString ¶
func (r *DescribeDBInstanceDealRequest) ToJsonString() string
type DescribeDBInstanceDealRequestParams ¶
type DescribeDBInstanceDealRequestParams struct { // Order ID. // - Pay-as-you-go instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstanceHour](https://www.tencentcloud.comom/document/product/240/38570?from_cn_redirect=1) API. // - Yearly/monthly subscription instance. It can be obtained through the output parameter **DealId** of the [CreateDBInstance](https://www.tencentcloud.comom/document/product/240/38571?from_cn_redirect=1) API. DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"` }
Predefined struct for user
type DescribeDBInstanceDealResponse ¶
type DescribeDBInstanceDealResponse struct { *tchttp.BaseResponse Response *DescribeDBInstanceDealResponseParams `json:"Response"` }
func NewDescribeDBInstanceDealResponse ¶
func NewDescribeDBInstanceDealResponse() (response *DescribeDBInstanceDealResponse)
func (*DescribeDBInstanceDealResponse) FromJsonString ¶
func (r *DescribeDBInstanceDealResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDBInstanceDealResponse) ToJsonString ¶
func (r *DescribeDBInstanceDealResponse) ToJsonString() string
type DescribeDBInstanceDealResponseParams ¶
type DescribeDBInstanceDealResponseParams struct { // Order status. // - 1: unpaid. // - 2: paid. // - 3: delivering. // - 4: delivered successfully. // - 5: delivery failed. // - 6: refund. // - 7: order closed. // - 8: closed due to unpaid timeout. Status *int64 `json:"Status,omitnil,omitempty" name:"Status"` // Original price of the order, in USD. OriginalPrice *float64 `json:"OriginalPrice,omitnil,omitempty" name:"OriginalPrice"` // Discount price of the order, in USD. DiscountPrice *float64 `json:"DiscountPrice,omitnil,omitempty" name:"DiscountPrice"` // Order operation behavior. // - purchase: newly purchased. // - renew: renewed. // - upgrade: configuration upgraded. // - downgrade: configuration downgraded. // - refund: return and refund. Action *string `json:"Action,omitnil,omitempty" name:"Action"` // Instance ID of the current order. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeDBInstanceNamespaceRequest ¶
type DescribeDBInstanceNamespaceRequest struct { *tchttp.BaseRequest // Specifies the instance ID for querying the database. Batch querying is supported. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the database name for querying. If this parameter is left blank, a list of all databases of the current instance is returned. DbName *string `json:"DbName,omitnil,omitempty" name:"DbName"` }
func NewDescribeDBInstanceNamespaceRequest ¶
func NewDescribeDBInstanceNamespaceRequest() (request *DescribeDBInstanceNamespaceRequest)
func (*DescribeDBInstanceNamespaceRequest) FromJsonString ¶
func (r *DescribeDBInstanceNamespaceRequest) 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 (*DescribeDBInstanceNamespaceRequest) ToJsonString ¶
func (r *DescribeDBInstanceNamespaceRequest) ToJsonString() string
type DescribeDBInstanceNamespaceRequestParams ¶
type DescribeDBInstanceNamespaceRequestParams struct { // Specifies the instance ID for querying the database. Batch querying is supported. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the database name for querying. If this parameter is left blank, a list of all databases of the current instance is returned. DbName *string `json:"DbName,omitnil,omitempty" name:"DbName"` }
Predefined struct for user
type DescribeDBInstanceNamespaceResponse ¶
type DescribeDBInstanceNamespaceResponse struct { *tchttp.BaseResponse Response *DescribeDBInstanceNamespaceResponseParams `json:"Response"` }
func NewDescribeDBInstanceNamespaceResponse ¶
func NewDescribeDBInstanceNamespaceResponse() (response *DescribeDBInstanceNamespaceResponse)
func (*DescribeDBInstanceNamespaceResponse) FromJsonString ¶
func (r *DescribeDBInstanceNamespaceResponse) 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 (*DescribeDBInstanceNamespaceResponse) ToJsonString ¶
func (r *DescribeDBInstanceNamespaceResponse) ToJsonString() string
type DescribeDBInstanceNamespaceResponseParams ¶
type DescribeDBInstanceNamespaceResponseParams struct { // List of databases of the queried instance. If no database is specified for querying with DbName, a list of databases of only the queried instance is returned instead of the information indicated by Collections. Databases []*string `json:"Databases,omitnil,omitempty" name:"Databases"` // Queried collection information. If DbName is specified, a list of collections of only this database is returned. Collections []*string `json:"Collections,omitnil,omitempty" name:"Collections"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeDBInstancesRequest ¶
type DescribeDBInstancesRequest struct { *tchttp.BaseRequest // Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // Specifies the instance type for querying. Valid values: // - 0: all instances. // - 1: formal instance. // - 2: temporary instance. // - 3: read-only instance. // - -1: the query range includes the formal, read-only, and disaster recovery instances simultaneously. InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"` // Specifies the cluster type of the instance to be queried. Valid values: // - 0: replica set instance. // - 1: sharded cluster instance. // - -1: replica set and sharded cluster instance. ClusterType *int64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // Specifies the current status of the instance to be queried. Valid values: // - 0: to be initialized. // - 1: processing, such as specification changes and parameter modifications. // - 2: running normally. // - -2: isolated (yearly/monthly subscription). // - -3: isolated (pay-as-you-go). Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"` // VPC ID. // - You do not need to specify this parameter for basic networks. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page. VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // VPC subnet ID. // - You do not need to specify this parameter for basic networks. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page. SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Billing type. Valid value: 0 (pay-as-you-go) PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"` // Number of entries returned per request. The default value is 20, and the value range is (1, 100]. Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Offset. Default value: `0`. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting. OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"` // Configures the method for sorting returned results. // - ASC: ascending order. // - DESC: descending order. OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"` // Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects. ProjectIds []*uint64 `json:"ProjectIds,omitnil,omitempty" name:"ProjectIds"` // Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported. SearchKey *string `json:"SearchKey,omitnil,omitempty" name:"SearchKey"` // Tag information, including the tag key and tag value. Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` }
func NewDescribeDBInstancesRequest ¶
func NewDescribeDBInstancesRequest() (request *DescribeDBInstancesRequest)
func (*DescribeDBInstancesRequest) FromJsonString ¶
func (r *DescribeDBInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDBInstancesRequest) ToJsonString ¶
func (r *DescribeDBInstancesRequest) ToJsonString() string
type DescribeDBInstancesRequestParams ¶
type DescribeDBInstancesRequestParams struct { // Instance ID list. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // Specifies the instance type for querying. Valid values: // - 0: all instances. // - 1: formal instance. // - 2: temporary instance. // - 3: read-only instance. // - -1: the query range includes the formal, read-only, and disaster recovery instances simultaneously. InstanceType *int64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"` // Specifies the cluster type of the instance to be queried. Valid values: // - 0: replica set instance. // - 1: sharded cluster instance. // - -1: replica set and sharded cluster instance. ClusterType *int64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // Specifies the current status of the instance to be queried. Valid values: // - 0: to be initialized. // - 1: processing, such as specification changes and parameter modifications. // - 2: running normally. // - -2: isolated (yearly/monthly subscription). // - -3: isolated (pay-as-you-go). Status []*int64 `json:"Status,omitnil,omitempty" name:"Status"` // VPC ID. // - You do not need to specify this parameter for basic networks. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the ID on the **VPC** page. VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // VPC subnet ID. // - You do not need to specify this parameter for basic networks. // - Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB), click a VPC name in the instance list, and obtain the subnet ID on the **VPC** page. SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Billing type. Valid value: 0 (pay-as-you-go) PayMode *int64 `json:"PayMode,omitnil,omitempty" name:"PayMode"` // Number of entries returned per request. The default value is 20, and the value range is (1, 100]. Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Offset. Default value: `0`. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Configures the field for sorting returned results. Currently, "ProjectId", "InstanceName", and "CreateTime" are supported for sorting. OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"` // Configures the method for sorting returned results. // - ASC: ascending order. // - DESC: descending order. OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"` // Project ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and select Project Management in the account information drop-down menu at the top right corner to query projects. ProjectIds []*uint64 `json:"ProjectIds,omitnil,omitempty" name:"ProjectIds"` // Specifies the keyword for search. Specific instance IDs, instance names, or private IP addresses are supported. SearchKey *string `json:"SearchKey,omitnil,omitempty" name:"SearchKey"` // Tag information, including the tag key and tag value. Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` }
Predefined struct for user
type DescribeDBInstancesResponse ¶
type DescribeDBInstancesResponse struct { *tchttp.BaseResponse Response *DescribeDBInstancesResponseParams `json:"Response"` }
func NewDescribeDBInstancesResponse ¶
func NewDescribeDBInstancesResponse() (response *DescribeDBInstancesResponse)
func (*DescribeDBInstancesResponse) FromJsonString ¶
func (r *DescribeDBInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeDBInstancesResponse) ToJsonString ¶
func (r *DescribeDBInstancesResponse) ToJsonString() string
type DescribeDBInstancesResponseParams ¶
type DescribeDBInstancesResponseParams struct { // Number of eligible instances TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"` // List of instance details InstanceDetails []*InstanceDetail `json:"InstanceDetails,omitnil,omitempty" name:"InstanceDetails"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeDetailedSlowLogsRequest ¶
type DescribeDetailedSlowLogsRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the start time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Specifies the end time for querying slow logs. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // Specifies the threshold for querying slow logs, in milliseconds. It indicates that the execution time of the slow log query exceeds this value. The default value is 100. ExecTime *int64 `json:"ExecTime,omitnil,omitempty" name:"ExecTime"` // Specifies the command type for querying slow logs. Commands []*string `json:"Commands,omitnil,omitempty" name:"Commands"` // Full-text search keyword. The logical operator among multiple keywords is OR. Texts []*string `json:"Texts,omitnil,omitempty" name:"Texts"` // Specifies the node name for querying slow logs. The [DescribeDBInstanceNodeProperty](https://www.tencentcloud.comom/document/product/240/82022?from_cn_redirect=1) API can be called to query the node name. NodeNames []*string `json:"NodeNames,omitnil,omitempty" name:"NodeNames"` // Specifies the queryHash value to be queried. QueryHash []*string `json:"QueryHash,omitnil,omitempty" name:"QueryHash"` // Pagination offset. The default value is 0, and the value range is [0, 100]. Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Number of returned entries. The default value is 20, and the value range is [0, 10000]. Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Specifies the sorting condition for slow logs. // - StartTime: sort by the generation time of slow logs. // - ExecTime: sort by the execution time of slow logs. OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"` // Specifies the sorting method. // - desc: descending order. // - asc: ascending order. OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"` }
func NewDescribeDetailedSlowLogsRequest ¶
func NewDescribeDetailedSlowLogsRequest() (request *DescribeDetailedSlowLogsRequest)
func (*DescribeDetailedSlowLogsRequest) FromJsonString ¶
func (r *DescribeDetailedSlowLogsRequest) 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 (*DescribeDetailedSlowLogsRequest) ToJsonString ¶
func (r *DescribeDetailedSlowLogsRequest) ToJsonString() string
type DescribeDetailedSlowLogsRequestParams ¶
type DescribeDetailedSlowLogsRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the start time for querying slow logs. - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Specifies the end time for querying slow logs. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"` // Specifies the threshold for querying slow logs, in milliseconds. It indicates that the execution time of the slow log query exceeds this value. The default value is 100. ExecTime *int64 `json:"ExecTime,omitnil,omitempty" name:"ExecTime"` // Specifies the command type for querying slow logs. Commands []*string `json:"Commands,omitnil,omitempty" name:"Commands"` // Full-text search keyword. The logical operator among multiple keywords is OR. Texts []*string `json:"Texts,omitnil,omitempty" name:"Texts"` // Specifies the node name for querying slow logs. The [DescribeDBInstanceNodeProperty](https://www.tencentcloud.comom/document/product/240/82022?from_cn_redirect=1) API can be called to query the node name. NodeNames []*string `json:"NodeNames,omitnil,omitempty" name:"NodeNames"` // Specifies the queryHash value to be queried. QueryHash []*string `json:"QueryHash,omitnil,omitempty" name:"QueryHash"` // Pagination offset. The default value is 0, and the value range is [0, 100]. Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Number of returned entries. The default value is 20, and the value range is [0, 10000]. Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Specifies the sorting condition for slow logs. // - StartTime: sort by the generation time of slow logs. // - ExecTime: sort by the execution time of slow logs. OrderBy *string `json:"OrderBy,omitnil,omitempty" name:"OrderBy"` // Specifies the sorting method. // - desc: descending order. // - asc: ascending order. OrderByType *string `json:"OrderByType,omitnil,omitempty" name:"OrderByType"` }
Predefined struct for user
type DescribeDetailedSlowLogsResponse ¶
type DescribeDetailedSlowLogsResponse struct { *tchttp.BaseResponse Response *DescribeDetailedSlowLogsResponseParams `json:"Response"` }
func NewDescribeDetailedSlowLogsResponse ¶
func NewDescribeDetailedSlowLogsResponse() (response *DescribeDetailedSlowLogsResponse)
func (*DescribeDetailedSlowLogsResponse) FromJsonString ¶
func (r *DescribeDetailedSlowLogsResponse) 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 (*DescribeDetailedSlowLogsResponse) ToJsonString ¶
func (r *DescribeDetailedSlowLogsResponse) ToJsonString() string
type DescribeDetailedSlowLogsResponseParams ¶
type DescribeDetailedSlowLogsResponseParams struct { // Number of slow logs that meet the conditions. TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"` // Slow log details. DetailedSlowLogs []*SlowLogItem `json:"DetailedSlowLogs,omitnil,omitempty" name:"DetailedSlowLogs"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeInstanceParamsRequest ¶
type DescribeInstanceParamsRequest struct { *tchttp.BaseRequest // Specifies the instance ID for querying the parameter list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,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 DescribeInstanceParamsRequestParams ¶
type DescribeInstanceParamsRequestParams struct { // Specifies the instance ID for querying the parameter list. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
Predefined struct for user
type DescribeInstanceParamsResponse ¶
type DescribeInstanceParamsResponse struct { *tchttp.BaseResponse Response *DescribeInstanceParamsResponseParams `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 DescribeInstanceParamsResponseParams ¶
type DescribeInstanceParamsResponseParams struct { // Collection of parameters whose values are of the Enum type. InstanceEnumParam []*InstanceEnumParam `json:"InstanceEnumParam,omitnil,omitempty" name:"InstanceEnumParam"` // Collection of parameters whose values are of the Integer type. InstanceIntegerParam []*InstanceIntegerParam `json:"InstanceIntegerParam,omitnil,omitempty" name:"InstanceIntegerParam"` // Collection of parameters whose values are of the Text type. InstanceTextParam []*InstanceTextParam `json:"InstanceTextParam,omitnil,omitempty" name:"InstanceTextParam"` // Collection of parameters whose values are of different types. InstanceMultiParam []*InstanceMultiParam `json:"InstanceMultiParam,omitnil,omitempty" name:"InstanceMultiParam"` // Number of modifiable parameters supported by the current instance. TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeSecurityGroupRequest ¶
type DescribeSecurityGroupRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
func NewDescribeSecurityGroupRequest ¶
func NewDescribeSecurityGroupRequest() (request *DescribeSecurityGroupRequest)
func (*DescribeSecurityGroupRequest) FromJsonString ¶
func (r *DescribeSecurityGroupRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSecurityGroupRequest) ToJsonString ¶
func (r *DescribeSecurityGroupRequest) ToJsonString() string
type DescribeSecurityGroupRequestParams ¶
type DescribeSecurityGroupRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
Predefined struct for user
type DescribeSecurityGroupResponse ¶
type DescribeSecurityGroupResponse struct { *tchttp.BaseResponse Response *DescribeSecurityGroupResponseParams `json:"Response"` }
func NewDescribeSecurityGroupResponse ¶
func NewDescribeSecurityGroupResponse() (response *DescribeSecurityGroupResponse)
func (*DescribeSecurityGroupResponse) FromJsonString ¶
func (r *DescribeSecurityGroupResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSecurityGroupResponse) ToJsonString ¶
func (r *DescribeSecurityGroupResponse) ToJsonString() string
type DescribeSecurityGroupResponseParams ¶
type DescribeSecurityGroupResponseParams struct { // Information on security groups bound to the instance. Groups []*SecurityGroup `json:"Groups,omitnil,omitempty" name:"Groups"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeSlowLogPatternsRequest ¶
type DescribeSlowLogPatternsRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Slow log start time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Slow log end time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. EndTime *string `json:"EndTime,omitnil,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,omitnil,omitempty" name:"SlowMS"` // Offset. Minimum value: 0. Maximum value: 10000. Default value: 0. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20. Limit *uint64 `json:"Limit,omitnil,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,omitnil,omitempty" name:"Format"` }
func NewDescribeSlowLogPatternsRequest ¶
func NewDescribeSlowLogPatternsRequest() (request *DescribeSlowLogPatternsRequest)
func (*DescribeSlowLogPatternsRequest) FromJsonString ¶
func (r *DescribeSlowLogPatternsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSlowLogPatternsRequest) ToJsonString ¶
func (r *DescribeSlowLogPatternsRequest) ToJsonString() string
type DescribeSlowLogPatternsRequestParams ¶
type DescribeSlowLogPatternsRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Slow log start time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Slow log end time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. EndTime *string `json:"EndTime,omitnil,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,omitnil,omitempty" name:"SlowMS"` // Offset. Minimum value: 0. Maximum value: 10000. Default value: 0. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20. Limit *uint64 `json:"Limit,omitnil,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,omitnil,omitempty" name:"Format"` }
Predefined struct for user
type DescribeSlowLogPatternsResponse ¶
type DescribeSlowLogPatternsResponse struct { *tchttp.BaseResponse Response *DescribeSlowLogPatternsResponseParams `json:"Response"` }
func NewDescribeSlowLogPatternsResponse ¶
func NewDescribeSlowLogPatternsResponse() (response *DescribeSlowLogPatternsResponse)
func (*DescribeSlowLogPatternsResponse) FromJsonString ¶
func (r *DescribeSlowLogPatternsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSlowLogPatternsResponse) ToJsonString ¶
func (r *DescribeSlowLogPatternsResponse) ToJsonString() string
type DescribeSlowLogPatternsResponseParams ¶
type DescribeSlowLogPatternsResponseParams struct { // Total number of slow logs Count *uint64 `json:"Count,omitnil,omitempty" name:"Count"` // Slow log statistics SlowLogPatterns []*SlowLogPattern `json:"SlowLogPatterns,omitnil,omitempty" name:"SlowLogPatterns"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeSlowLogsRequest ¶
type DescribeSlowLogsRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Slow log start time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Slow log end time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. EndTime *string `json:"EndTime,omitnil,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,omitnil,omitempty" name:"SlowMS"` // Offset. Minimum value: 0. Maximum value: 10000. Default value: 0. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20. Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Return format of slow log. The original slow log format is returned by default, and the format can be set to JSON on versions 4.4 and later. Format *string `json:"Format,omitnil,omitempty" name:"Format"` }
func NewDescribeSlowLogsRequest ¶
func NewDescribeSlowLogsRequest() (request *DescribeSlowLogsRequest)
func (*DescribeSlowLogsRequest) FromJsonString ¶
func (r *DescribeSlowLogsRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSlowLogsRequest) ToJsonString ¶
func (r *DescribeSlowLogsRequest) ToJsonString() string
type DescribeSlowLogsRequestParams ¶
type DescribeSlowLogsRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Slow log start time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-01 10:00:00. // - The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"` // Slow log end time. // - Format: yyyy-mm-dd hh:mm:ss. For example, 2019-06-02 12:00:00.- The query start and end time interval cannot exceed 24 hours. Only slow logs within the last 7 days can be queried. EndTime *string `json:"EndTime,omitnil,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,omitnil,omitempty" name:"SlowMS"` // Offset. Minimum value: 0. Maximum value: 10000. Default value: 0. Offset *uint64 `json:"Offset,omitnil,omitempty" name:"Offset"` // Number of entries per page. Minimum value: 1. Maximum value: 100. Default value: 20. Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"` // Return format of slow log. The original slow log format is returned by default, and the format can be set to JSON on versions 4.4 and later. Format *string `json:"Format,omitnil,omitempty" name:"Format"` }
Predefined struct for user
type DescribeSlowLogsResponse ¶
type DescribeSlowLogsResponse struct { *tchttp.BaseResponse Response *DescribeSlowLogsResponseParams `json:"Response"` }
func NewDescribeSlowLogsResponse ¶
func NewDescribeSlowLogsResponse() (response *DescribeSlowLogsResponse)
func (*DescribeSlowLogsResponse) FromJsonString ¶
func (r *DescribeSlowLogsResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSlowLogsResponse) ToJsonString ¶
func (r *DescribeSlowLogsResponse) ToJsonString() string
type DescribeSlowLogsResponseParams ¶
type DescribeSlowLogsResponseParams struct { // Total number of slow logs. Count *uint64 `json:"Count,omitnil,omitempty" name:"Count"` // Slow log details. SlowLogs []*string `json:"SlowLogs,omitnil,omitempty" name:"SlowLogs"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type DescribeSpecInfoRequest ¶
type DescribeSpecInfoRequest struct { *tchttp.BaseRequest // AZ to be queried. For currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1). Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` }
func NewDescribeSpecInfoRequest ¶
func NewDescribeSpecInfoRequest() (request *DescribeSpecInfoRequest)
func (*DescribeSpecInfoRequest) FromJsonString ¶
func (r *DescribeSpecInfoRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSpecInfoRequest) ToJsonString ¶
func (r *DescribeSpecInfoRequest) ToJsonString() string
type DescribeSpecInfoRequestParams ¶
type DescribeSpecInfoRequestParams struct { // AZ to be queried. For currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1). Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` }
Predefined struct for user
type DescribeSpecInfoResponse ¶
type DescribeSpecInfoResponse struct { *tchttp.BaseResponse Response *DescribeSpecInfoResponseParams `json:"Response"` }
func NewDescribeSpecInfoResponse ¶
func NewDescribeSpecInfoResponse() (response *DescribeSpecInfoResponse)
func (*DescribeSpecInfoResponse) FromJsonString ¶
func (r *DescribeSpecInfoResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*DescribeSpecInfoResponse) ToJsonString ¶
func (r *DescribeSpecInfoResponse) ToJsonString() string
type DescribeSpecInfoResponseParams ¶
type DescribeSpecInfoResponseParams struct { // List of sales specification information on the instance. SpecInfoList []*SpecificationInfo `json:"SpecInfoList,omitnil,omitempty" name:"SpecInfoList"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type FlushInstanceRouterConfigRequest ¶
type FlushInstanceRouterConfigRequest struct { *tchttp.BaseRequest // Instance ID InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
func NewFlushInstanceRouterConfigRequest ¶
func NewFlushInstanceRouterConfigRequest() (request *FlushInstanceRouterConfigRequest)
func (*FlushInstanceRouterConfigRequest) FromJsonString ¶
func (r *FlushInstanceRouterConfigRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*FlushInstanceRouterConfigRequest) ToJsonString ¶
func (r *FlushInstanceRouterConfigRequest) ToJsonString() string
type FlushInstanceRouterConfigRequestParams ¶
type FlushInstanceRouterConfigRequestParams struct { // Instance ID InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
Predefined struct for user
type FlushInstanceRouterConfigResponse ¶
type FlushInstanceRouterConfigResponse struct { *tchttp.BaseResponse Response *FlushInstanceRouterConfigResponseParams `json:"Response"` }
func NewFlushInstanceRouterConfigResponse ¶
func NewFlushInstanceRouterConfigResponse() (response *FlushInstanceRouterConfigResponse)
func (*FlushInstanceRouterConfigResponse) FromJsonString ¶
func (r *FlushInstanceRouterConfigResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*FlushInstanceRouterConfigResponse) ToJsonString ¶
func (r *FlushInstanceRouterConfigResponse) ToJsonString() string
type FlushInstanceRouterConfigResponseParams ¶
type FlushInstanceRouterConfigResponseParams struct { // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type InquirePriceCreateDBInstancesRequest ¶
type InquirePriceCreateDBInstancesRequest struct { *tchttp.BaseRequest // Region and AZ information of the instance. For details, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1). Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` // -Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set. // - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard. NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Instance memory size. // // - Unit: GB. // - For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The CPU and Memory parameters in the returned data structure SpecItems correspond to the number of CPU cores and the memory specification, respectively. Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size. // - Unit: GB. // - For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The MinStorage and MaxStorage parameters in the returned data structure SpecItems correspond to the minimum and maximum disk specifications, respectively. Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Instance version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain specific supported versions. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported by instances. The corresponding relationship between version information and version number is as follows: // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Product specification type. // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk. MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"` // Number of instances. Minimum value: 1. Maximum value: 10. GoodsNum *int64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"` // Instance type. // // - REPLSET: replica set. // - SHARD: sharded cluster. ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1. // - Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively. ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // - When the monthly subscription mode is selected, that is, when <b>InstanceChargeType</b> is set to <b>PREPAID</b>, this parameter is required for specifying the purchase duration of instances. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Unit: months. // - When pay-as-you-go is selected, that is, when <b>InstanceChargeType</b> is set to **POSTPAID_BY_HOUR**, this parameter only can be set to 1. Period *int64 `json:"Period,omitnil,omitempty" name:"Period"` // Instance payment method. // - PREPAID: monthly subscription. // - POSTPAID_BY_HOUR: pay-as-you-go. InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"` // Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. If this parameter is left blank, the default value 2 is used. MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"` // Mongos node memory size. - This parameter is required during sharded cluster instance purchase. - Unit: GB. Valid values: 2 (for 1 core), 4 (for 2 cores), 8 (for 4 cores), 16 (for 8 cores), and 32 (for 16 cores). If this parameter is left blank, the default value 4 is used. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Specifies the number of Mongos nodes. Value range: [3,32]. For querying the price of sharded cluster instances, this parameter is required. If it is left blank, the default value 3 is used. MongosNum *uint64 `json:"MongosNum,omitnil,omitempty" name:"MongosNum"` // Specifies the number of ConfigServer CPU cores. The value is fixed as 1. ConfigServerCpu *uint64 `json:"ConfigServerCpu,omitnil,omitempty" name:"ConfigServerCpu"` // Specifies the ConfigServer memory size. The value is fixed as 2. Unit: GB. This parameter can be left blank. ConfigServerMemory *uint64 `json:"ConfigServerMemory,omitnil,omitempty" name:"ConfigServerMemory"` // Specifies the ConfigServer disk size. The value is fixed as 20. Unit: GB. This parameter can be left blank. ConfigServerVolume *uint64 `json:"ConfigServerVolume,omitnil,omitempty" name:"ConfigServerVolume"` }
func NewInquirePriceCreateDBInstancesRequest ¶
func NewInquirePriceCreateDBInstancesRequest() (request *InquirePriceCreateDBInstancesRequest)
func (*InquirePriceCreateDBInstancesRequest) FromJsonString ¶
func (r *InquirePriceCreateDBInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*InquirePriceCreateDBInstancesRequest) ToJsonString ¶
func (r *InquirePriceCreateDBInstancesRequest) ToJsonString() string
type InquirePriceCreateDBInstancesRequestParams ¶
type InquirePriceCreateDBInstancesRequestParams struct { // Region and AZ information of the instance. For details, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1). Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` // -Specifies the number of primary and secondary nodes for each replica set during replica set instance creation. call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each replica set. // - Specifies the number of primary and secondary nodes for each shard during sharded cluster instance creation. Call the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API to obtain the maximum and minimum number of nodes supported for each shard. NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Instance memory size. // // - Unit: GB. // - For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The CPU and Memory parameters in the returned data structure SpecItems correspond to the number of CPU cores and the memory specification, respectively. Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size. // - Unit: GB. // - For the value range, call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API. The MinStorage and MaxStorage parameters in the returned data structure SpecItems correspond to the minimum and maximum disk specifications, respectively. Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Instance version information. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain specific supported versions. The MongoVersionCode parameter in the returned data structure SpecItems indicates the information on versions supported by instances. The corresponding relationship between version information and version number is as follows: // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Product specification type. // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk. MachineCode *string `json:"MachineCode,omitnil,omitempty" name:"MachineCode"` // Number of instances. Minimum value: 1. Maximum value: 10. GoodsNum *int64 `json:"GoodsNum,omitnil,omitempty" name:"GoodsNum"` // Instance type. // // - REPLSET: replica set. // - SHARD: sharded cluster. ClusterType *string `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // - Specifies the number of replica sets during replica set instance creation. This parameter can only be set to 1. // - Specifies the number of shards during sharded cluster instance creation. Call the [DescribeSpecInfo](https://intl.cloud.tencent.com/document/product/240/38567?from_cn_redirect=1) API to query the range of shard quantity. The parameters MinReplicateSetNum and MaxReplicateSetNum in the returned data structure SpecItems correspond to the minimum value and maximum value, respectively. ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // - When the monthly subscription mode is selected, that is, when <b>InstanceChargeType</b> is set to <b>PREPAID</b>, this parameter is required for specifying the purchase duration of instances. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Unit: months. // - When pay-as-you-go is selected, that is, when <b>InstanceChargeType</b> is set to **POSTPAID_BY_HOUR**, this parameter only can be set to 1. Period *int64 `json:"Period,omitnil,omitempty" name:"Period"` // Instance payment method. // - PREPAID: monthly subscription. // - POSTPAID_BY_HOUR: pay-as-you-go. InstanceChargeType *string `json:"InstanceChargeType,omitnil,omitempty" name:"InstanceChargeType"` // Number of Mongos node CPU cores. Valid values: 1, 2, 4, 8, and 16. This parameter is required during sharded cluster instance purchase. If this parameter is left blank, the default value 2 is used. MongosCpu *uint64 `json:"MongosCpu,omitnil,omitempty" name:"MongosCpu"` // Mongos node memory size. - This parameter is required during sharded cluster instance purchase. - Unit: GB. Valid values: 2 (for 1 core), 4 (for 2 cores), 8 (for 4 cores), 16 (for 8 cores), and 32 (for 16 cores). If this parameter is left blank, the default value 4 is used. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Specifies the number of Mongos nodes. Value range: [3,32]. For querying the price of sharded cluster instances, this parameter is required. If it is left blank, the default value 3 is used. MongosNum *uint64 `json:"MongosNum,omitnil,omitempty" name:"MongosNum"` // Specifies the number of ConfigServer CPU cores. The value is fixed as 1. ConfigServerCpu *uint64 `json:"ConfigServerCpu,omitnil,omitempty" name:"ConfigServerCpu"` // Specifies the ConfigServer memory size. The value is fixed as 2. Unit: GB. This parameter can be left blank. ConfigServerMemory *uint64 `json:"ConfigServerMemory,omitnil,omitempty" name:"ConfigServerMemory"` // Specifies the ConfigServer disk size. The value is fixed as 20. Unit: GB. This parameter can be left blank. ConfigServerVolume *uint64 `json:"ConfigServerVolume,omitnil,omitempty" name:"ConfigServerVolume"` }
Predefined struct for user
type InquirePriceCreateDBInstancesResponse ¶
type InquirePriceCreateDBInstancesResponse struct { *tchttp.BaseResponse Response *InquirePriceCreateDBInstancesResponseParams `json:"Response"` }
func NewInquirePriceCreateDBInstancesResponse ¶
func NewInquirePriceCreateDBInstancesResponse() (response *InquirePriceCreateDBInstancesResponse)
func (*InquirePriceCreateDBInstancesResponse) FromJsonString ¶
func (r *InquirePriceCreateDBInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*InquirePriceCreateDBInstancesResponse) ToJsonString ¶
func (r *InquirePriceCreateDBInstancesResponse) ToJsonString() string
type InquirePriceCreateDBInstancesResponseParams ¶
type InquirePriceCreateDBInstancesResponseParams struct { // Price. Price *DBInstancePrice `json:"Price,omitnil,omitempty" name:"Price"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type InquirePriceModifyDBInstanceSpecRequest ¶
type InquirePriceModifyDBInstanceSpecRequest struct { *tchttp.BaseRequest // Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Instance memory size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the specific sales specifications for memory. Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the maximum and minimum disk sizes corresponding to each CPU specification. Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Number of instance nodes. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the number of instance nodes. // - Replica set instance, which refers to the number of primary and secondary nodes for the instance after configuration changes. // - Sharded cluster instance, which refers to the number of primary and secondary nodes per shard for the instance after configuration changes. // **Note**: Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously. NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Sharded cluster instance, which refers to the number of shards for the instance after configuration changes. Value range: [2, 36]. // **Note**: The number of shards after changes cannot be less than the current number. Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously. ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,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 InquirePriceModifyDBInstanceSpecRequestParams ¶
type InquirePriceModifyDBInstanceSpecRequestParams struct { // Instance ID. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Instance memory size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the specific sales specifications for memory. Memory *int64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk size after configuration changes, in GB. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the maximum and minimum disk sizes corresponding to each CPU specification. Volume *int64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Number of instance nodes. The [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API can be called to obtain the number of instance nodes. // - Replica set instance, which refers to the number of primary and secondary nodes for the instance after configuration changes. // - Sharded cluster instance, which refers to the number of primary and secondary nodes per shard for the instance after configuration changes. // **Note**: Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously. NodeNum *int64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Sharded cluster instance, which refers to the number of shards for the instance after configuration changes. Value range: [2, 36]. // **Note**: The number of shards after changes cannot be less than the current number. Do not initiate tasks of adjusting the number of nodes and shards and the node specifications simultaneously. ReplicateSetNum *int64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` }
Predefined struct for user
type InquirePriceModifyDBInstanceSpecResponse ¶
type InquirePriceModifyDBInstanceSpecResponse struct { *tchttp.BaseResponse Response *InquirePriceModifyDBInstanceSpecResponseParams `json:"Response"` }
func NewInquirePriceModifyDBInstanceSpecResponse ¶
func NewInquirePriceModifyDBInstanceSpecResponse() (response *InquirePriceModifyDBInstanceSpecResponse)
func (*InquirePriceModifyDBInstanceSpecResponse) FromJsonString ¶
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 InquirePriceModifyDBInstanceSpecResponseParams ¶
type InquirePriceModifyDBInstanceSpecResponseParams struct { // Price. Price *DBInstancePrice `json:"Price,omitnil,omitempty" name:"Price"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type InquirePriceRenewDBInstancesRequest ¶
type InquirePriceRenewDBInstancesRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. Up to 5 instances can be queried at a time. InstanceIds []*string `json:"InstanceIds,omitnil,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,omitnil,omitempty" name:"InstanceChargePrepaid"` }
func NewInquirePriceRenewDBInstancesRequest ¶
func NewInquirePriceRenewDBInstancesRequest() (request *InquirePriceRenewDBInstancesRequest)
func (*InquirePriceRenewDBInstancesRequest) FromJsonString ¶
func (r *InquirePriceRenewDBInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*InquirePriceRenewDBInstancesRequest) ToJsonString ¶
func (r *InquirePriceRenewDBInstancesRequest) ToJsonString() string
type InquirePriceRenewDBInstancesRequestParams ¶
type InquirePriceRenewDBInstancesRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. Up to 5 instances can be queried at a time. InstanceIds []*string `json:"InstanceIds,omitnil,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,omitnil,omitempty" name:"InstanceChargePrepaid"` }
Predefined struct for user
type InquirePriceRenewDBInstancesResponse ¶
type InquirePriceRenewDBInstancesResponse struct { *tchttp.BaseResponse Response *InquirePriceRenewDBInstancesResponseParams `json:"Response"` }
func NewInquirePriceRenewDBInstancesResponse ¶
func NewInquirePriceRenewDBInstancesResponse() (response *InquirePriceRenewDBInstancesResponse)
func (*InquirePriceRenewDBInstancesResponse) FromJsonString ¶
func (r *InquirePriceRenewDBInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*InquirePriceRenewDBInstancesResponse) ToJsonString ¶
func (r *InquirePriceRenewDBInstancesResponse) ToJsonString() string
type InquirePriceRenewDBInstancesResponseParams ¶
type InquirePriceRenewDBInstancesResponseParams struct { // Price. Price *DBInstancePrice `json:"Price,omitnil,omitempty" name:"Price"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type InstanceChargePrepaid ¶
type InstanceChargePrepaid struct { // Instance purchase duration. Unit: months. Valid values: 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 24, and 36. Default value: 1. Period *int64 `json:"Period,omitnil,omitempty" name:"Period"` // Automatic renewal flag. Valid values: // - NOTIFY_AND_AUTO_RENEW: A notification is sent upon expiration, and the instance is renewed automatically. If the account balance is sufficient, the instance will be renewed automatically on a monthly basis after expiration. // - NOTIFY_AND_MANUAL_RENEW: A notification is sent upon expiration, but the instance is not renewed automatically. Default value: NOTIFY_AND_MANUAL_RENEW. // - DISABLE_NOTIFY_AND_MANUAL_RENEW: No notification is sent upon expiration, and the instance is not renewed automatically. RenewFlag *string `json:"RenewFlag,omitnil,omitempty" name:"RenewFlag"` }
type InstanceDetail ¶
type InstanceDetail struct { // Instance ID. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Instance name InstanceName *string `json:"InstanceName,omitnil,omitempty" name:"InstanceName"` // Billing type. Valid value: 0 (pay-as-you-go) PayMode *uint64 `json:"PayMode,omitnil,omitempty" name:"PayMode"` // Project ID. ProjectId *uint64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` // Cluster type. // - 0: replica set instance. // - 1: sharded cluster instance. ClusterType *uint64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // Region information Region *string `json:"Region,omitnil,omitempty" name:"Region"` // AZ information Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` // Network type. // - 0: basic network. // - 1: VPC. NetType *uint64 `json:"NetType,omitnil,omitempty" name:"NetType"` // VPC ID VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"` // Subnet ID of VPC SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"` // Instance status. // - 0: to be initialized. // - 1: processing, such as specification changes and parameter modifications. // - 2: running normally. // - -2: isolated (yearly/monthly subscription). // - -3: isolated (pay-as-you-go). Status *int64 `json:"Status,omitnil,omitempty" name:"Status"` // Instance IP Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"` // Port number Vport *uint64 `json:"Vport,omitnil,omitempty" name:"Vport"` // Instance creation time CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"` // Instance expiration time DeadLine *string `json:"DeadLine,omitnil,omitempty" name:"DeadLine"` // Storage engine version information on instances. // - MONGO_36_WT: version of the MongoDB 3.6 WiredTiger storage engine. // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersion *string `json:"MongoVersion,omitnil,omitempty" name:"MongoVersion"` // Instance memory specification, in MB. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Instance disk specification, in MB. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Number of the instance CPU cores. CpuNum *uint64 `json:"CpuNum,omitnil,omitempty" name:"CpuNum"` // Instance machine type. // - HIO10G: general HIO 10GE type. // - HCD: Cloud Disk Edition type. MachineType *string `json:"MachineType,omitnil,omitempty" name:"MachineType"` // Number of secondary nodes of an instance SecondaryNum *uint64 `json:"SecondaryNum,omitnil,omitempty" name:"SecondaryNum"` // Number of instance shards ReplicationSetNum *uint64 `json:"ReplicationSetNum,omitnil,omitempty" name:"ReplicationSetNum"` // Automatic renewal flag for the instance. // - 0: manual renewal. // - 1: automatic renewal. // - 2: no renewal after confirmation. AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"` // Used capacity, in MB. UsedVolume *uint64 `json:"UsedVolume,omitnil,omitempty" name:"UsedVolume"` // Start time of the maintenance time MaintenanceStart *string `json:"MaintenanceStart,omitnil,omitempty" name:"MaintenanceStart"` // End time of the maintenance time MaintenanceEnd *string `json:"MaintenanceEnd,omitnil,omitempty" name:"MaintenanceEnd"` // Shard information ReplicaSets []*ShardInfo `json:"ReplicaSets,omitnil,omitempty" name:"ReplicaSets"` // Information of read-only instances ReadonlyInstances []*DBInstanceInfo `json:"ReadonlyInstances,omitnil,omitempty" name:"ReadonlyInstances"` // Information of disaster recovery instances StandbyInstances []*DBInstanceInfo `json:"StandbyInstances,omitnil,omitempty" name:"StandbyInstances"` // Information of temp instances CloneInstances []*DBInstanceInfo `json:"CloneInstances,omitnil,omitempty" name:"CloneInstances"` // Information of associated instances. For a regular instance, this field represents the information of its temp instance; for a temp instance, this field represents the information of its regular instance; and for a read-only instance or a disaster recovery instance, this field represents the information of its primary instance. RelatedInstance *DBInstanceInfo `json:"RelatedInstance,omitnil,omitempty" name:"RelatedInstance"` // Instance tag information set Tags []*TagInfo `json:"Tags,omitnil,omitempty" name:"Tags"` // Instance version InstanceVer *uint64 `json:"InstanceVer,omitnil,omitempty" name:"InstanceVer"` // Instance version ClusterVer *uint64 `json:"ClusterVer,omitnil,omitempty" name:"ClusterVer"` // Protocol information: mongodb. Protocol *uint64 `json:"Protocol,omitnil,omitempty" name:"Protocol"` // Instance type. // - 0: all instances. // - 1: formal instance. // - 2: temporary instance. // - 3: read-only instance. // - -1: include the formal, read-only, and disaster recovery instance simultaneously. InstanceType *uint64 `json:"InstanceType,omitnil,omitempty" name:"InstanceType"` // Instance status description. InstanceStatusDesc *string `json:"InstanceStatusDesc,omitnil,omitempty" name:"InstanceStatusDesc"` // Physical instance ID corresponding to the instance. The instances that have been rolled back and replaced have different InstanceIds and RealInstanceIds, which need to be obtained through the physical ID in scenarios such as obtaining monitoring data from Barad. RealInstanceId *string `json:"RealInstanceId,omitnil,omitempty" name:"RealInstanceId"` // Number of Mongos nodes. MongosNodeNum *uint64 `json:"MongosNodeNum,omitnil,omitempty" name:"MongosNodeNum"` // Mongos node memory, in MB. MongosMemory *uint64 `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // Number of Mongos node CPU cores. MongosCpuNum *uint64 `json:"MongosCpuNum,omitnil,omitempty" name:"MongosCpuNum"` // Number of ConfigServer nodes. ConfigServerNodeNum *uint64 `json:"ConfigServerNodeNum,omitnil,omitempty" name:"ConfigServerNodeNum"` // Config Server node memory, in MB. ConfigServerMemory *uint64 `json:"ConfigServerMemory,omitnil,omitempty" name:"ConfigServerMemory"` // Config Server node disk size, in MB. ConfigServerVolume *uint64 `json:"ConfigServerVolume,omitnil,omitempty" name:"ConfigServerVolume"` // Number of ConfigServer node CPU cores. ConfigServerCpuNum *uint64 `json:"ConfigServerCpuNum,omitnil,omitempty" name:"ConfigServerCpuNum"` // Number of read-only nodes. ReadonlyNodeNum *uint64 `json:"ReadonlyNodeNum,omitnil,omitempty" name:"ReadonlyNodeNum"` }
type InstanceEnumParam ¶
type InstanceEnumParam struct { // Current parameter value. CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"` // Default parameter value. DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"` // Enumerated values, which indicate all supported values. EnumValue []*string `json:"EnumValue,omitnil,omitempty" name:"EnumValue"` // Whether a restart is required for the parameters to take effect after modification. // - 1: Restart is required for the parameters to take effect. // - 0: Restart is not required. Once set, the parameters take effect immediately. NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"` // Parameter name. ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"` // Parameter description. Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"` // Parameter type description. ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"` // Whether the parameter values are used during running. // - 1. parameter values used during running. // - 0: parameter values not used during running. Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"` }
type InstanceIntegerParam ¶
type InstanceIntegerParam struct { // Current parameter value. CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"` // Default parameter value. DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"` // Maximum parameter value. Max *string `json:"Max,omitnil,omitempty" name:"Max"` // Minimum value. Min *string `json:"Min,omitnil,omitempty" name:"Min"` // Whether a restart is required for the parameters to take effect after modification. // - 1: Restart is required for the parameters to take effect. // - 0: Restart is not required. Once set, the parameters take effect immediately. NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"` // Parameter name. ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"` // Parameter description. Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"` // Parameter type. ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"` // Whether the parameter values are used during running. // - 1. parameter values used during running. // - 0: parameter values not used during running. Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"` // Redundant field. It can be ignored. Unit *string `json:"Unit,omitnil,omitempty" name:"Unit"` }
type InstanceMultiParam ¶
type InstanceMultiParam struct { // Current parameter value. CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"` // Default parameter value. DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"` // Reference value range. EnumValue []*string `json:"EnumValue,omitnil,omitempty" name:"EnumValue"` // Whether a restart is required for the parameters to take effect after modification. // - 1: Restart is required for the parameters to take effect. // - 0: Restart is not required. Once set, the parameters take effect immediately. NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"` // Parameter name. ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"` // Whether the parameter values are used during running. // - 1. parameter values used during running. // - 0: parameter values not used during running. Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"` // Parameter description. Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"` // Describes the type of the current values. Default value: multi. ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"` }
type InstanceTextParam ¶
type InstanceTextParam struct { // Current parameter value. CurrentValue *string `json:"CurrentValue,omitnil,omitempty" name:"CurrentValue"` // Default parameter value. DefaultValue *string `json:"DefaultValue,omitnil,omitempty" name:"DefaultValue"` // Whether a restart is required after the parameter values are modified. NeedRestart *string `json:"NeedRestart,omitnil,omitempty" name:"NeedRestart"` // Parameter name. ParamName *string `json:"ParamName,omitnil,omitempty" name:"ParamName"` // Corresponding values of the Text-type parameters. TextValue *string `json:"TextValue,omitnil,omitempty" name:"TextValue"` // Parameter description. Tips []*string `json:"Tips,omitnil,omitempty" name:"Tips"` // Parameter type description. ValueType *string `json:"ValueType,omitnil,omitempty" name:"ValueType"` // Whether the parameter values are used during running. // - 1. parameter values used during running. // - 0: parameter values not used during running. Status *string `json:"Status,omitnil,omitempty" name:"Status"` }
type IsolateDBInstanceRequest ¶
type IsolateDBInstanceRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the ID of the instance to be isolated from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
func NewIsolateDBInstanceRequest ¶
func NewIsolateDBInstanceRequest() (request *IsolateDBInstanceRequest)
func (*IsolateDBInstanceRequest) FromJsonString ¶
func (r *IsolateDBInstanceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*IsolateDBInstanceRequest) ToJsonString ¶
func (r *IsolateDBInstanceRequest) ToJsonString() string
type IsolateDBInstanceRequestParams ¶
type IsolateDBInstanceRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the ID of the instance to be isolated from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
Predefined struct for user
type IsolateDBInstanceResponse ¶
type IsolateDBInstanceResponse struct { *tchttp.BaseResponse Response *IsolateDBInstanceResponseParams `json:"Response"` }
func NewIsolateDBInstanceResponse ¶
func NewIsolateDBInstanceResponse() (response *IsolateDBInstanceResponse)
func (*IsolateDBInstanceResponse) FromJsonString ¶
func (r *IsolateDBInstanceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*IsolateDBInstanceResponse) ToJsonString ¶
func (r *IsolateDBInstanceResponse) ToJsonString() string
type IsolateDBInstanceResponseParams ¶
type IsolateDBInstanceResponseParams struct { // Async task request ID, which can be used to query the execution result of an async task. AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ModifyDBInstanceNetworkAddressRequest ¶
type ModifyDBInstanceNetworkAddressRequest struct { *tchttp.BaseRequest // Specifies the ID of the instance for modifying the network. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Retention period of the original IP address. // - Unit: minutes. 0 means that the IP address is immediately repossessed. // - The original IP address will be released after a scheduled period. Both the original and new IP addresses are accessible before release. OldIpExpiredTime *uint64 `json:"OldIpExpiredTime,omitnil,omitempty" name:"OldIpExpiredTime"` // VPC ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the VPC ID. NewUniqVpcId *string `json:"NewUniqVpcId,omitnil,omitempty" name:"NewUniqVpcId"` // VPC subnet ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the subnet ID of the VPC. NewUniqSubnetId *string `json:"NewUniqSubnetId,omitnil,omitempty" name:"NewUniqSubnetId"` // IP address information, including the new IP address and the original IP address. NetworkAddresses []*ModifyNetworkAddress `json:"NetworkAddresses,omitnil,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 ModifyDBInstanceNetworkAddressRequestParams ¶
type ModifyDBInstanceNetworkAddressRequestParams struct { // Specifies the ID of the instance for modifying the network. For example, cmgo-p8vn****. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Retention period of the original IP address. // - Unit: minutes. 0 means that the IP address is immediately repossessed. // - The original IP address will be released after a scheduled period. Both the original and new IP addresses are accessible before release. OldIpExpiredTime *uint64 `json:"OldIpExpiredTime,omitnil,omitempty" name:"OldIpExpiredTime"` // VPC ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the VPC ID. NewUniqVpcId *string `json:"NewUniqVpcId,omitnil,omitempty" name:"NewUniqVpcId"` // VPC subnet ID after the switch. If the instance is using a basic network, this field is not required. The [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API can be called to obtain the subnet ID of the VPC. NewUniqSubnetId *string `json:"NewUniqSubnetId,omitnil,omitempty" name:"NewUniqSubnetId"` // IP address information, including the new IP address and the original IP address. NetworkAddresses []*ModifyNetworkAddress `json:"NetworkAddresses,omitnil,omitempty" name:"NetworkAddresses"` }
Predefined struct for user
type ModifyDBInstanceNetworkAddressResponse ¶
type ModifyDBInstanceNetworkAddressResponse struct { *tchttp.BaseResponse Response *ModifyDBInstanceNetworkAddressResponseParams `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 ModifyDBInstanceNetworkAddressResponseParams ¶
type ModifyDBInstanceNetworkAddressResponseParams struct { // ID of the asynchronous process task for modifying the network information. FlowId *uint64 `json:"FlowId,omitnil,omitempty" name:"FlowId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ModifyDBInstanceSecurityGroupRequest ¶
type ModifyDBInstanceSecurityGroupRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Target security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) page to copy the target security group ID. // **Note**: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections. SecurityGroupIds []*string `json:"SecurityGroupIds,omitnil,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 ModifyDBInstanceSecurityGroupRequestParams ¶
type ModifyDBInstanceSecurityGroupRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Target security group ID. Log in to the [security group console](https://console.cloud.tencent.com/vpc/security-group) page to copy the target security group ID. // **Note**: This input parameter performs a full replacement on all existing collections but not an incremental update. To modify it, import the expected full collections. SecurityGroupIds []*string `json:"SecurityGroupIds,omitnil,omitempty" name:"SecurityGroupIds"` }
Predefined struct for user
type ModifyDBInstanceSecurityGroupResponse ¶
type ModifyDBInstanceSecurityGroupResponse struct { *tchttp.BaseResponse Response *ModifyDBInstanceSecurityGroupResponseParams `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 ModifyDBInstanceSecurityGroupResponseParams ¶
type ModifyDBInstanceSecurityGroupResponseParams struct { // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ModifyDBInstanceSpecRequest ¶
type ModifyDBInstanceSpecRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). // **Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). // - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time. // - During configuration downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // (Deprecated) Use the independent API ResizeOplog. // // Oplog size after instance configuration modification. // - Unit: GB. // - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity. OplogSize *uint64 `json:"OplogSize,omitnil,omitempty" name:"OplogSize"` // Number of Mongod nodes after instance changes (excluding read-only nodes). // - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. // - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. // **Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes). NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Number of shards after instance changes. // - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. // - The number of instance shards can only be increased and cannot be decreased. ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // Switch time for instance configuration modification. // - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0. // - 1: Execute the configuration modification task within the maintenance window. // **Note**: Adjusting the number of nodes and shards is unsupported <b>within the maintenance window</b>. InMaintenance *uint64 `json:"InMaintenance,omitnil,omitempty" name:"InMaintenance"` // Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). MongosMemory *string `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // List of nodes to be added, containing the node type and AZ information. AddNodeList []*AddNodeList `json:"AddNodeList,omitnil,omitempty" name:"AddNodeList"` // Deletes the node list. // **Note**: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard. RemoveNodeList []*RemoveNodeList `json:"RemoveNodeList,omitnil,omitempty" name:"RemoveNodeList"` }
func NewModifyDBInstanceSpecRequest ¶
func NewModifyDBInstanceSpecRequest() (request *ModifyDBInstanceSpecRequest)
func (*ModifyDBInstanceSpecRequest) FromJsonString ¶
func (r *ModifyDBInstanceSpecRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyDBInstanceSpecRequest) ToJsonString ¶
func (r *ModifyDBInstanceSpecRequest) ToJsonString() string
type ModifyDBInstanceSpecRequestParams ¶
type ModifyDBInstanceSpecRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Memory size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current memory size of the instance. For the currently supported memory specifications, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). // **Note**: Memory and disk configurations should be upgraded or downgraded simultaneously, meaning that Memory and Volume should be modified at the same time. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Hard disk size after instance configuration changes, in GB. If this parameter is left blank, the default value is the current disk size of the instance. For the currently supported disk capacity, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). // - Memory and disk configurations should be upgraded or downgraded at the same time, meaning that Memory and Volume should be modified at the same time. // - During configuration downgrade, the disk capacity after changes should be greater than 1.2 times the used disk capacity. Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // (Deprecated) Use the independent API ResizeOplog. // // Oplog size after instance configuration modification. // - Unit: GB. // - By default, the capacity occupied by Oplog is 10% of the disk capacity. The range of capacity occupied by Oplog supported by the system is [10%,90%] of the disk capacity. // // Deprecated: OplogSize is deprecated. OplogSize *uint64 `json:"OplogSize,omitnil,omitempty" name:"OplogSize"` // Number of Mongod nodes after instance changes (excluding read-only nodes). // - Number of replica set nodes. The value range of the number of nodes can be obtained through the response parameters MinNodeNum and MaxNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. // - Number of nodes per shard in a sharded cluster. The value range of the number of nodes can be obtained through the response parameters MinReplicateSetNodeNum and MaxReplicateSetNodeNum of the [DescribeSpecInfo ](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. // **Note**: When the CPU and memory specifications of Mongod or Mongos nodes are changed, this parameter is not required, or enter the current number of Mongod or Mongos nodes (excluding read-only nodes). NodeNum *uint64 `json:"NodeNum,omitnil,omitempty" name:"NodeNum"` // Number of shards after instance changes. // - The value range for the number of instance shards can be obtained through the response parameters **MinReplicateSetNum** and **MaxReplicateSetNum** of the [DescribeSpecInfo](https://www.tencentcloud.comom/document/product/240/38567?from_cn_redirect=1) API. // - The number of instance shards can only be increased and cannot be decreased. ReplicateSetNum *uint64 `json:"ReplicateSetNum,omitnil,omitempty" name:"ReplicateSetNum"` // Switch time for instance configuration modification. // - 0: Execute the configuration modification task immediately after the adjustment is completed. Default value: 0. // - 1: Execute the configuration modification task within the maintenance window. // **Note**: Adjusting the number of nodes and shards is unsupported <b>within the maintenance window</b>. InMaintenance *uint64 `json:"InMaintenance,omitnil,omitempty" name:"InMaintenance"` // Memory size of the Mongos node after sharded cluster instance configuration changes, in GB. For the specifications supported by the instance, see [Product Specifications](https://www.tencentcloud.comom/document/product/240/64125?from_cn_redirect=1). MongosMemory *string `json:"MongosMemory,omitnil,omitempty" name:"MongosMemory"` // List of nodes to be added, containing the node type and AZ information. AddNodeList []*AddNodeList `json:"AddNodeList,omitnil,omitempty" name:"AddNodeList"` // Deletes the node list. // **Note**: According to the consistency principle for nodes of each shard on a sharded cluster instance, specify the nodes on shard 0 for node deletion from the sharded cluster instance. For example, cmgo-9nl1czif_0-node-readonly0 will delete the first read-only node of each shard. RemoveNodeList []*RemoveNodeList `json:"RemoveNodeList,omitnil,omitempty" name:"RemoveNodeList"` }
Predefined struct for user
type ModifyDBInstanceSpecResponse ¶
type ModifyDBInstanceSpecResponse struct { *tchttp.BaseResponse Response *ModifyDBInstanceSpecResponseParams `json:"Response"` }
func NewModifyDBInstanceSpecResponse ¶
func NewModifyDBInstanceSpecResponse() (response *ModifyDBInstanceSpecResponse)
func (*ModifyDBInstanceSpecResponse) FromJsonString ¶
func (r *ModifyDBInstanceSpecResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ModifyDBInstanceSpecResponse) ToJsonString ¶
func (r *ModifyDBInstanceSpecResponse) ToJsonString() string
type ModifyDBInstanceSpecResponseParams ¶
type ModifyDBInstanceSpecResponseParams struct { // Order ID. DealId *string `json:"DealId,omitnil,omitempty" name:"DealId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ModifyNetworkAddress ¶
type OfflineIsolatedDBInstanceRequest ¶
type OfflineIsolatedDBInstanceRequest struct { *tchttp.BaseRequest // Instance ID. Log in to the [TencentDB for MongoDB console recycle bin](https://console.cloud.tencent.com/mongodb/recycle), and copy the ID of the instance to be eliminated from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
func NewOfflineIsolatedDBInstanceRequest ¶
func NewOfflineIsolatedDBInstanceRequest() (request *OfflineIsolatedDBInstanceRequest)
func (*OfflineIsolatedDBInstanceRequest) FromJsonString ¶
func (r *OfflineIsolatedDBInstanceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*OfflineIsolatedDBInstanceRequest) ToJsonString ¶
func (r *OfflineIsolatedDBInstanceRequest) ToJsonString() string
type OfflineIsolatedDBInstanceRequestParams ¶
type OfflineIsolatedDBInstanceRequestParams struct { // Instance ID. Log in to the [TencentDB for MongoDB console recycle bin](https://console.cloud.tencent.com/mongodb/recycle), and copy the ID of the instance to be eliminated from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
Predefined struct for user
type OfflineIsolatedDBInstanceResponse ¶
type OfflineIsolatedDBInstanceResponse struct { *tchttp.BaseResponse Response *OfflineIsolatedDBInstanceResponseParams `json:"Response"` }
func NewOfflineIsolatedDBInstanceResponse ¶
func NewOfflineIsolatedDBInstanceResponse() (response *OfflineIsolatedDBInstanceResponse)
func (*OfflineIsolatedDBInstanceResponse) FromJsonString ¶
func (r *OfflineIsolatedDBInstanceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*OfflineIsolatedDBInstanceResponse) ToJsonString ¶
func (r *OfflineIsolatedDBInstanceResponse) ToJsonString() string
type OfflineIsolatedDBInstanceResponseParams ¶
type OfflineIsolatedDBInstanceResponseParams struct { // Async task request ID, which can be used to query the execution result of an async task. AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type RemoveNodeList ¶
type RemoveNodeList struct { // Roles of nodes to be deleted. // - SECONDARY: Mongod secondary node. // - READONLY: read-only node. // - MONGOS: Mongos node. Role *string `json:"Role,omitnil,omitempty" name:"Role"` // IDs of nodes to be deleted. For a sharded cluster instance, specify the names of nodes to be deleted on one shard. Nodes with the same names on other shards will also be deleted. // - Obtaining method: Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), go to the **Node Management** tab, and obtain the **node ID**. // - Note: For a sharded cluster instance, specify the IDs of nodes on shard 0. For example, cmgo-6hfk\*\*\*\*\_0-node-primary. NodeName *string `json:"NodeName,omitnil,omitempty" name:"NodeName"` // AZ corresponding to the node. For the currently supported AZs, see [Regions and AZs](https://www.tencentcloud.comom/document/product/240/3637?from_cn_redirect=1). // - Single AZ: all nodes are in the same AZ. // - Multiple AZs: The current standard specification involves three AZs. The primary and secondary nodes are not in the same AZ. Note: AZs corresponding to the nodes to be deleted should be specified. After deletion, the number of nodes in any 2 AZs should be larger than that in the third AZ. Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` }
type RenameInstanceRequest ¶
type RenameInstanceRequest struct { *tchttp.BaseRequest // Instance ID. Format: cmgo-p8vnipr5. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB#/) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Custom instance name. It can contain any character, with a length from 1 to 128 characters. NewName *string `json:"NewName,omitnil,omitempty" name:"NewName"` }
func NewRenameInstanceRequest ¶
func NewRenameInstanceRequest() (request *RenameInstanceRequest)
func (*RenameInstanceRequest) FromJsonString ¶
func (r *RenameInstanceRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RenameInstanceRequest) ToJsonString ¶
func (r *RenameInstanceRequest) ToJsonString() string
type RenameInstanceRequestParams ¶
type RenameInstanceRequestParams struct { // Instance ID. Format: cmgo-p8vnipr5. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/MongoDB#/) and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Custom instance name. It can contain any character, with a length from 1 to 128 characters. NewName *string `json:"NewName,omitnil,omitempty" name:"NewName"` }
Predefined struct for user
type RenameInstanceResponse ¶
type RenameInstanceResponse struct { *tchttp.BaseResponse Response *RenameInstanceResponseParams `json:"Response"` }
func NewRenameInstanceResponse ¶
func NewRenameInstanceResponse() (response *RenameInstanceResponse)
func (*RenameInstanceResponse) FromJsonString ¶
func (r *RenameInstanceResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RenameInstanceResponse) ToJsonString ¶
func (r *RenameInstanceResponse) ToJsonString() string
type RenameInstanceResponseParams ¶
type RenameInstanceResponseParams struct { // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type RenewDBInstancesRequest ¶
type RenewDBInstancesRequest struct { *tchttp.BaseRequest // Specifies the ID or IDs of one or multiple instances to be renewed. // - It can be obtained through the response parameter **InstanceId** of the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API. // - The maximum number of instances for each renewal request is 100. InstanceIds []*string `json:"InstanceIds,omitnil,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,omitnil,omitempty" name:"InstanceChargePrepaid"` }
func NewRenewDBInstancesRequest ¶
func NewRenewDBInstancesRequest() (request *RenewDBInstancesRequest)
func (*RenewDBInstancesRequest) FromJsonString ¶
func (r *RenewDBInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RenewDBInstancesRequest) ToJsonString ¶
func (r *RenewDBInstancesRequest) ToJsonString() string
type RenewDBInstancesRequestParams ¶
type RenewDBInstancesRequestParams struct { // Specifies the ID or IDs of one or multiple instances to be renewed. // - It can be obtained through the response parameter **InstanceId** of the [DescribeDBInstances](https://www.tencentcloud.comom/document/product/240/38568?from_cn_redirect=1) API. // - The maximum number of instances for each renewal request is 100. InstanceIds []*string `json:"InstanceIds,omitnil,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,omitnil,omitempty" name:"InstanceChargePrepaid"` }
Predefined struct for user
type RenewDBInstancesResponse ¶
type RenewDBInstancesResponse struct { *tchttp.BaseResponse Response *RenewDBInstancesResponseParams `json:"Response"` }
func NewRenewDBInstancesResponse ¶
func NewRenewDBInstancesResponse() (response *RenewDBInstancesResponse)
func (*RenewDBInstancesResponse) FromJsonString ¶
func (r *RenewDBInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*RenewDBInstancesResponse) ToJsonString ¶
func (r *RenewDBInstancesResponse) ToJsonString() string
type RenewDBInstancesResponseParams ¶
type RenewDBInstancesResponseParams struct { // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ReplicaSetInfo ¶
type ReplicaSetInfo struct { // Replica set ID. ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"` }
type ResetDBInstancePasswordRequest ¶
type ResetDBInstancePasswordRequest struct { *tchttp.BaseRequest // Specifies the instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the account name for which the password needs to be changed. The [DescribeAccountUsers](https://www.tencentcloud.comom/document/product/240/80800?from_cn_redirect=1) API can be called to obtain the account list and copy the account name for which the password needs to be changed. UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"` // Specifies a new password for the account. Password complexity requirements: // - It should contain 8–32 characters. // - It should contain at least two types of the following: letters, digits, and special characters (!@#%^\*()\_). Password *string `json:"Password,omitnil,omitempty" name:"Password"` }
func NewResetDBInstancePasswordRequest ¶
func NewResetDBInstancePasswordRequest() (request *ResetDBInstancePasswordRequest)
func (*ResetDBInstancePasswordRequest) FromJsonString ¶
func (r *ResetDBInstancePasswordRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ResetDBInstancePasswordRequest) ToJsonString ¶
func (r *ResetDBInstancePasswordRequest) ToJsonString() string
type ResetDBInstancePasswordRequestParams ¶
type ResetDBInstancePasswordRequestParams struct { // Specifies the instance ID. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` // Specifies the account name for which the password needs to be changed. The [DescribeAccountUsers](https://www.tencentcloud.comom/document/product/240/80800?from_cn_redirect=1) API can be called to obtain the account list and copy the account name for which the password needs to be changed. UserName *string `json:"UserName,omitnil,omitempty" name:"UserName"` // Specifies a new password for the account. Password complexity requirements: // - It should contain 8–32 characters. // - It should contain at least two types of the following: letters, digits, and special characters (!@#%^\*()\_). Password *string `json:"Password,omitnil,omitempty" name:"Password"` }
Predefined struct for user
type ResetDBInstancePasswordResponse ¶
type ResetDBInstancePasswordResponse struct { *tchttp.BaseResponse Response *ResetDBInstancePasswordResponseParams `json:"Response"` }
func NewResetDBInstancePasswordResponse ¶
func NewResetDBInstancePasswordResponse() (response *ResetDBInstancePasswordResponse)
func (*ResetDBInstancePasswordResponse) FromJsonString ¶
func (r *ResetDBInstancePasswordResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*ResetDBInstancePasswordResponse) ToJsonString ¶
func (r *ResetDBInstancePasswordResponse) ToJsonString() string
type ResetDBInstancePasswordResponseParams ¶
type ResetDBInstancePasswordResponseParams struct { // Task request ID. AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"` // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type SecurityGroup ¶
type SecurityGroup struct { // Associated project ID. ProjectId *int64 `json:"ProjectId,omitnil,omitempty" name:"ProjectId"` // Security group creation time. CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"` // Security group inbound rule. Inbound []*SecurityGroupBound `json:"Inbound,omitnil,omitempty" name:"Inbound"` // Security group outbound rule. Outbound []*SecurityGroupBound `json:"Outbound,omitnil,omitempty" name:"Outbound"` // Security group ID. SecurityGroupId *string `json:"SecurityGroupId,omitnil,omitempty" name:"SecurityGroupId"` // Security group name. SecurityGroupName *string `json:"SecurityGroupName,omitnil,omitempty" name:"SecurityGroupName"` // Security group remarks. SecurityGroupRemark *string `json:"SecurityGroupRemark,omitnil,omitempty" name:"SecurityGroupRemark"` }
type SecurityGroupBound ¶
type SecurityGroupBound struct { // Execution policy. // - ACCEPT: allow. Access requests for the port can be released. // - DROP: reject. Data packets are discarded without any response. Action *string `json:"Action,omitnil,omitempty" name:"Action"` // Inbound IP address or IP range for database access. CidrIp *string `json:"CidrIp,omitnil,omitempty" name:"CidrIp"` // Port for database access. PortRange *string `json:"PortRange,omitnil,omitempty" name:"PortRange"` // Transport layer protocol: TCP. IpProtocol *string `json:"IpProtocol,omitnil,omitempty" name:"IpProtocol"` // Security group ID. Id *string `json:"Id,omitnil,omitempty" name:"Id"` // Parameter template ID for the IP address or IP address group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/ip) to obtain the parameter template IP address details. AddressModule *string `json:"AddressModule,omitnil,omitempty" name:"AddressModule"` // Parameter template ID for the protocol port or protocol port group. Log in to the [parameter template console](https://console.cloud.tencent.com/vpc/template/protoport) to obtain the parameter template protocol port details. ServiceModule *string `json:"ServiceModule,omitnil,omitempty" name:"ServiceModule"` // Security group description information. Desc *string `json:"Desc,omitnil,omitempty" name:"Desc"` }
type SetDBInstanceDeletionProtectionRequest ¶
type SetDBInstanceDeletionProtectionRequest struct { *tchttp.BaseRequest // Instance ID list, in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // Instance termination protection switch. Valid values: 0 - disabled; 1 - enabled. EnableDeletionProtection *uint64 `json:"EnableDeletionProtection,omitnil,omitempty" name:"EnableDeletionProtection"` }
func NewSetDBInstanceDeletionProtectionRequest ¶
func NewSetDBInstanceDeletionProtectionRequest() (request *SetDBInstanceDeletionProtectionRequest)
func (*SetDBInstanceDeletionProtectionRequest) FromJsonString ¶
func (r *SetDBInstanceDeletionProtectionRequest) 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 (*SetDBInstanceDeletionProtectionRequest) ToJsonString ¶
func (r *SetDBInstanceDeletionProtectionRequest) ToJsonString() string
type SetDBInstanceDeletionProtectionRequestParams ¶
type SetDBInstanceDeletionProtectionRequestParams struct { // Instance ID list, in the format of cmgo-p8vnipr5. It is the same as the format of the instance ID displayed on the TencentDB for MongoDB console page. InstanceIds []*string `json:"InstanceIds,omitnil,omitempty" name:"InstanceIds"` // Instance termination protection switch. Valid values: 0 - disabled; 1 - enabled. EnableDeletionProtection *uint64 `json:"EnableDeletionProtection,omitnil,omitempty" name:"EnableDeletionProtection"` }
Predefined struct for user
type SetDBInstanceDeletionProtectionResponse ¶
type SetDBInstanceDeletionProtectionResponse struct { *tchttp.BaseResponse Response *SetDBInstanceDeletionProtectionResponseParams `json:"Response"` }
func NewSetDBInstanceDeletionProtectionResponse ¶
func NewSetDBInstanceDeletionProtectionResponse() (response *SetDBInstanceDeletionProtectionResponse)
func (*SetDBInstanceDeletionProtectionResponse) FromJsonString ¶
func (r *SetDBInstanceDeletionProtectionResponse) 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 (*SetDBInstanceDeletionProtectionResponse) ToJsonString ¶
func (r *SetDBInstanceDeletionProtectionResponse) ToJsonString() string
type SetDBInstanceDeletionProtectionResponseParams ¶
type SetDBInstanceDeletionProtectionResponseParams struct { // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user
type ShardInfo ¶
type ShardInfo struct { // Used shard capacity UsedVolume *float64 `json:"UsedVolume,omitnil,omitempty" name:"UsedVolume"` // Shard ID ReplicaSetId *string `json:"ReplicaSetId,omitnil,omitempty" name:"ReplicaSetId"` // Shard name ReplicaSetName *string `json:"ReplicaSetName,omitnil,omitempty" name:"ReplicaSetName"` // Shard memory size in MB Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Shard disk size in MB Volume *uint64 `json:"Volume,omitnil,omitempty" name:"Volume"` // Shard oplog size in MB OplogSize *uint64 `json:"OplogSize,omitnil,omitempty" name:"OplogSize"` // Number of secondary nodes of a shard SecondaryNum *uint64 `json:"SecondaryNum,omitnil,omitempty" name:"SecondaryNum"` // Shard physical ID RealReplicaSetId *string `json:"RealReplicaSetId,omitnil,omitempty" name:"RealReplicaSetId"` }
type SlowLogItem ¶
type SlowLogPattern ¶
type SlowLogPattern struct { // Slow log output format: database name.table name.command. Pattern *string `json:"Pattern,omitnil,omitempty" name:"Pattern"` // queryHash value carried during slow log recording. It can be used to identify a query type. QueryHash *string `json:"QueryHash,omitnil,omitempty" name:"QueryHash"` // Maximum execution time, in milliseconds. MaxTime *uint64 `json:"MaxTime,omitnil,omitempty" name:"MaxTime"` // Average execution time, in milliseconds. AverageTime *uint64 `json:"AverageTime,omitnil,omitempty" name:"AverageTime"` // Number of slow logs. Total *uint64 `json:"Total,omitnil,omitempty" name:"Total"` }
type SpecItem ¶
type SpecItem struct { // Specification information identifier. Format: mongo.HIO10G.128G. It consists of three parts: node type, specification type, and memory specification. // - Node type: **mongo** indicates a Mongod node; **mongos** indicates a Mongos node; **cfgstr** indicates a ConfigServer node. // - Specification type: **HIO10G** indicates the general HIO 10GE type; **HCD** indicates the Cloud Disk Edition type. // - Memory specification, in GB. Valid values: 4, 8, 16, 32, 64, 128, 240, and 512. 128g indicates 128 GB. SpecCode *string `json:"SpecCode,omitnil,omitempty" name:"SpecCode"` // Saleable specification status flag. Valid values are as follows: // - 0: selling stopped. // - 1: available for sale. Status *uint64 `json:"Status,omitnil,omitempty" name:"Status"` // Computing resource specification, indicating the number of CPU cores. Cpu *uint64 `json:"Cpu,omitnil,omitempty" name:"Cpu"` // Memory specification. Unit: MB. Memory *uint64 `json:"Memory,omitnil,omitempty" name:"Memory"` // Default disk specification. Unit: MB. DefaultStorage *uint64 `json:"DefaultStorage,omitnil,omitempty" name:"DefaultStorage"` // Maximum disk specification. Unit: MB. MaxStorage *uint64 `json:"MaxStorage,omitnil,omitempty" name:"MaxStorage"` // Minimum disk specification. Unit: MB. MinStorage *uint64 `json:"MinStorage,omitnil,omitempty" name:"MinStorage"` // Maximum number of requests per second. Unit: requests/second. Qps *uint64 `json:"Qps,omitnil,omitempty" name:"Qps"` // Maximum number of connections supported for the specification. Conns *uint64 `json:"Conns,omitnil,omitempty" name:"Conns"` // Storage engine version information on instances. // - MONGO_40_WT: version of the MongoDB 4.0 WiredTiger storage engine. // - MONGO_42_WT: version of the MongoDB 4.2 WiredTiger storage engine. // - MONGO_44_WT: version of the MongoDB 4.4 WiredTiger storage engine. // - MONGO_50_WT: version of the MongoDB 5.0 WiredTiger storage engine. // - MONGO_60_WT: version of the MongoDB 6.0 WiredTiger storage engine. // - MONGO_70_WT: version of the MongoDB 7.0 WiredTiger storage engine. MongoVersionCode *string `json:"MongoVersionCode,omitnil,omitempty" name:"MongoVersionCode"` // Digital version corresponding to the instance version. MongoVersionValue *uint64 `json:"MongoVersionValue,omitnil,omitempty" name:"MongoVersionValue"` // Instance version information. Valid values: 4.2, 4.4, 5.0, 6.0, and 7.0. Version *string `json:"Version,omitnil,omitempty" name:"Version"` // Storage engine. EngineName *string `json:"EngineName,omitnil,omitempty" name:"EngineName"` // Cluster type. Valid values are as follows: // - 1: sharded cluster. // - 0: replica set cluster. ClusterType *uint64 `json:"ClusterType,omitnil,omitempty" name:"ClusterType"` // Minimum number of nodes for each replica set. MinNodeNum *uint64 `json:"MinNodeNum,omitnil,omitempty" name:"MinNodeNum"` // Maximum number of nodes for each replica set. MaxNodeNum *uint64 `json:"MaxNodeNum,omitnil,omitempty" name:"MaxNodeNum"` // Minimum number of shards. MinReplicateSetNum *uint64 `json:"MinReplicateSetNum,omitnil,omitempty" name:"MinReplicateSetNum"` // Maximum number of shards. MaxReplicateSetNum *uint64 `json:"MaxReplicateSetNum,omitnil,omitempty" name:"MaxReplicateSetNum"` // Minimum number of nodes for each shard. MinReplicateSetNodeNum *uint64 `json:"MinReplicateSetNodeNum,omitnil,omitempty" name:"MinReplicateSetNodeNum"` // Maximum number of nodes for each shard. MaxReplicateSetNodeNum *uint64 `json:"MaxReplicateSetNodeNum,omitnil,omitempty" name:"MaxReplicateSetNodeNum"` // Cluster specification type. Valid values are as follows: // - HIO10G: general high-I/O 10GE type. // - HCD: cloud disk type. MachineType *string `json:"MachineType,omitnil,omitempty" name:"MachineType"` }
type SpecificationInfo ¶
type SpecificationInfo struct { // Region information. Region *string `json:"Region,omitnil,omitempty" name:"Region"` // AZ information. Zone *string `json:"Zone,omitnil,omitempty" name:"Zone"` // Sales specification information. SpecItems []*SpecItem `json:"SpecItems,omitnil,omitempty" name:"SpecItems"` // Whether cross-AZ deployment is supported. // - 1: supported. // - 0: not supported. SupportMultiAZ *int64 `json:"SupportMultiAZ,omitnil,omitempty" name:"SupportMultiAZ"` }
type TerminateDBInstancesRequest ¶
type TerminateDBInstancesRequest struct { *tchttp.BaseRequest // Specifies the ID of the pre-isolated instance. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
func NewTerminateDBInstancesRequest ¶
func NewTerminateDBInstancesRequest() (request *TerminateDBInstancesRequest)
func (*TerminateDBInstancesRequest) FromJsonString ¶
func (r *TerminateDBInstancesRequest) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateDBInstancesRequest) ToJsonString ¶
func (r *TerminateDBInstancesRequest) ToJsonString() string
type TerminateDBInstancesRequestParams ¶
type TerminateDBInstancesRequestParams struct { // Specifies the ID of the pre-isolated instance. Log in to the [TencentDB for MongoDB console](https://console.cloud.tencent.com/mongodb), and copy the instance ID from the instance list. InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"` }
Predefined struct for user
type TerminateDBInstancesResponse ¶
type TerminateDBInstancesResponse struct { *tchttp.BaseResponse Response *TerminateDBInstancesResponseParams `json:"Response"` }
func NewTerminateDBInstancesResponse ¶
func NewTerminateDBInstancesResponse() (response *TerminateDBInstancesResponse)
func (*TerminateDBInstancesResponse) FromJsonString ¶
func (r *TerminateDBInstancesResponse) FromJsonString(s string) error
FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check
func (*TerminateDBInstancesResponse) ToJsonString ¶
func (r *TerminateDBInstancesResponse) ToJsonString() string
type TerminateDBInstancesResponseParams ¶
type TerminateDBInstancesResponseParams struct { // The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. RequestId *string `json:"RequestId,omitnil,omitempty" name:"RequestId"` }
Predefined struct for user