v20180330

package
v3.0.974+incompatible Latest Latest
Warning

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

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

Documentation

Index

Constants

View Source 
const (

	// The current user is not allowed to perform this operation as the authentication failed.
	AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"

	// This operation is prohibited.
	FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"

	// Failed to start the task.
	FAILEDOPERATION_STARTJOBFAILED = "FailedOperation.StartJobFailed"

	// This operation cannot be performed due to status conflict.
	FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"

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

	// Failed to create the async task.
	INTERNALERROR_ADDTASKERROR = "InternalError.AddTaskError"

	// Internal scheduling system error.
	INTERNALERROR_CELERYERROR = "InternalError.CeleryError"

	// CGW system error.
	INTERNALERROR_CGWSYSTEMERROR = "InternalError.CgwSystemError"

	// Failed to access the database on the DTS platform.
	INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"

	// Migration tasks are in conflict.
	INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"

	// Locks are in conflict.
	INTERNALERROR_LOCKERROR = "InternalError.LockError"

	// Communication protocol error.
	INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"

	// Internal error.
	INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"

	// Unknown internal error.
	INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"

	// A parameter error occurred.
	INVALIDPARAMETER = "InvalidParameter"

	// Parameter value error.
	INVALIDPARAMETER_BIZINVALIDPARAMETERVALUEERROR = "InvalidParameter.BizInvalidParameterValueError"

	// The instance does not exist.
	INVALIDPARAMETER_INSTANCENOTFOUND = "InvalidParameter.InstanceNotFound"

	// Incorrect parameter value.
	INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUE = "InvalidParameterValue.InvalidParameterValue"

	// The number of idle migration tasks exceeds the limit.
	LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// The operation was denied as the condition was not met.
	OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"

	// Task operation failure.
	OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"

	// DTS does not support the current migration type.
	OPERATIONDENIED_MIGRATESERVICESUPPORTERROR = "OperationDenied.MigrateServiceSupportError"

	// This operation cannot be performed.
	OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"

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

	// Resource not found.
	RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"

	// The migration task does not exist.
	RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"

	// The instance is not found.
	RESOURCENOTFOUND_RESOURCENOTFOUND = "ResourceNotFound.ResourceNotFound"

	// Verification failed. Insufficient permissions.
	UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

	// Unsupported operation
	UNSUPPORTEDOPERATION = "UnsupportedOperation"
)
View Source 
const APIVersion = "2018-03-30"

Variables

This section is empty.

Functions

This section is empty.

Types

type ActivateSubscribeRequest 

type ActivateSubscribeRequest struct {
	*tchttp.BaseRequest

	// Subscription instance ID.
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

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

	// Data subscription type. 0: full instance subscription, 1: data subscription, 2: structure subscription, 3: data subscription and structure subscription
	SubscribeObjectType *int64 `json:"SubscribeObjectType,omitnil,omitempty" name:"SubscribeObjectType"`

	// Subscription object
	Objects *SubscribeObject `json:"Objects,omitnil,omitempty" name:"Objects"`

	// Subnet of data subscription service, which is the subnet of the database instance by default.
	UniqSubnetId *string `json:"UniqSubnetId,omitnil,omitempty" name:"UniqSubnetId"`

	// Subscription service port. Default value: 7507
	Vport *int64 `json:"Vport,omitnil,omitempty" name:"Vport"`
}

func NewActivateSubscribeRequest 

func NewActivateSubscribeRequest() (request *ActivateSubscribeRequest)

func (*ActivateSubscribeRequest) FromJsonString 

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

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

func (*ActivateSubscribeRequest) ToJsonString 

func (r *ActivateSubscribeRequest) ToJsonString() string

type ActivateSubscribeRequestParams 

type ActivateSubscribeRequestParams struct {
	// Subscription instance ID.
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

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

	// Data subscription type. 0: full instance subscription, 1: data subscription, 2: structure subscription, 3: data subscription and structure subscription
	SubscribeObjectType *int64 `json:"SubscribeObjectType,omitnil,omitempty" name:"SubscribeObjectType"`

	// Subscription object
	Objects *SubscribeObject `json:"Objects,omitnil,omitempty" name:"Objects"`

	// Subnet of data subscription service, which is the subnet of the database instance by default.
	UniqSubnetId *string `json:"UniqSubnetId,omitnil,omitempty" name:"UniqSubnetId"`

	// Subscription service port. Default value: 7507
	Vport *int64 `json:"Vport,omitnil,omitempty" name:"Vport"`
}

Predefined struct for user

type ActivateSubscribeResponse 

type ActivateSubscribeResponse struct {
	*tchttp.BaseResponse
	Response *ActivateSubscribeResponseParams `json:"Response"`
}

func NewActivateSubscribeResponse 

func NewActivateSubscribeResponse() (response *ActivateSubscribeResponse)

func (*ActivateSubscribeResponse) FromJsonString 

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

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

func (*ActivateSubscribeResponse) ToJsonString 

func (r *ActivateSubscribeResponse) ToJsonString() string

type ActivateSubscribeResponseParams 

type ActivateSubscribeResponseParams struct {
	// Data subscription configuration task ID.
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`

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

Predefined struct for user

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ActivateSubscribe 

func (c *Client) ActivateSubscribe(request *ActivateSubscribeRequest) (response *ActivateSubscribeResponse, err error)

ActivateSubscribe This API is used to configure a data subscription, which can be called only for subscription instances in unconfigured status.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INSTANCENOTFOUND = "InvalidParameter.InstanceNotFound"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ActivateSubscribeWithContext 

func (c *Client) ActivateSubscribeWithContext(ctx context.Context, request *ActivateSubscribeRequest) (response *ActivateSubscribeResponse, err error)

ActivateSubscribe This API is used to configure a data subscription, which can be called only for subscription instances in unconfigured status.

error code that may be returned: 

INTERNALERROR = "InternalError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INSTANCENOTFOUND = "InvalidParameter.InstanceNotFound"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) CompleteMigrateJob 

func (c *Client) CompleteMigrateJob(request *CompleteMigrateJobRequest) (response *CompleteMigrateJobResponse, err error)

CompleteMigrateJob This API (CompleteMigrateJob) is used to complete a data migration task.

For tasks in incremental migration mode, you need to call this API before migration gets ready, so as to stop migrating incremental data.

If the task status queried through the (DescribeMigrateJobs) API is ready (status=8), you can call this API to complete the migration task.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) CompleteMigrateJobWithContext 

func (c *Client) CompleteMigrateJobWithContext(ctx context.Context, request *CompleteMigrateJobRequest) (response *CompleteMigrateJobResponse, err error)

CompleteMigrateJob This API (CompleteMigrateJob) is used to complete a data migration task.

For tasks in incremental migration mode, you need to call this API before migration gets ready, so as to stop migrating incremental data.

If the task status queried through the (DescribeMigrateJobs) API is ready (status=8), you can call this API to complete the migration task.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) CreateMigrateCheckJob 

func (c *Client) CreateMigrateCheckJob(request *CreateMigrateCheckJobRequest) (response *CreateMigrateCheckJobResponse, err error)

CreateMigrateCheckJob This API is used to create a migration check task.

Before migration, you should call this API to create a check. Migration will start only if the check succeeds. You can view the check result through the `DescribeMigrateCheckJob` API.

After successful check, if the migration task needs to be modified, a new check task should be created and migration will begin only after the new check succeeds.

For a finance zone link, use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_ADDTASKERROR = "InternalError.AddTaskError"
INTERNALERROR_CGWSYSTEMERROR = "InternalError.CgwSystemError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_LOCKERROR = "InternalError.LockError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INSTANCENOTFOUND = "InvalidParameter.InstanceNotFound"
LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) CreateMigrateCheckJobWithContext 

func (c *Client) CreateMigrateCheckJobWithContext(ctx context.Context, request *CreateMigrateCheckJobRequest) (response *CreateMigrateCheckJobResponse, err error)

CreateMigrateCheckJob This API is used to create a migration check task.

Before migration, you should call this API to create a check. Migration will start only if the check succeeds. You can view the check result through the `DescribeMigrateCheckJob` API.

After successful check, if the migration task needs to be modified, a new check task should be created and migration will begin only after the new check succeeds.

For a finance zone link, use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_ADDTASKERROR = "InternalError.AddTaskError"
INTERNALERROR_CGWSYSTEMERROR = "InternalError.CgwSystemError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_LOCKERROR = "InternalError.LockError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_INSTANCENOTFOUND = "InvalidParameter.InstanceNotFound"
LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) CreateMigrateJob 

func (c *Client) CreateMigrateJob(request *CreateMigrateJobRequest) (response *CreateMigrateJobResponse, err error)

CreateMigrateJob This API (CreateMigrateJob) is used to create a data migration task.

For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"
FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BIZINVALIDPARAMETERVALUEERROR = "InvalidParameter.BizInvalidParameterValueError"
LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) CreateMigrateJobWithContext 

func (c *Client) CreateMigrateJobWithContext(ctx context.Context, request *CreateMigrateJobRequest) (response *CreateMigrateJobResponse, err error)

CreateMigrateJob This API (CreateMigrateJob) is used to create a data migration task.

For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"
FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BIZINVALIDPARAMETERVALUEERROR = "InvalidParameter.BizInvalidParameterValueError"
LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) CreateSubscribe 

func (c *Client) CreateSubscribe(request *CreateSubscribeRequest) (response *CreateSubscribeResponse, err error)

CreateSubscribe This API is used to create a data subscription instance.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"

func (*Client) CreateSubscribeWithContext 

func (c *Client) CreateSubscribeWithContext(ctx context.Context, request *CreateSubscribeRequest) (response *CreateSubscribeResponse, err error)

CreateSubscribe This API is used to create a data subscription instance.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"

func (*Client) DeleteMigrateJob 

func (c *Client) DeleteMigrateJob(request *DeleteMigrateJobRequest) (response *DeleteMigrateJobResponse, err error)

DeleteMigrateJob This API (DeleteMigrationJob) is used to delete a data migration task. If the task status queried through the DescribeMigrateJobs API is checking (status=3), running (status=7), ready (status=8), canceling (status=11), or completing (status=12), the task cannot be deleted.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INTERNALERROR_CELERYERROR = "InternalError.CeleryError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
OPERATIONDENIED_MIGRATESERVICESUPPORTERROR = "OperationDenied.MigrateServiceSupportError"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) DeleteMigrateJobWithContext 

func (c *Client) DeleteMigrateJobWithContext(ctx context.Context, request *DeleteMigrateJobRequest) (response *DeleteMigrateJobResponse, err error)

DeleteMigrateJob This API (DeleteMigrationJob) is used to delete a data migration task. If the task status queried through the DescribeMigrateJobs API is checking (status=3), running (status=7), ready (status=8), canceling (status=11), or completing (status=12), the task cannot be deleted.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INTERNALERROR_CELERYERROR = "InternalError.CeleryError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
OPERATIONDENIED_MIGRATESERVICESUPPORTERROR = "OperationDenied.MigrateServiceSupportError"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) DescribeAsyncRequestInfo 

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

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeAsyncRequestInfoWithContext 

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

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

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"
OPERATIONDENIED_OPERATIONDENIED = "OperationDenied.OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeMigrateCheckJob 

func (c *Client) DescribeMigrateCheckJob(request *DescribeMigrateCheckJobRequest) (response *DescribeMigrateCheckJobResponse, err error)

DescribeMigrateCheckJob This API is used to get the check result and query check status and progress after a check is created.

If the check succeeds, you can call the StartMigrateJob API to start migration.

If the check fails, the reason can be queried. Please modify the migration configuration or adjust relevant parameters of the source/target instances through the ModifyMigrateJob API based on the error message.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) DescribeMigrateCheckJobWithContext 

func (c *Client) DescribeMigrateCheckJobWithContext(ctx context.Context, request *DescribeMigrateCheckJobRequest) (response *DescribeMigrateCheckJobResponse, err error)

DescribeMigrateCheckJob This API is used to get the check result and query check status and progress after a check is created.

If the check succeeds, you can call the StartMigrateJob API to start migration.

If the check fails, the reason can be queried. Please modify the migration configuration or adjust relevant parameters of the source/target instances through the ModifyMigrateJob API based on the error message.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) DescribeMigrateJobs 

func (c *Client) DescribeMigrateJobs(request *DescribeMigrateJobsRequest) (response *DescribeMigrateJobsResponse, err error)

DescribeMigrateJobs This API is used to query data migration tasks.

For a finance zone linkage, please use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"
FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) DescribeMigrateJobsWithContext 

func (c *Client) DescribeMigrateJobsWithContext(ctx context.Context, request *DescribeMigrateJobsRequest) (response *DescribeMigrateJobsResponse, err error)

DescribeMigrateJobs This API is used to query data migration tasks.

For a finance zone linkage, please use the domain name https://dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"
FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNDEFINEDERROR = "InternalError.UndefinedError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) DescribeRegionConf 

func (c *Client) DescribeRegionConf(request *DescribeRegionConfRequest) (response *DescribeRegionConfResponse, err error)

DescribeRegionConf This API is used to query the purchasable subscription instance regions.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeRegionConfWithContext 

func (c *Client) DescribeRegionConfWithContext(ctx context.Context, request *DescribeRegionConfRequest) (response *DescribeRegionConfResponse, err error)

DescribeRegionConf This API is used to query the purchasable subscription instance regions.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) DescribeSubscribeConf 

func (c *Client) DescribeSubscribeConf(request *DescribeSubscribeConfRequest) (response *DescribeSubscribeConfResponse, err error)

DescribeSubscribeConf This API is used to query the subscription instance configuration.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUE = "InvalidParameterValue.InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"
RESOURCENOTFOUND_RESOURCENOTFOUND = "ResourceNotFound.ResourceNotFound"

func (*Client) DescribeSubscribeConfWithContext 

func (c *Client) DescribeSubscribeConfWithContext(ctx context.Context, request *DescribeSubscribeConfRequest) (response *DescribeSubscribeConfResponse, err error)

DescribeSubscribeConf This API is used to query the subscription instance configuration.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETERVALUE_INVALIDPARAMETERVALUE = "InvalidParameterValue.InvalidParameterValue"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"
RESOURCENOTFOUND_RESOURCENOTFOUND = "ResourceNotFound.ResourceNotFound"

func (*Client) DescribeSubscribes 

func (c *Client) DescribeSubscribes(request *DescribeSubscribesRequest) (response *DescribeSubscribesResponse, err error)

DescribeSubscribes This API is used to get the information list of data subscription instances. Pagination is enabled by default with 20 results returned each time.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) DescribeSubscribesWithContext 

func (c *Client) DescribeSubscribesWithContext(ctx context.Context, request *DescribeSubscribesRequest) (response *DescribeSubscribesResponse, err error)

DescribeSubscribes This API is used to get the information list of data subscription instances. Pagination is enabled by default with 20 results returned each time.

error code that may be returned: 

AUTHFAILURE_UNAUTHORIZEDOPERATIONERROR = "AuthFailure.UnauthorizedOperationError"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"

func (*Client) IsolateSubscribe 

func (c *Client) IsolateSubscribe(request *IsolateSubscribeRequest) (response *IsolateSubscribeResponse, err error)

IsolateSubscribe This API is used to isolate an hourly billed subscription instance. After this API is called, the instance will become unavailable and billing will stop for it.

error code that may be returned: 

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BIZINVALIDPARAMETERVALUEERROR = "InvalidParameter.BizInvalidParameterValueError"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) IsolateSubscribeWithContext 

func (c *Client) IsolateSubscribeWithContext(ctx context.Context, request *IsolateSubscribeRequest) (response *IsolateSubscribeResponse, err error)

IsolateSubscribe This API is used to isolate an hourly billed subscription instance. After this API is called, the instance will become unavailable and billing will stop for it.

error code that may be returned: 

INVALIDPARAMETER = "InvalidParameter"
INVALIDPARAMETER_BIZINVALIDPARAMETERVALUEERROR = "InvalidParameter.BizInvalidParameterValueError"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"
UNSUPPORTEDOPERATION = "UnsupportedOperation"

func (*Client) ModifyMigrateJob 

func (c *Client) ModifyMigrateJob(request *ModifyMigrateJobRequest) (response *ModifyMigrateJobResponse, err error)

ModifyMigrateJob This API (ModifyMigrateJob) is used to modify a data migration task.

If the status of a migration task is creating (status=1), check succeeded (status=4), check failed (status=5), or migration failed (status=10), this API can be called to modify the task, but the type of the source and target instances and the region of the target instance cannot be modified.

For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) ModifyMigrateJobWithContext 

func (c *Client) ModifyMigrateJobWithContext(ctx context.Context, request *ModifyMigrateJobRequest) (response *ModifyMigrateJobResponse, err error)

ModifyMigrateJob This API (ModifyMigrateJob) is used to modify a data migration task.

If the status of a migration task is creating (status=1), check succeeded (status=4), check failed (status=5), or migration failed (status=10), this API can be called to modify the task, but the type of the source and target instances and the region of the target instance cannot be modified.

For a finance zone linkage, please use the domain name dts.ap-shenzhen-fsi.tencentcloudapi.com.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) ModifySubscribeConsumeTime 

func (c *Client) ModifySubscribeConsumeTime(request *ModifySubscribeConsumeTimeRequest) (response *ModifySubscribeConsumeTimeResponse, err error)

ModifySubscribeConsumeTime This API is used to modify the consumption time point of a data subscription channel.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ModifySubscribeConsumeTimeWithContext 

func (c *Client) ModifySubscribeConsumeTimeWithContext(ctx context.Context, request *ModifySubscribeConsumeTimeRequest) (response *ModifySubscribeConsumeTimeResponse, err error)

ModifySubscribeConsumeTime This API is used to modify the consumption time point of a data subscription channel.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ModifySubscribeName 

func (c *Client) ModifySubscribeName(request *ModifySubscribeNameRequest) (response *ModifySubscribeNameResponse, err error)

ModifySubscribeName This API is used to rename a data subscription instance.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ModifySubscribeNameWithContext 

func (c *Client) ModifySubscribeNameWithContext(ctx context.Context, request *ModifySubscribeNameRequest) (response *ModifySubscribeNameResponse, err error)

ModifySubscribeName This API is used to rename a data subscription instance.

error code that may be returned: 

INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ModifySubscribeObjects 

func (c *Client) ModifySubscribeObjects(request *ModifySubscribeObjectsRequest) (response *ModifySubscribeObjectsResponse, err error)

ModifySubscribeObjects This API is used to modify the subscription rule of a data subscription channel.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"

func (*Client) ModifySubscribeObjectsWithContext 

func (c *Client) ModifySubscribeObjectsWithContext(ctx context.Context, request *ModifySubscribeObjectsRequest) (response *ModifySubscribeObjectsResponse, err error)

ModifySubscribeObjects This API is used to modify the subscription rule of a data subscription channel.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"
RESOURCENOTFOUND_BIZRESOURCENOTFOUNDERROR = "ResourceNotFound.BizResourceNotFoundError"

func (*Client) ModifySubscribeVipVport 

func (c *Client) ModifySubscribeVipVport(request *ModifySubscribeVipVportRequest) (response *ModifySubscribeVipVportResponse, err error)

ModifySubscribeVipVport This API is used to modify the IP and port number of a data subscription instance.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ModifySubscribeVipVportWithContext 

func (c *Client) ModifySubscribeVipVportWithContext(ctx context.Context, request *ModifySubscribeVipVportRequest) (response *ModifySubscribeVipVportResponse, err error)

ModifySubscribeVipVport This API is used to modify the IP and port number of a data subscription instance.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) OfflineIsolatedSubscribe 

func (c *Client) OfflineIsolatedSubscribe(request *OfflineIsolatedSubscribeRequest) (response *OfflineIsolatedSubscribeResponse, err error)

OfflineIsolatedSubscribe This API is used to deactivate an isolated data subscription instance.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) OfflineIsolatedSubscribeWithContext 

func (c *Client) OfflineIsolatedSubscribeWithContext(ctx context.Context, request *OfflineIsolatedSubscribeRequest) (response *OfflineIsolatedSubscribeResponse, err error)

OfflineIsolatedSubscribe This API is used to deactivate an isolated data subscription instance.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ResetSubscribe 

func (c *Client) ResetSubscribe(request *ResetSubscribeRequest) (response *ResetSubscribeResponse, err error)

ResetSubscribe This API is used to reset a data subscription instance. Once reset, an activated instance can be bound to other database instances through the `ActivateSubscribe` API.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) ResetSubscribeWithContext 

func (c *Client) ResetSubscribeWithContext(ctx context.Context, request *ResetSubscribeRequest) (response *ResetSubscribeResponse, err error)

ResetSubscribe This API is used to reset a data subscription instance. Once reset, an activated instance can be bound to other database instances through the `ActivateSubscribe` API.

error code that may be returned: 

FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR = "InternalError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND = "ResourceNotFound"

func (*Client) StartMigrateJob 

func (c *Client) StartMigrateJob(request *StartMigrateJobRequest) (response *StartMigrateJobResponse, err error)

StartMigrateJob This API (StartMigrationJob) is used to start a migration task. After the API is called, non-scheduled migration tasks will start the migration immediately, while scheduled tasks will start the countdown.

Before calling this API, be sure to use the CreateMigrateCheckJob API to check the data migration task, which can be started only if its status queried through the DescribeMigrateJobs API is check succeeded (status=4).

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STARTJOBFAILED = "FailedOperation.StartJobFailed"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR_ADDTASKERROR = "InternalError.AddTaskError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_LOCKERROR = "InternalError.LockError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"
OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) StartMigrateJobWithContext 

func (c *Client) StartMigrateJobWithContext(ctx context.Context, request *StartMigrateJobRequest) (response *StartMigrateJobResponse, err error)

StartMigrateJob This API (StartMigrationJob) is used to start a migration task. After the API is called, non-scheduled migration tasks will start the migration immediately, while scheduled tasks will start the countdown.

Before calling this API, be sure to use the CreateMigrateCheckJob API to check the data migration task, which can be started only if its status queried through the DescribeMigrateJobs API is check succeeded (status=4).

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STARTJOBFAILED = "FailedOperation.StartJobFailed"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR_ADDTASKERROR = "InternalError.AddTaskError"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_LOCKERROR = "InternalError.LockError"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
LIMITEXCEEDED_MAXUNUSEDJOBS = "LimitExceeded.MaxUnusedJobs"
OPERATIONDENIED_BIZOPERATIONDENIEDERROR = "OperationDenied.BizOperationDeniedError"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) StopMigrateJob 

func (c *Client) StopMigrateJob(request *StopMigrateJobRequest) (response *StopMigrateJobResponse, err error)

StopMigrateJob This API (StopMigrateJob) is used to cancel a data migration task.

During migration, this API can be used to cancel migration if the task status queried through the DescribeMigrateJobs API is running (status=7) or ready (status=8), and the migration task will fail.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

func (*Client) StopMigrateJobWithContext 

func (c *Client) StopMigrateJobWithContext(ctx context.Context, request *StopMigrateJobRequest) (response *StopMigrateJobResponse, err error)

StopMigrateJob This API (StopMigrateJob) is used to cancel a data migration task.

During migration, this API can be used to cancel migration if the task status queried through the DescribeMigrateJobs API is running (status=7) or ready (status=8), and the migration task will fail.

error code that may be returned: 

FAILEDOPERATION_NOTALLOWOPERATION = "FailedOperation.NotAllowOperation"
FAILEDOPERATION_STATUSINCONFLICT = "FailedOperation.StatusInConflict"
INTERNALERROR_DATABASEERROR = "InternalError.DatabaseError"
INTERNALERROR_DUPLICATEJOB = "InternalError.DuplicateJob"
INTERNALERROR_PROTOCOLERROR = "InternalError.ProtocolError"
INTERNALERROR_UNKNOWNERROR = "InternalError.UnknownError"
INVALIDPARAMETER = "InvalidParameter"
OPERATIONDENIED_JOBOPERATIONDENIEDERROR = "OperationDenied.JobOperationDeniedError"
RESOURCENOTFOUND_JOBNOTEXIST = "ResourceNotFound.JobNotExist"
UNAUTHORIZEDOPERATION_NOTENOUGHPRIVILEGES = "UnauthorizedOperation.NotEnoughPrivileges"

type CompleteMigrateJobRequest 

type CompleteMigrateJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// The way to complete the task, which is supported only for legacy MySQL migration task. waitForSync: wait for the source-replica lag to become 0 before stopping; immediately: complete immediately without waiting for source-replica sync. Default value: waitForSync
	CompleteMode *string `json:"CompleteMode,omitnil,omitempty" name:"CompleteMode"`
}

func NewCompleteMigrateJobRequest 

func NewCompleteMigrateJobRequest() (request *CompleteMigrateJobRequest)

func (*CompleteMigrateJobRequest) FromJsonString 

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

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

func (*CompleteMigrateJobRequest) ToJsonString 

func (r *CompleteMigrateJobRequest) ToJsonString() string

type CompleteMigrateJobRequestParams 

type CompleteMigrateJobRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// The way to complete the task, which is supported only for legacy MySQL migration task. waitForSync: wait for the source-replica lag to become 0 before stopping; immediately: complete immediately without waiting for source-replica sync. Default value: waitForSync
	CompleteMode *string `json:"CompleteMode,omitnil,omitempty" name:"CompleteMode"`
}

Predefined struct for user

type CompleteMigrateJobResponse 

type CompleteMigrateJobResponse struct {
	*tchttp.BaseResponse
	Response *CompleteMigrateJobResponseParams `json:"Response"`
}

func NewCompleteMigrateJobResponse 

func NewCompleteMigrateJobResponse() (response *CompleteMigrateJobResponse)

func (*CompleteMigrateJobResponse) FromJsonString 

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

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

func (*CompleteMigrateJobResponse) ToJsonString 

func (r *CompleteMigrateJobResponse) ToJsonString() string

type CompleteMigrateJobResponseParams 

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

Predefined struct for user

type ConsistencyParams 

type ConsistencyParams struct {
	// Data content check parameter, which refers to the proportion of the rows selected for data comparison in all the rows of the table. Value: an integer between 1 and 100.
	SelectRowsPerTable *int64 `json:"SelectRowsPerTable,omitnil,omitempty" name:"SelectRowsPerTable"`

	// Data content check parameter, which refers to the proportion of the tables selected for data detection in all the tables. Value: an integer between 1 and 100.
	TablesSelectAll *int64 `json:"TablesSelectAll,omitnil,omitempty" name:"TablesSelectAll"`

	// Data quantity check parameter, which checks whether the numbers of rows are identical. It refers to the proportion of the tables selected for quantity check in all the tables. Value: an integer between 1 and 100.
	TablesSelectCount *int64 `json:"TablesSelectCount,omitnil,omitempty" name:"TablesSelectCount"`
}

type CreateMigrateCheckJobRequest 

type CreateMigrateCheckJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

func NewCreateMigrateCheckJobRequest 

func NewCreateMigrateCheckJobRequest() (request *CreateMigrateCheckJobRequest)

func (*CreateMigrateCheckJobRequest) FromJsonString 

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

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

func (*CreateMigrateCheckJobRequest) ToJsonString 

func (r *CreateMigrateCheckJobRequest) ToJsonString() string

type CreateMigrateCheckJobRequestParams 

type CreateMigrateCheckJobRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

Predefined struct for user

type CreateMigrateCheckJobResponse 

type CreateMigrateCheckJobResponse struct {
	*tchttp.BaseResponse
	Response *CreateMigrateCheckJobResponseParams `json:"Response"`
}

func NewCreateMigrateCheckJobResponse 

func NewCreateMigrateCheckJobResponse() (response *CreateMigrateCheckJobResponse)

func (*CreateMigrateCheckJobResponse) FromJsonString 

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

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

func (*CreateMigrateCheckJobResponse) ToJsonString 

func (r *CreateMigrateCheckJobResponse) ToJsonString() string

type CreateMigrateCheckJobResponseParams 

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

Predefined struct for user

type CreateMigrateJobRequest 

type CreateMigrateJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Migration task configuration options
	MigrateOption *MigrateOption `json:"MigrateOption,omitnil,omitempty" name:"MigrateOption"`

	// Source instance database type, which currently supports MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona, and SQL Server. For more information on the supported types in a specific region, see the migration task creation page in the console.
	SrcDatabaseType *string `json:"SrcDatabaseType,omitnil,omitempty" name:"SrcDatabaseType"`

	// Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance), ccn (CCN instance)
	SrcAccessType *string `json:"SrcAccessType,omitnil,omitempty" name:"SrcAccessType"`

	// Source instance information, which is correlated with the migration task type
	SrcInfo *SrcInfo `json:"SrcInfo,omitnil,omitempty" name:"SrcInfo"`

	// Target instance access type, which currently supports MySQL, Redis, MongoDB, PostgreSQL, MariaDB, and Percona, SQL Server, and TDSQL-C for MySQL. For more information on the supported types in a specific region, see the migration task creation page in the console.
	DstDatabaseType *string `json:"DstDatabaseType,omitnil,omitempty" name:"DstDatabaseType"`

	// Target instance access type, which currently only supports cdb (TencentDB instance)
	DstAccessType *string `json:"DstAccessType,omitnil,omitempty" name:"DstAccessType"`

	// Destination instance information
	DstInfo *DstInfo `json:"DstInfo,omitnil,omitempty" name:"DstInfo"`

	// Information of the source table to be migrated, which is described in JSON string format. It is required if MigrateOption.MigrateObject is 2 (migrating the specified table).
	// For databases with a database-table structure:
	// [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
	// For databases with a database-schema-table structure:
	// [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
	DatabaseInfo *string `json:"DatabaseInfo,omitnil,omitempty" name:"DatabaseInfo"`

	// Tag of the instance to be migrated.
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Source instance type. `simple`: Primary/Secondary node; `cluster`: Cluster node. If this field is left empty, the value defaults to primary/secondary node.
	SrcNodeType *string `json:"SrcNodeType,omitnil,omitempty" name:"SrcNodeType"`

	// Source instance information, which is correlated with the migration task type.
	SrcInfoMulti []*SrcInfo `json:"SrcInfoMulti,omitnil,omitempty" name:"SrcInfoMulti"`
}

func NewCreateMigrateJobRequest 

func NewCreateMigrateJobRequest() (request *CreateMigrateJobRequest)

func (*CreateMigrateJobRequest) FromJsonString 

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

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

func (*CreateMigrateJobRequest) ToJsonString 

func (r *CreateMigrateJobRequest) ToJsonString() string

type CreateMigrateJobRequestParams 

type CreateMigrateJobRequestParams struct {
	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Migration task configuration options
	MigrateOption *MigrateOption `json:"MigrateOption,omitnil,omitempty" name:"MigrateOption"`

	// Source instance database type, which currently supports MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona, and SQL Server. For more information on the supported types in a specific region, see the migration task creation page in the console.
	SrcDatabaseType *string `json:"SrcDatabaseType,omitnil,omitempty" name:"SrcDatabaseType"`

	// Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance), ccn (CCN instance)
	SrcAccessType *string `json:"SrcAccessType,omitnil,omitempty" name:"SrcAccessType"`

	// Source instance information, which is correlated with the migration task type
	SrcInfo *SrcInfo `json:"SrcInfo,omitnil,omitempty" name:"SrcInfo"`

	// Target instance access type, which currently supports MySQL, Redis, MongoDB, PostgreSQL, MariaDB, and Percona, SQL Server, and TDSQL-C for MySQL. For more information on the supported types in a specific region, see the migration task creation page in the console.
	DstDatabaseType *string `json:"DstDatabaseType,omitnil,omitempty" name:"DstDatabaseType"`

	// Target instance access type, which currently only supports cdb (TencentDB instance)
	DstAccessType *string `json:"DstAccessType,omitnil,omitempty" name:"DstAccessType"`

	// Destination instance information
	DstInfo *DstInfo `json:"DstInfo,omitnil,omitempty" name:"DstInfo"`

	// Information of the source table to be migrated, which is described in JSON string format. It is required if MigrateOption.MigrateObject is 2 (migrating the specified table).
	// For databases with a database-table structure:
	// [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
	// For databases with a database-schema-table structure:
	// [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
	DatabaseInfo *string `json:"DatabaseInfo,omitnil,omitempty" name:"DatabaseInfo"`

	// Tag of the instance to be migrated.
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Source instance type. `simple`: Primary/Secondary node; `cluster`: Cluster node. If this field is left empty, the value defaults to primary/secondary node.
	SrcNodeType *string `json:"SrcNodeType,omitnil,omitempty" name:"SrcNodeType"`

	// Source instance information, which is correlated with the migration task type.
	SrcInfoMulti []*SrcInfo `json:"SrcInfoMulti,omitnil,omitempty" name:"SrcInfoMulti"`
}

Predefined struct for user

type CreateMigrateJobResponse 

type CreateMigrateJobResponse struct {
	*tchttp.BaseResponse
	Response *CreateMigrateJobResponseParams `json:"Response"`
}

func NewCreateMigrateJobResponse 

func NewCreateMigrateJobResponse() (response *CreateMigrateJobResponse)

func (*CreateMigrateJobResponse) FromJsonString 

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

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

func (*CreateMigrateJobResponse) ToJsonString 

func (r *CreateMigrateJobResponse) ToJsonString() string

type CreateMigrateJobResponseParams 

type CreateMigrateJobResponseParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

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

Predefined struct for user

type CreateSubscribeRequest 

type CreateSubscribeRequest struct {
	*tchttp.BaseRequest

	// Subscribed database type. Currently, MySQL is supported
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// Instance billing mode, which is always 1 (hourly billing),
	PayType *int64 `json:"PayType,omitnil,omitempty" name:"PayType"`

	// Purchase duration in months, which is required if `PayType` is 0. Maximum value: 120 (this field is not required of global site users and is better to be hidden)
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// Quantity. Default value: 1. Maximum value: 10
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`

	// Whether to auto-renew. Default value: 0. This flag does not take effect for hourly billed instances (this field should be hidden from global site users)
	AutoRenew *int64 `json:"AutoRenew,omitnil,omitempty" name:"AutoRenew"`

	// Instance resource tags
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// A custom instance name.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

func NewCreateSubscribeRequest 

func NewCreateSubscribeRequest() (request *CreateSubscribeRequest)

func (*CreateSubscribeRequest) FromJsonString 

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

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

func (*CreateSubscribeRequest) ToJsonString 

func (r *CreateSubscribeRequest) ToJsonString() string

type CreateSubscribeRequestParams 

type CreateSubscribeRequestParams struct {
	// Subscribed database type. Currently, MySQL is supported
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// Instance billing mode, which is always 1 (hourly billing),
	PayType *int64 `json:"PayType,omitnil,omitempty" name:"PayType"`

	// Purchase duration in months, which is required if `PayType` is 0. Maximum value: 120 (this field is not required of global site users and is better to be hidden)
	Duration *int64 `json:"Duration,omitnil,omitempty" name:"Duration"`

	// Quantity. Default value: 1. Maximum value: 10
	Count *int64 `json:"Count,omitnil,omitempty" name:"Count"`

	// Whether to auto-renew. Default value: 0. This flag does not take effect for hourly billed instances (this field should be hidden from global site users)
	AutoRenew *int64 `json:"AutoRenew,omitnil,omitempty" name:"AutoRenew"`

	// Instance resource tags
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// A custom instance name.
	Name *string `json:"Name,omitnil,omitempty" name:"Name"`
}

Predefined struct for user

type CreateSubscribeResponse 

type CreateSubscribeResponse struct {
	*tchttp.BaseResponse
	Response *CreateSubscribeResponseParams `json:"Response"`
}

func NewCreateSubscribeResponse 

func NewCreateSubscribeResponse() (response *CreateSubscribeResponse)

func (*CreateSubscribeResponse) FromJsonString 

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

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

func (*CreateSubscribeResponse) ToJsonString 

func (r *CreateSubscribeResponse) ToJsonString() string

type CreateSubscribeResponseParams 

type CreateSubscribeResponseParams struct {
	// Data subscription instance ID array
	// Note: this field may return null, indicating that no valid values can be obtained.
	SubscribeIds []*string `json:"SubscribeIds,omitnil,omitempty" name:"SubscribeIds"`

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

Predefined struct for user

type DeleteMigrateJobRequest 

type DeleteMigrateJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

func NewDeleteMigrateJobRequest 

func NewDeleteMigrateJobRequest() (request *DeleteMigrateJobRequest)

func (*DeleteMigrateJobRequest) FromJsonString 

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

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

func (*DeleteMigrateJobRequest) ToJsonString 

func (r *DeleteMigrateJobRequest) ToJsonString() string

type DeleteMigrateJobRequestParams 

type DeleteMigrateJobRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

Predefined struct for user

type DeleteMigrateJobResponse 

type DeleteMigrateJobResponse struct {
	*tchttp.BaseResponse
	Response *DeleteMigrateJobResponseParams `json:"Response"`
}

func NewDeleteMigrateJobResponse 

func NewDeleteMigrateJobResponse() (response *DeleteMigrateJobResponse)

func (*DeleteMigrateJobResponse) FromJsonString 

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

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

func (*DeleteMigrateJobResponse) ToJsonString 

func (r *DeleteMigrateJobResponse) ToJsonString() string

type DeleteMigrateJobResponseParams 

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

Predefined struct for user

type DescribeAsyncRequestInfoRequest 

type DescribeAsyncRequestInfoRequest struct {
	*tchttp.BaseRequest

	// Task ID
	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 {
	// Task ID
	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 {
	// Task execution result information
	Info *string `json:"Info,omitnil,omitempty" name:"Info"`

	// Task execution status. Valid values: success, failed, running
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

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

Predefined struct for user

type DescribeMigrateCheckJobRequest 

type DescribeMigrateCheckJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

func NewDescribeMigrateCheckJobRequest 

func NewDescribeMigrateCheckJobRequest() (request *DescribeMigrateCheckJobRequest)

func (*DescribeMigrateCheckJobRequest) FromJsonString 

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

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

func (*DescribeMigrateCheckJobRequest) ToJsonString 

func (r *DescribeMigrateCheckJobRequest) ToJsonString() string

type DescribeMigrateCheckJobRequestParams 

type DescribeMigrateCheckJobRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

Predefined struct for user

type DescribeMigrateCheckJobResponse 

type DescribeMigrateCheckJobResponse struct {
	*tchttp.BaseResponse
	Response *DescribeMigrateCheckJobResponseParams `json:"Response"`
}

func NewDescribeMigrateCheckJobResponse 

func NewDescribeMigrateCheckJobResponse() (response *DescribeMigrateCheckJobResponse)

func (*DescribeMigrateCheckJobResponse) FromJsonString 

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

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

func (*DescribeMigrateCheckJobResponse) ToJsonString 

func (r *DescribeMigrateCheckJobResponse) ToJsonString() string

type DescribeMigrateCheckJobResponseParams 

type DescribeMigrateCheckJobResponseParams struct {
	// Check task status: unavailable, starting, running, finished
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Task error code
	ErrorCode *int64 `json:"ErrorCode,omitnil,omitempty" name:"ErrorCode"`

	// Task error message
	ErrorMessage *string `json:"ErrorMessage,omitnil,omitempty" name:"ErrorMessage"`

	// Check task progress. For example, "30" means 30% completed
	Progress *string `json:"Progress,omitnil,omitempty" name:"Progress"`

	// Whether the check succeeds. 0: no; 1: yes; 3: not checked
	CheckFlag *int64 `json:"CheckFlag,omitnil,omitempty" name:"CheckFlag"`

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

Predefined struct for user

type DescribeMigrateJobsRequest 

type DescribeMigrateJobsRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Sort by field. Value range: JobId, Status, JobName, MigrateType, RunMode, CreateTime
	Order *string `json:"Order,omitnil,omitempty" name:"Order"`

	// Sorting order. Value range: ASC (ascending), DESC (descending)
	OrderSeq *string `json:"OrderSeq,omitnil,omitempty" name:"OrderSeq"`

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

	// Number of the returned instances. Value range: [1, 100]. Default value: 20
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

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

func NewDescribeMigrateJobsRequest 

func NewDescribeMigrateJobsRequest() (request *DescribeMigrateJobsRequest)

func (*DescribeMigrateJobsRequest) FromJsonString 

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

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

func (*DescribeMigrateJobsRequest) ToJsonString 

func (r *DescribeMigrateJobsRequest) ToJsonString() string

type DescribeMigrateJobsRequestParams 

type DescribeMigrateJobsRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Sort by field. Value range: JobId, Status, JobName, MigrateType, RunMode, CreateTime
	Order *string `json:"Order,omitnil,omitempty" name:"Order"`

	// Sorting order. Value range: ASC (ascending), DESC (descending)
	OrderSeq *string `json:"OrderSeq,omitnil,omitempty" name:"OrderSeq"`

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

	// Number of the returned instances. Value range: [1, 100]. Default value: 20
	Limit *uint64 `json:"Limit,omitnil,omitempty" name:"Limit"`

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

Predefined struct for user

type DescribeMigrateJobsResponse 

type DescribeMigrateJobsResponse struct {
	*tchttp.BaseResponse
	Response *DescribeMigrateJobsResponseParams `json:"Response"`
}

func NewDescribeMigrateJobsResponse 

func NewDescribeMigrateJobsResponse() (response *DescribeMigrateJobsResponse)

func (*DescribeMigrateJobsResponse) FromJsonString 

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

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

func (*DescribeMigrateJobsResponse) ToJsonString 

func (r *DescribeMigrateJobsResponse) ToJsonString() string

type DescribeMigrateJobsResponseParams 

type DescribeMigrateJobsResponseParams struct {
	// Number of tasks
	TotalCount *uint64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// Array of task details
	JobList []*MigrateJobInfo `json:"JobList,omitnil,omitempty" name:"JobList"`

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

Predefined struct for user

type DescribeRegionConfRequest 

type DescribeRegionConfRequest struct {
	*tchttp.BaseRequest
}

func NewDescribeRegionConfRequest 

func NewDescribeRegionConfRequest() (request *DescribeRegionConfRequest)

func (*DescribeRegionConfRequest) FromJsonString 

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

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

func (*DescribeRegionConfRequest) ToJsonString 

func (r *DescribeRegionConfRequest) ToJsonString() string

type DescribeRegionConfRequestParams 

type DescribeRegionConfRequestParams struct {
}

Predefined struct for user

type DescribeRegionConfResponse 

type DescribeRegionConfResponse struct {
	*tchttp.BaseResponse
	Response *DescribeRegionConfResponseParams `json:"Response"`
}

func NewDescribeRegionConfResponse 

func NewDescribeRegionConfResponse() (response *DescribeRegionConfResponse)

func (*DescribeRegionConfResponse) FromJsonString 

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

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

func (*DescribeRegionConfResponse) ToJsonString 

func (r *DescribeRegionConfResponse) ToJsonString() string

type DescribeRegionConfResponseParams 

type DescribeRegionConfResponseParams struct {
	// Number of purchasable regions
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// Purchasable region details
	Items []*SubscribeRegionConf `json:"Items,omitnil,omitempty" name:"Items"`

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

Predefined struct for user

type DescribeSubscribeConfRequest 

type DescribeSubscribeConfRequest struct {
	*tchttp.BaseRequest

	// Subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

func NewDescribeSubscribeConfRequest 

func NewDescribeSubscribeConfRequest() (request *DescribeSubscribeConfRequest)

func (*DescribeSubscribeConfRequest) FromJsonString 

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

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

func (*DescribeSubscribeConfRequest) ToJsonString 

func (r *DescribeSubscribeConfRequest) ToJsonString() string

type DescribeSubscribeConfRequestParams 

type DescribeSubscribeConfRequestParams struct {
	// Subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

Predefined struct for user

type DescribeSubscribeConfResponse 

type DescribeSubscribeConfResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSubscribeConfResponseParams `json:"Response"`
}

func NewDescribeSubscribeConfResponse 

func NewDescribeSubscribeConfResponse() (response *DescribeSubscribeConfResponse)

func (*DescribeSubscribeConfResponse) FromJsonString 

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

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

func (*DescribeSubscribeConfResponse) ToJsonString 

func (r *DescribeSubscribeConfResponse) ToJsonString() string

type DescribeSubscribeConfResponseParams 

type DescribeSubscribeConfResponseParams struct {
	// Subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Subscription instance name
	SubscribeName *string `json:"SubscribeName,omitnil,omitempty" name:"SubscribeName"`

	// Subscription channel
	ChannelId *string `json:"ChannelId,omitnil,omitempty" name:"ChannelId"`

	// Subscribed database type
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// Subscribed instance
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Subscribed instance status. Valid values: running, offline, isolate
	InstanceStatus *string `json:"InstanceStatus,omitnil,omitempty" name:"InstanceStatus"`

	// Subscription instance status. Valid values: unconfigure, configuring, configured
	SubsStatus *string `json:"SubsStatus,omitnil,omitempty" name:"SubsStatus"`

	// Subscription instance lifecycle status. Valid values: normal, isolating, isolated, offlining
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Subscription instance creation time
	CreateTime *string `json:"CreateTime,omitnil,omitempty" name:"CreateTime"`

	// Subscription instance isolation time
	IsolateTime *string `json:"IsolateTime,omitnil,omitempty" name:"IsolateTime"`

	// Subscription instance expiration time
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// Subscription instance deactivation time
	OfflineTime *string `json:"OfflineTime,omitnil,omitempty" name:"OfflineTime"`

	// Consumption starting time point of subscription instance
	ConsumeStartTime *string `json:"ConsumeStartTime,omitnil,omitempty" name:"ConsumeStartTime"`

	// Subscription instance billing mode. 1: hourly billing
	PayType *int64 `json:"PayType,omitnil,omitempty" name:"PayType"`

	// Subscription channel VIP
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

	// Subscription channel port
	Vport *int64 `json:"Vport,omitnil,omitempty" name:"Vport"`

	// Subscription channel `VpcId`
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// Subscription channel `SubnetId`
	UniqSubnetId *string `json:"UniqSubnetId,omitnil,omitempty" name:"UniqSubnetId"`

	// Current SDK consumption time point
	SdkConsumedTime *string `json:"SdkConsumedTime,omitnil,omitempty" name:"SdkConsumedTime"`

	// Subscription SDK IP address
	SdkHost *string `json:"SdkHost,omitnil,omitempty" name:"SdkHost"`

	// Subscription object type. 0: full instance subscription, 1: DDL data subscription, 2: DML structure subscription, 3: DDL data subscription + DML structure subscription
	SubscribeObjectType *int64 `json:"SubscribeObjectType,omitnil,omitempty" name:"SubscribeObjectType"`

	// Subscription object, which is an empty array if `SubscribeObjectType` is 0
	SubscribeObjects []*SubscribeObject `json:"SubscribeObjects,omitnil,omitempty" name:"SubscribeObjects"`

	// Modification time
	ModifyTime *string `json:"ModifyTime,omitnil,omitempty" name:"ModifyTime"`

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

	// Tags of the subscription
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Whether auto-renewal is enabled. 0: do not enable, 1: enable
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// Data subscription edition. `txdts`: Legacy edition; `kafka`: Kafka edition.
	SubscribeVersion *string `json:"SubscribeVersion,omitnil,omitempty" name:"SubscribeVersion"`

	// Error message.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Errors []*SubsErr `json:"Errors,omitnil,omitempty" name:"Errors"`

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

Predefined struct for user

type DescribeSubscribesRequest 

type DescribeSubscribesRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription instance name
	SubscribeName *string `json:"SubscribeName,omitnil,omitempty" name:"SubscribeName"`

	// ID of bound database instance
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Data subscription instance channel ID
	ChannelId *string `json:"ChannelId,omitnil,omitempty" name:"ChannelId"`

	// Billing mode filter. Default value: 1 (pay-as-you-go)
	PayType *string `json:"PayType,omitnil,omitempty" name:"PayType"`

	// Subscribed database product, such as MySQL
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// Data subscription instance status. Valid values: creating, normal, isolating, isolated, offlining
	Status []*string `json:"Status,omitnil,omitempty" name:"Status"`

	// Data subscription instance configuration status. Valid values: unconfigure, configuring, configured
	SubsStatus []*string `json:"SubsStatus,omitnil,omitempty" name:"SubsStatus"`

	// Starting offset of returned results
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Number of results to be returned at a time
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Sorting order. Valid values: DESC, ASC. Default value: DESC, indicating descending by creation time
	OrderDirection *string `json:"OrderDirection,omitnil,omitempty" name:"OrderDirection"`

	// Tag filtering condition
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// Subscription instance edition. `txdts`: legacy data subscription; `kafka`: data subscription in Kafka edition
	SubscribeVersion *string `json:"SubscribeVersion,omitnil,omitempty" name:"SubscribeVersion"`
}

func NewDescribeSubscribesRequest 

func NewDescribeSubscribesRequest() (request *DescribeSubscribesRequest)

func (*DescribeSubscribesRequest) FromJsonString 

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

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

func (*DescribeSubscribesRequest) ToJsonString 

func (r *DescribeSubscribesRequest) ToJsonString() string

type DescribeSubscribesRequestParams 

type DescribeSubscribesRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription instance name
	SubscribeName *string `json:"SubscribeName,omitnil,omitempty" name:"SubscribeName"`

	// ID of bound database instance
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Data subscription instance channel ID
	ChannelId *string `json:"ChannelId,omitnil,omitempty" name:"ChannelId"`

	// Billing mode filter. Default value: 1 (pay-as-you-go)
	PayType *string `json:"PayType,omitnil,omitempty" name:"PayType"`

	// Subscribed database product, such as MySQL
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// Data subscription instance status. Valid values: creating, normal, isolating, isolated, offlining
	Status []*string `json:"Status,omitnil,omitempty" name:"Status"`

	// Data subscription instance configuration status. Valid values: unconfigure, configuring, configured
	SubsStatus []*string `json:"SubsStatus,omitnil,omitempty" name:"SubsStatus"`

	// Starting offset of returned results
	Offset *int64 `json:"Offset,omitnil,omitempty" name:"Offset"`

	// Number of results to be returned at a time
	Limit *int64 `json:"Limit,omitnil,omitempty" name:"Limit"`

	// Sorting order. Valid values: DESC, ASC. Default value: DESC, indicating descending by creation time
	OrderDirection *string `json:"OrderDirection,omitnil,omitempty" name:"OrderDirection"`

	// Tag filtering condition
	TagFilters []*TagFilter `json:"TagFilters,omitnil,omitempty" name:"TagFilters"`

	// Subscription instance edition. `txdts`: legacy data subscription; `kafka`: data subscription in Kafka edition
	SubscribeVersion *string `json:"SubscribeVersion,omitnil,omitempty" name:"SubscribeVersion"`
}

Predefined struct for user

type DescribeSubscribesResponse 

type DescribeSubscribesResponse struct {
	*tchttp.BaseResponse
	Response *DescribeSubscribesResponseParams `json:"Response"`
}

func NewDescribeSubscribesResponse 

func NewDescribeSubscribesResponse() (response *DescribeSubscribesResponse)

func (*DescribeSubscribesResponse) FromJsonString 

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

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

func (*DescribeSubscribesResponse) ToJsonString 

func (r *DescribeSubscribesResponse) ToJsonString() string

type DescribeSubscribesResponseParams 

type DescribeSubscribesResponseParams struct {
	// Number of eligible instances.
	TotalCount *int64 `json:"TotalCount,omitnil,omitempty" name:"TotalCount"`

	// Information list of data subscription instances
	Items []*SubscribeInfo `json:"Items,omitnil,omitempty" name:"Items"`

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

Predefined struct for user

type DstInfo 

type DstInfo struct {
	// Target instance ID, such as cdb-jd92ijd8
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Target instance region, such as ap-guangzhou
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// Target instance VIP, which has been disused and does not need to be entered
	Ip *string `json:"Ip,omitnil,omitempty" name:"Ip"`

	// Target instance Vport, which has been disused and does not need to be entered
	Port *int64 `json:"Port,omitnil,omitempty" name:"Port"`

	// Only valid for MySQL currently. For instance-level migration, the value range is: 1 (read-only), 0 (read/write)
	ReadOnly *int64 `json:"ReadOnly,omitnil,omitempty" name:"ReadOnly"`

	// Target database account
	User *string `json:"User,omitnil,omitempty" name:"User"`

	// Target database password
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`
}

type ErrorInfo 

type ErrorInfo struct {
	// Specific error log, including error code and error message
	ErrorLog *string `json:"ErrorLog,omitnil,omitempty" name:"ErrorLog"`

	// Help document URL corresponding to error
	HelpDoc *string `json:"HelpDoc,omitnil,omitempty" name:"HelpDoc"`
}

type IsolateSubscribeRequest 

type IsolateSubscribeRequest struct {
	*tchttp.BaseRequest

	// Subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

func NewIsolateSubscribeRequest 

func NewIsolateSubscribeRequest() (request *IsolateSubscribeRequest)

func (*IsolateSubscribeRequest) FromJsonString 

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

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

func (*IsolateSubscribeRequest) ToJsonString 

func (r *IsolateSubscribeRequest) ToJsonString() string

type IsolateSubscribeRequestParams 

type IsolateSubscribeRequestParams struct {
	// Subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

Predefined struct for user

type IsolateSubscribeResponse 

type IsolateSubscribeResponse struct {
	*tchttp.BaseResponse
	Response *IsolateSubscribeResponseParams `json:"Response"`
}

func NewIsolateSubscribeResponse 

func NewIsolateSubscribeResponse() (response *IsolateSubscribeResponse)

func (*IsolateSubscribeResponse) FromJsonString 

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

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

func (*IsolateSubscribeResponse) ToJsonString 

func (r *IsolateSubscribeResponse) ToJsonString() string

type IsolateSubscribeResponseParams 

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

Predefined struct for user

type MigrateDetailInfo 

type MigrateDetailInfo struct {
	// Total number of steps
	StepAll *int64 `json:"StepAll,omitnil,omitempty" name:"StepAll"`

	// Current step
	StepNow *int64 `json:"StepNow,omitnil,omitempty" name:"StepNow"`

	// Overall progress, such as "10"
	Progress *string `json:"Progress,omitnil,omitempty" name:"Progress"`

	// Progress of current step, such as "1"
	CurrentStepProgress *string `json:"CurrentStepProgress,omitnil,omitempty" name:"CurrentStepProgress"`

	// Master/slave lag in MB, which is valid during incremental sync and currently supported by TencentDB for Redis and MySQL
	MasterSlaveDistance *int64 `json:"MasterSlaveDistance,omitnil,omitempty" name:"MasterSlaveDistance"`

	// Master/slave lag in seconds, which is valid during incremental sync and currently supported by TencentDB for MySQL
	SecondsBehindMaster *int64 `json:"SecondsBehindMaster,omitnil,omitempty" name:"SecondsBehindMaster"`

	// Step information
	StepInfo []*MigrateStepDetailInfo `json:"StepInfo,omitnil,omitempty" name:"StepInfo"`
}

type MigrateJobInfo 

type MigrateJobInfo struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Migration task configuration options
	MigrateOption *MigrateOption `json:"MigrateOption,omitnil,omitempty" name:"MigrateOption"`

	// Source instance database type: MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona
	SrcDatabaseType *string `json:"SrcDatabaseType,omitnil,omitempty" name:"SrcDatabaseType"`

	// Source instance access type. Value range: extranet (public network), cvm (CVM-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance), ccn (CCN instances)
	SrcAccessType *string `json:"SrcAccessType,omitnil,omitempty" name:"SrcAccessType"`

	// Source instance information, which is correlated with the migration task type
	SrcInfo *SrcInfo `json:"SrcInfo,omitnil,omitempty" name:"SrcInfo"`

	// Target instance access type: MySQL, Redis, MongoDB, PostgreSQL, MariaDB, Percona
	DstDatabaseType *string `json:"DstDatabaseType,omitnil,omitempty" name:"DstDatabaseType"`

	// Target instance access type, which currently only supports cdb (TencentDB instance)
	DstAccessType *string `json:"DstAccessType,omitnil,omitempty" name:"DstAccessType"`

	// Target instance information
	DstInfo *DstInfo `json:"DstInfo,omitnil,omitempty" name:"DstInfo"`

	// Information of the source table to be migrated. If the entire instance is to be migrated, this field should be []
	DatabaseInfo *string `json:"DatabaseInfo,omitnil,omitempty" name:"DatabaseInfo"`

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

	// Task start time
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`

	// Task end time
	EndTime *string `json:"EndTime,omitnil,omitempty" name:"EndTime"`

	// Task status. Value range: 1 (Creating), 3 (Checking), 4 (CheckPass), 5 (CheckNotPass), 7 (Running), 8 (ReadyComplete), 9 (Success), 10 (Failed), 11 (Stopping), 12 (Completing)
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// Task details
	Detail *MigrateDetailInfo `json:"Detail,omitnil,omitempty" name:"Detail"`

	// Prompt message for task error, which is not null or empty when an error occurs with the task
	ErrorInfo []*ErrorInfo `json:"ErrorInfo,omitnil,omitempty" name:"ErrorInfo"`

	// Tag
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Information of the source instance, a cluster edition instance whose access type is not `cdb`.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	SrcInfoMulti []*SrcInfo `json:"SrcInfoMulti,omitnil,omitempty" name:"SrcInfoMulti"`
}

type MigrateOption 

type MigrateOption struct {
	// Task operation mode. Value range: 1 (immediate execution), 2 (scheduled execution)
	RunMode *int64 `json:"RunMode,omitnil,omitempty" name:"RunMode"`

	// Expected execution time in the format of yyyy-mm-dd hh:mm:ss. If runMode=2, this field is required
	ExpectTime *string `json:"ExpectTime,omitnil,omitempty" name:"ExpectTime"`

	// Data migration type. Value range: 1 (structural migration), 2 (full migration), 3 (full + incremental migration)
	MigrateType *int64 `json:"MigrateType,omitnil,omitempty" name:"MigrateType"`

	// Migration subject. 1: entire instance; 2: specified table
	MigrateObject *int64 `json:"MigrateObject,omitnil,omitempty" name:"MigrateObject"`

	// Parameter of spot data consistency check. 1: not configured; 2: full check; 3: spot check; 4: check inconsistent tables only; 5: no check
	ConsistencyType *int64 `json:"ConsistencyType,omitnil,omitempty" name:"ConsistencyType"`

	// Whether to overwrite the target database with the root account of the source database. Value range: 0 (no), 1 (yes). This value should be 0 for table or structural migration
	IsOverrideRoot *int64 `json:"IsOverrideRoot,omitnil,omitempty" name:"IsOverrideRoot"`

	// Additional parameters for different databases, which are described in JSON format.
	// The following parameters can be defined for Redis:
	// {
	// 	"ClientOutputBufferHardLimit":512, 	Hard capacity limit of slave buffer (MB)
	// 	"ClientOutputBufferSoftLimit":512, 	Soft capacity limit of slave buffer (MB)
	// 	"ClientOutputBufferPersistTime":60, Soft limit duration of slave buffer (s)
	// 	"ReplBacklogSize":512, 	Circular buffer capacity limit (MB)
	// 	"ReplTimeout":120, 		Replication timeout period (s)
	// }
	// The following parameters can be defined for MongoDB:
	// {
	// 	'SrcAuthDatabase':'admin',
	// 	'SrcAuthFlag': "1",
	// 	'SrcAuthMechanism':"SCRAM-SHA-1"
	// }
	// MySQL currently does not support configuring additional parameters.
	ExternParams *string `json:"ExternParams,omitnil,omitempty" name:"ExternParams"`

	// Only used for "spot data consistency check". It is required if ConsistencyType is spot check
	ConsistencyParams *ConsistencyParams `json:"ConsistencyParams,omitnil,omitempty" name:"ConsistencyParams"`
}

type MigrateStepDetailInfo 

type MigrateStepDetailInfo struct {
	// Step number
	StepNo *int64 `json:"StepNo,omitnil,omitempty" name:"StepNo"`

	// Step name
	StepName *string `json:"StepName,omitnil,omitempty" name:"StepName"`

	// Step ID
	StepId *string `json:"StepId,omitnil,omitempty" name:"StepId"`

	// Step status. Value range: 0 (default), 1 (succeeded), 2 (failed), 3 (in progress), 4 (not started)
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`

	// Start time of current step in the format of `yyyy-mm-dd hh:mm:ss`. This field is meaningless if it does not exist or is empty
	// Note: this field may return null, indicating that no valid values can be obtained.
	StartTime *string `json:"StartTime,omitnil,omitempty" name:"StartTime"`
}

type ModifyMigrateJobRequest 

type ModifyMigrateJobRequest struct {
	*tchttp.BaseRequest

	// ID of the data migration task to be modified
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Migration task configuration options
	MigrateOption *MigrateOption `json:"MigrateOption,omitnil,omitempty" name:"MigrateOption"`

	// Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance)
	SrcAccessType *string `json:"SrcAccessType,omitnil,omitempty" name:"SrcAccessType"`

	// Source instance information, which is correlated with the migration task type
	SrcInfo *SrcInfo `json:"SrcInfo,omitnil,omitempty" name:"SrcInfo"`

	// Target instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance). Currently, only `cdb` is supported
	DstAccessType *string `json:"DstAccessType,omitnil,omitempty" name:"DstAccessType"`

	// Target instance information. The region where the target instance is located cannot be modified.
	DstInfo *DstInfo `json:"DstInfo,omitnil,omitempty" name:"DstInfo"`

	// When migrating the specified table, you need to set the information of the source database table to be migrated, which should be described in JSON string format. Below are examples.
	//
	// For databases with a database-table structure:
	// [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
	// For databases with a database-schema-table structure:
	// [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
	//
	// This field does not need to be set when the entire instance is to be migrated
	DatabaseInfo *string `json:"DatabaseInfo,omitnil,omitempty" name:"DatabaseInfo"`

	// Source instance type. `simple`: Primary/Secondary node; `cluster`: Cluster node. If this field is left empty, the value defaults to primary/secondary node.
	SrcNodeType *string `json:"SrcNodeType,omitnil,omitempty" name:"SrcNodeType"`

	// Source instance information, which is correlated with the migration task type.
	SrcInfoMulti []*SrcInfo `json:"SrcInfoMulti,omitnil,omitempty" name:"SrcInfoMulti"`
}

func NewModifyMigrateJobRequest 

func NewModifyMigrateJobRequest() (request *ModifyMigrateJobRequest)

func (*ModifyMigrateJobRequest) FromJsonString 

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

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

func (*ModifyMigrateJobRequest) ToJsonString 

func (r *ModifyMigrateJobRequest) ToJsonString() string

type ModifyMigrateJobRequestParams 

type ModifyMigrateJobRequestParams struct {
	// ID of the data migration task to be modified
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`

	// Data migration task name
	JobName *string `json:"JobName,omitnil,omitempty" name:"JobName"`

	// Migration task configuration options
	MigrateOption *MigrateOption `json:"MigrateOption,omitnil,omitempty" name:"MigrateOption"`

	// Source instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance)
	SrcAccessType *string `json:"SrcAccessType,omitnil,omitempty" name:"SrcAccessType"`

	// Source instance information, which is correlated with the migration task type
	SrcInfo *SrcInfo `json:"SrcInfo,omitnil,omitempty" name:"SrcInfo"`

	// Target instance access type. Valid values: extranet (public network), cvm (CVM-based self-created instance), dcg (Direct Connect-enabled instance), vpncloud (Tencent Cloud VPN-enabled instance), cdb (TencentDB instance). Currently, only `cdb` is supported
	DstAccessType *string `json:"DstAccessType,omitnil,omitempty" name:"DstAccessType"`

	// Target instance information. The region where the target instance is located cannot be modified.
	DstInfo *DstInfo `json:"DstInfo,omitnil,omitempty" name:"DstInfo"`

	// When migrating the specified table, you need to set the information of the source database table to be migrated, which should be described in JSON string format. Below are examples.
	//
	// For databases with a database-table structure:
	// [{"Database":"db1","Table":["table1","table2"]},{"Database":"db2"}]
	// For databases with a database-schema-table structure:
	// [{"Database":"db1","Schema":"s1","Table":["table1","table2"]},{"Database":"db1","Schema":"s2","Table":["table1","table2"]},{"Database":"db2","Schema":"s1","Table":["table1","table2"]},{"Database":"db3"},{"Database":"db4","Schema":"s1"}]
	//
	// This field does not need to be set when the entire instance is to be migrated
	DatabaseInfo *string `json:"DatabaseInfo,omitnil,omitempty" name:"DatabaseInfo"`

	// Source instance type. `simple`: Primary/Secondary node; `cluster`: Cluster node. If this field is left empty, the value defaults to primary/secondary node.
	SrcNodeType *string `json:"SrcNodeType,omitnil,omitempty" name:"SrcNodeType"`

	// Source instance information, which is correlated with the migration task type.
	SrcInfoMulti []*SrcInfo `json:"SrcInfoMulti,omitnil,omitempty" name:"SrcInfoMulti"`
}

Predefined struct for user

type ModifyMigrateJobResponse 

type ModifyMigrateJobResponse struct {
	*tchttp.BaseResponse
	Response *ModifyMigrateJobResponseParams `json:"Response"`
}

func NewModifyMigrateJobResponse 

func NewModifyMigrateJobResponse() (response *ModifyMigrateJobResponse)

func (*ModifyMigrateJobResponse) FromJsonString 

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

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

func (*ModifyMigrateJobResponse) ToJsonString 

func (r *ModifyMigrateJobResponse) ToJsonString() string

type ModifyMigrateJobResponseParams 

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

Predefined struct for user

type ModifySubscribeConsumeTimeRequest 

type ModifySubscribeConsumeTimeRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Consumption starting time point in the format of `Y-m-d h:m:s`, i.e., the starting time point for data subscription. Value range: within the last 24 hours
	ConsumeStartTime *string `json:"ConsumeStartTime,omitnil,omitempty" name:"ConsumeStartTime"`
}

func NewModifySubscribeConsumeTimeRequest 

func NewModifySubscribeConsumeTimeRequest() (request *ModifySubscribeConsumeTimeRequest)

func (*ModifySubscribeConsumeTimeRequest) FromJsonString 

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

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

func (*ModifySubscribeConsumeTimeRequest) ToJsonString 

func (r *ModifySubscribeConsumeTimeRequest) ToJsonString() string

type ModifySubscribeConsumeTimeRequestParams 

type ModifySubscribeConsumeTimeRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Consumption starting time point in the format of `Y-m-d h:m:s`, i.e., the starting time point for data subscription. Value range: within the last 24 hours
	ConsumeStartTime *string `json:"ConsumeStartTime,omitnil,omitempty" name:"ConsumeStartTime"`
}

Predefined struct for user

type ModifySubscribeConsumeTimeResponse 

type ModifySubscribeConsumeTimeResponse struct {
	*tchttp.BaseResponse
	Response *ModifySubscribeConsumeTimeResponseParams `json:"Response"`
}

func NewModifySubscribeConsumeTimeResponse 

func NewModifySubscribeConsumeTimeResponse() (response *ModifySubscribeConsumeTimeResponse)

func (*ModifySubscribeConsumeTimeResponse) FromJsonString 

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

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

func (*ModifySubscribeConsumeTimeResponse) ToJsonString 

func (r *ModifySubscribeConsumeTimeResponse) ToJsonString() string

type ModifySubscribeConsumeTimeResponseParams 

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

Predefined struct for user

type ModifySubscribeNameRequest 

type ModifySubscribeNameRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription instance name. Length limit: [1,60]
	SubscribeName *string `json:"SubscribeName,omitnil,omitempty" name:"SubscribeName"`
}

func NewModifySubscribeNameRequest 

func NewModifySubscribeNameRequest() (request *ModifySubscribeNameRequest)

func (*ModifySubscribeNameRequest) FromJsonString 

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

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

func (*ModifySubscribeNameRequest) ToJsonString 

func (r *ModifySubscribeNameRequest) ToJsonString() string

type ModifySubscribeNameRequestParams 

type ModifySubscribeNameRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription instance name. Length limit: [1,60]
	SubscribeName *string `json:"SubscribeName,omitnil,omitempty" name:"SubscribeName"`
}

Predefined struct for user

type ModifySubscribeNameResponse 

type ModifySubscribeNameResponse struct {
	*tchttp.BaseResponse
	Response *ModifySubscribeNameResponseParams `json:"Response"`
}

func NewModifySubscribeNameResponse 

func NewModifySubscribeNameResponse() (response *ModifySubscribeNameResponse)

func (*ModifySubscribeNameResponse) FromJsonString 

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

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

func (*ModifySubscribeNameResponse) ToJsonString 

func (r *ModifySubscribeNameResponse) ToJsonString() string

type ModifySubscribeNameResponseParams 

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

Predefined struct for user

type ModifySubscribeObjectsRequest 

type ModifySubscribeObjectsRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription type. Valid values: 0 (full instance subscription), 1 (data subscription), 2 (structure subscription), 3 (data subscription + structure subscription)
	SubscribeObjectType *int64 `json:"SubscribeObjectType,omitnil,omitempty" name:"SubscribeObjectType"`

	// Information of subscribed table
	Objects []*SubscribeObject `json:"Objects,omitnil,omitempty" name:"Objects"`
}

func NewModifySubscribeObjectsRequest 

func NewModifySubscribeObjectsRequest() (request *ModifySubscribeObjectsRequest)

func (*ModifySubscribeObjectsRequest) FromJsonString 

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

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

func (*ModifySubscribeObjectsRequest) ToJsonString 

func (r *ModifySubscribeObjectsRequest) ToJsonString() string

type ModifySubscribeObjectsRequestParams 

type ModifySubscribeObjectsRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription type. Valid values: 0 (full instance subscription), 1 (data subscription), 2 (structure subscription), 3 (data subscription + structure subscription)
	SubscribeObjectType *int64 `json:"SubscribeObjectType,omitnil,omitempty" name:"SubscribeObjectType"`

	// Information of subscribed table
	Objects []*SubscribeObject `json:"Objects,omitnil,omitempty" name:"Objects"`
}

Predefined struct for user

type ModifySubscribeObjectsResponse 

type ModifySubscribeObjectsResponse struct {
	*tchttp.BaseResponse
	Response *ModifySubscribeObjectsResponseParams `json:"Response"`
}

func NewModifySubscribeObjectsResponse 

func NewModifySubscribeObjectsResponse() (response *ModifySubscribeObjectsResponse)

func (*ModifySubscribeObjectsResponse) FromJsonString 

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

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

func (*ModifySubscribeObjectsResponse) ToJsonString 

func (r *ModifySubscribeObjectsResponse) ToJsonString() string

type ModifySubscribeObjectsResponseParams 

type ModifySubscribeObjectsResponseParams struct {
	// Async task ID
	AsyncRequestId *string `json:"AsyncRequestId,omitnil,omitempty" name:"AsyncRequestId"`

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

Predefined struct for user

type ModifySubscribeVipVportRequest 

type ModifySubscribeVipVportRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Specified destination subnet. If this parameter is passed in, `DstIp` must be in the destination subnet
	DstUniqSubnetId *string `json:"DstUniqSubnetId,omitnil,omitempty" name:"DstUniqSubnetId"`

	// Target IP. Either this field or `DstPort` must be passed in
	DstIp *string `json:"DstIp,omitnil,omitempty" name:"DstIp"`

	// Target port. Value range: [1025-65535]
	DstPort *int64 `json:"DstPort,omitnil,omitempty" name:"DstPort"`
}

func NewModifySubscribeVipVportRequest 

func NewModifySubscribeVipVportRequest() (request *ModifySubscribeVipVportRequest)

func (*ModifySubscribeVipVportRequest) FromJsonString 

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

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

func (*ModifySubscribeVipVportRequest) ToJsonString 

func (r *ModifySubscribeVipVportRequest) ToJsonString() string

type ModifySubscribeVipVportRequestParams 

type ModifySubscribeVipVportRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Specified destination subnet. If this parameter is passed in, `DstIp` must be in the destination subnet
	DstUniqSubnetId *string `json:"DstUniqSubnetId,omitnil,omitempty" name:"DstUniqSubnetId"`

	// Target IP. Either this field or `DstPort` must be passed in
	DstIp *string `json:"DstIp,omitnil,omitempty" name:"DstIp"`

	// Target port. Value range: [1025-65535]
	DstPort *int64 `json:"DstPort,omitnil,omitempty" name:"DstPort"`
}

Predefined struct for user

type ModifySubscribeVipVportResponse 

type ModifySubscribeVipVportResponse struct {
	*tchttp.BaseResponse
	Response *ModifySubscribeVipVportResponseParams `json:"Response"`
}

func NewModifySubscribeVipVportResponse 

func NewModifySubscribeVipVportResponse() (response *ModifySubscribeVipVportResponse)

func (*ModifySubscribeVipVportResponse) FromJsonString 

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

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

func (*ModifySubscribeVipVportResponse) ToJsonString 

func (r *ModifySubscribeVipVportResponse) ToJsonString() string

type ModifySubscribeVipVportResponseParams 

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

Predefined struct for user

type OfflineIsolatedSubscribeRequest 

type OfflineIsolatedSubscribeRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

func NewOfflineIsolatedSubscribeRequest 

func NewOfflineIsolatedSubscribeRequest() (request *OfflineIsolatedSubscribeRequest)

func (*OfflineIsolatedSubscribeRequest) FromJsonString 

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

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

func (*OfflineIsolatedSubscribeRequest) ToJsonString 

func (r *OfflineIsolatedSubscribeRequest) ToJsonString() string

type OfflineIsolatedSubscribeRequestParams 

type OfflineIsolatedSubscribeRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

Predefined struct for user

type OfflineIsolatedSubscribeResponse 

type OfflineIsolatedSubscribeResponse struct {
	*tchttp.BaseResponse
	Response *OfflineIsolatedSubscribeResponseParams `json:"Response"`
}

func NewOfflineIsolatedSubscribeResponse 

func NewOfflineIsolatedSubscribeResponse() (response *OfflineIsolatedSubscribeResponse)

func (*OfflineIsolatedSubscribeResponse) FromJsonString 

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

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

func (*OfflineIsolatedSubscribeResponse) ToJsonString 

func (r *OfflineIsolatedSubscribeResponse) ToJsonString() string

type OfflineIsolatedSubscribeResponseParams 

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

Predefined struct for user

type ResetSubscribeRequest 

type ResetSubscribeRequest struct {
	*tchttp.BaseRequest

	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

func NewResetSubscribeRequest 

func NewResetSubscribeRequest() (request *ResetSubscribeRequest)

func (*ResetSubscribeRequest) FromJsonString 

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

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

func (*ResetSubscribeRequest) ToJsonString 

func (r *ResetSubscribeRequest) ToJsonString() string

type ResetSubscribeRequestParams 

type ResetSubscribeRequestParams struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`
}

Predefined struct for user

type ResetSubscribeResponse 

type ResetSubscribeResponse struct {
	*tchttp.BaseResponse
	Response *ResetSubscribeResponseParams `json:"Response"`
}

func NewResetSubscribeResponse 

func NewResetSubscribeResponse() (response *ResetSubscribeResponse)

func (*ResetSubscribeResponse) FromJsonString 

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

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

func (*ResetSubscribeResponse) ToJsonString 

func (r *ResetSubscribeResponse) ToJsonString() string

type ResetSubscribeResponseParams 

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

Predefined struct for user

type SrcInfo 

type SrcInfo struct {
	// Alibaba Cloud AccessKey, which is applicable if the source database is an Alibaba Cloud ApsaraDB for RDS 5.6 instance
	AccessKey *string `json:"AccessKey,omitnil,omitempty" name:"AccessKey"`

	// Instance IP address
	Ip *string `json:"Ip,omitnil,omitempty" name:"Ip"`

	// Instance port
	Port *int64 `json:"Port,omitnil,omitempty" name:"Port"`

	// Instance username
	User *string `json:"User,omitnil,omitempty" name:"User"`

	// Instance password
	Password *string `json:"Password,omitnil,omitempty" name:"Password"`

	// Alibaba Cloud ApsaraDB for RDS instance ID, which is applicable if the source database is an Alibaba Cloud ApsaraDB for RDS 5.6/5.7 instance
	RdsInstanceId *string `json:"RdsInstanceId,omitnil,omitempty" name:"RdsInstanceId"`

	// Short CVM instance ID in the format of `ins-olgl39y8`. It is the same as the instance ID displayed on the CVM Console page. For CVM-based self-created instances, this field needs to be passed in
	CvmInstanceId *string `json:"CvmInstanceId,omitnil,omitempty" name:"CvmInstanceId"`

	// Direct Connect gateway ID in the format of dcg-0rxtqqxb
	UniqDcgId *string `json:"UniqDcgId,omitnil,omitempty" name:"UniqDcgId"`

	// VPC ID in the format of vpc-92jblxto
	VpcId *string `json:"VpcId,omitnil,omitempty" name:"VpcId"`

	// VPC Subnet ID in the format of subnet-3paxmkdz
	SubnetId *string `json:"SubnetId,omitnil,omitempty" name:"SubnetId"`

	// VPN gateway ID in the format of vpngw-9ghexg7q
	UniqVpnGwId *string `json:"UniqVpnGwId,omitnil,omitempty" name:"UniqVpnGwId"`

	// Database instance ID in the format of cdb-powiqx8q
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Region name, such as ap-guangzhou
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// For Alibaba Cloud ApsaraDB for RDS instances, enter "aliyun"; otherwise, enter "others"
	Supplier *string `json:"Supplier,omitnil,omitempty" name:"Supplier"`

	// CCN instance ID, such as ccn-afp6kltc
	// Note: This field may return null, indicating that no valid values can be obtained.
	CcnId *string `json:"CcnId,omitnil,omitempty" name:"CcnId"`

	// Database version. This parameter is valid only when the instance is an RDS instance. Value: 5.6 or 5.7. Default value: 5.6
	EngineVersion *string `json:"EngineVersion,omitnil,omitempty" name:"EngineVersion"`
}

type StartMigrateJobRequest 

type StartMigrateJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

func NewStartMigrateJobRequest 

func NewStartMigrateJobRequest() (request *StartMigrateJobRequest)

func (*StartMigrateJobRequest) FromJsonString 

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

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

func (*StartMigrateJobRequest) ToJsonString 

func (r *StartMigrateJobRequest) ToJsonString() string

type StartMigrateJobRequestParams 

type StartMigrateJobRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

Predefined struct for user

type StartMigrateJobResponse 

type StartMigrateJobResponse struct {
	*tchttp.BaseResponse
	Response *StartMigrateJobResponseParams `json:"Response"`
}

func NewStartMigrateJobResponse 

func NewStartMigrateJobResponse() (response *StartMigrateJobResponse)

func (*StartMigrateJobResponse) FromJsonString 

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

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

func (*StartMigrateJobResponse) ToJsonString 

func (r *StartMigrateJobResponse) ToJsonString() string

type StartMigrateJobResponseParams 

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

Predefined struct for user

type StopMigrateJobRequest 

type StopMigrateJobRequest struct {
	*tchttp.BaseRequest

	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

func NewStopMigrateJobRequest 

func NewStopMigrateJobRequest() (request *StopMigrateJobRequest)

func (*StopMigrateJobRequest) FromJsonString 

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

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

func (*StopMigrateJobRequest) ToJsonString 

func (r *StopMigrateJobRequest) ToJsonString() string

type StopMigrateJobRequestParams 

type StopMigrateJobRequestParams struct {
	// Data migration task ID
	JobId *string `json:"JobId,omitnil,omitempty" name:"JobId"`
}

Predefined struct for user

type StopMigrateJobResponse 

type StopMigrateJobResponse struct {
	*tchttp.BaseResponse
	Response *StopMigrateJobResponseParams `json:"Response"`
}

func NewStopMigrateJobResponse 

func NewStopMigrateJobResponse() (response *StopMigrateJobResponse)

func (*StopMigrateJobResponse) FromJsonString 

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

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

func (*StopMigrateJobResponse) ToJsonString 

func (r *StopMigrateJobResponse) ToJsonString() string

type StopMigrateJobResponseParams 

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

Predefined struct for user

type SubsErr 

type SubsErr struct {
	// Error message.
	// Note: This field may return `null`, indicating that no valid values can be obtained.
	Message *string `json:"Message,omitnil,omitempty" name:"Message"`
}

type SubscribeInfo 

type SubscribeInfo struct {
	// Data subscription instance ID
	SubscribeId *string `json:"SubscribeId,omitnil,omitempty" name:"SubscribeId"`

	// Data subscription instance name
	SubscribeName *string `json:"SubscribeName,omitnil,omitempty" name:"SubscribeName"`

	// ID of channel bound to data subscription instance
	ChannelId *string `json:"ChannelId,omitnil,omitempty" name:"ChannelId"`

	// Name of product bound to data subscription instance
	Product *string `json:"Product,omitnil,omitempty" name:"Product"`

	// ID of database instance bound to data subscription instance
	InstanceId *string `json:"InstanceId,omitnil,omitempty" name:"InstanceId"`

	// Status of database instance bound to data subscription instance
	InstanceStatus *string `json:"InstanceStatus,omitnil,omitempty" name:"InstanceStatus"`

	// Data subscription instance configuration status. Valid values: unconfigure, configuring, configured
	SubsStatus *string `json:"SubsStatus,omitnil,omitempty" name:"SubsStatus"`

	// Last modified time
	ModifyTime *string `json:"ModifyTime,omitnil,omitempty" name:"ModifyTime"`

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

	// Isolation time
	IsolateTime *string `json:"IsolateTime,omitnil,omitempty" name:"IsolateTime"`

	// Expiration time
	ExpireTime *string `json:"ExpireTime,omitnil,omitempty" name:"ExpireTime"`

	// Deactivation time
	OfflineTime *string `json:"OfflineTime,omitnil,omitempty" name:"OfflineTime"`

	// Last modified consumption starting time point. If it has never been modified, this field is 0
	ConsumeStartTime *string `json:"ConsumeStartTime,omitnil,omitempty" name:"ConsumeStartTime"`

	// Data subscription instance region
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// Billing mode. 1: pay-as-you-go
	PayType *int64 `json:"PayType,omitnil,omitempty" name:"PayType"`

	// Data subscription instance VIP
	Vip *string `json:"Vip,omitnil,omitempty" name:"Vip"`

	// Data subscription instance Vport
	Vport *int64 `json:"Vport,omitnil,omitempty" name:"Vport"`

	// Unique ID of the VPC where the data subscription instance VIP resides
	UniqVpcId *string `json:"UniqVpcId,omitnil,omitempty" name:"UniqVpcId"`

	// Unique ID of the subnet where the data subscription instance VIP resides
	UniqSubnetId *string `json:"UniqSubnetId,omitnil,omitempty" name:"UniqSubnetId"`

	// Data subscription instance status. Valid values: creating, normal, isolating, isolated, offlining, offline
	Status *string `json:"Status,omitnil,omitempty" name:"Status"`

	// Timestamp of the last message confirmed by the SDK. If the SDK keeps consuming, this field can also be used as the current consumption time point of the SDK
	SdkConsumedTime *string `json:"SdkConsumedTime,omitnil,omitempty" name:"SdkConsumedTime"`

	// Tag
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	Tags []*TagItem `json:"Tags,omitnil,omitempty" name:"Tags"`

	// Whether auto-renewal is enabled. 0: do not enable; 1: enable
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	AutoRenewFlag *int64 `json:"AutoRenewFlag,omitnil,omitempty" name:"AutoRenewFlag"`

	// Subscription instance edition. ·`txdts`: legacy data subscription; `kafka`: data subscription in Kafka edition
	// Note: this field may return `null`, indicating that no valid values can be obtained.
	SubscribeVersion *string `json:"SubscribeVersion,omitnil,omitempty" name:"SubscribeVersion"`
}

type SubscribeObject 

type SubscribeObject struct {
	// Data subscription object type. 0: database, 1: database table
	// Note: this field may return null, indicating that no valid values can be obtained.
	ObjectsType *int64 `json:"ObjectsType,omitnil,omitempty" name:"ObjectsType"`

	// Name of subscribed database
	// Note: this field may return null, indicating that no valid values can be obtained.
	DatabaseName *string `json:"DatabaseName,omitnil,omitempty" name:"DatabaseName"`

	// Array of table names in subscribed database
	// Note: this field may return null, indicating that no valid values can be obtained.
	TableNames []*string `json:"TableNames,omitnil,omitempty" name:"TableNames"`
}

type SubscribeRegionConf 

type SubscribeRegionConf struct {
	// Region name, such as Guangzhou
	// Note: this field may return null, indicating that no valid values can be obtained.
	RegionName *string `json:"RegionName,omitnil,omitempty" name:"RegionName"`

	// Region ID, such as ap-guangzhou
	// Note: this field may return null, indicating that no valid values can be obtained.
	Region *string `json:"Region,omitnil,omitempty" name:"Region"`

	// Region name, such as South China
	// Note: this field may return null, indicating that no valid values can be obtained.
	Area *string `json:"Area,omitnil,omitempty" name:"Area"`

	// Whether it is the default region. 0: no, 1: yes
	// Note: this field may return null, indicating that no valid values can be obtained.
	IsDefaultRegion *int64 `json:"IsDefaultRegion,omitnil,omitempty" name:"IsDefaultRegion"`

	// Purchasable status of current region. 1: normal, 2: beta test, 3: not purchasable
	// Note: this field may return null, indicating that no valid values can be obtained.
	Status *int64 `json:"Status,omitnil,omitempty" name:"Status"`
}

type TagFilter 

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

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

type TagItem 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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