DescribeDBInstanceReplication to query native replication status and configurations - ApsaraDB RDS - Alibaba Cloud - ApsaraDB RDS

This operation returns the status and configuration of a native replication instance.

Operation description

Supported engines

RDS MySQL

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID. You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
DBInstanceId	string	Yes	The instance ID. You can call the DescribeDBInstances operation to query the instance ID.	rm-uf6wjk5****
ResourceGroupId	string	No	The ID of the resource group.	rg-acfmx****

Response elements

Element	Type	Description	Example
	object	The details of the response parameters.
RequestId	string	The request ID.	847BA085-B377-4BFA-8267-F82345ECE1D2
ExternalReplication	string	Indicates whether native replication is enabled. Valid values: ON: Enabled. OFF: Disabled.	ON
ReplicationSource	string	The replication source for native replication.	192.168.XX.XX
ReplicationState	string	The replication state. Valid values: Running: Replication is in progress. Connecting: A connection is being established. Stopped: Replication is stopped. Error: An error occurred.	Stopped
ReplicationDelay	string	The replication delay, in seconds.	0
ReplicationErrorMessage	string	The replication error message.	Got fatal error 1236 from master when reading data from binary log...
ReplicationIp	string	The IP address of the replica.	192.168.10.x
ReplicationPort	string	The port of the replica.	3306
GtidExecuted	string	The executed global transaction identifier (GTID).	bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567
ImportStatus	string	Indicates whether the full data was imported successfully.	COMPLETED
SlaveStatusList	array<object>	A list of the status details for each replication channel.	[{"SlaveIoRunning": "Yes", "SlaveSqlRunning": "Yes", "SecondsBehindMaster": 0, "SlaveIoState": "Waiting for master to send event", "SlaveSqlRunningState": "Slave has read all relay log; waiting for more updates", "ExecutedGtidSet": "bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567", "MasterHost": "192.168.10.100", "MasterUser": "repl_user", "MasterUuid": "bd2a34b9-8b8d-11ef-8917-00163e1298b9", "LastErrno": 0, "LastSqlErrno": 0, "LastIoErrno": 0, "LastSqlError": "", "LastIoError": "", "ChannelName": "my_test_channel", "ReplicateDoDb": "test_db,test_db_1", "ReplicateIgnoreDb": "information_schema,performance_schema", "ReplicateDoTable": "test_table,test_table_1", "ReplicateIgnoreTable": "temp_table,temp_table_1", "ReplicateWildDoTable": "test_table.%", "ReplicateWildIgnoreTable": "temp_table.%"}]
	object
SlaveIoRunning	string	Indicates whether the replica's I/O thread is running. `Yes`: Running. `No`: Stopped.	Yes
SlaveSqlRunning	string	Indicates whether the replica's SQL thread is running. `Yes`: Running. `No`: Stopped.	Yes
SecondsBehindMaster	integer	The number of seconds that the replica is behind the source instance.	0
SlaveIoState	string	The state of the replica's I/O thread.	Waiting for master to send event
SlaveSqlRunningState	string	The state of the replica's SQL thread.	Slave has read all relay log; waiting for more updates
ExecutedGtidSet	string	The set of global transaction identifiers (GTIDs) executed on the replica.	bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567
MasterHost	string	The hostname or IP address of the source instance.	192.168.10.100
MasterUser	string	The username for the replication account.	repl_user
MasterUuid	string	The UUID of the source instance.	bd2a34b9-8b8d-11ef-8917-00163e1298b9
LastErrno	integer	The most recent error code. A value of `0` indicates that no error occurred.	0
LastSqlErrno	integer	The error code from the SQL thread. A value of `0` indicates that no error occurred.	0
LastIoErrno	integer	The error code from the I/O thread. A value of `0` indicates that no error occurred.	0
LastSqlError	string	The error message from the SQL thread.
LastIoError	string	The error message from the I/O thread.
ChannelName	string	The name of the replication channel.	my_test_channel
ReplicateDoDb	string	A comma-separated list of databases to replicate.	test_db,test_db_1
ReplicateIgnoreDb	string	A comma-separated list of databases to ignore during replication.	information_schema,performance_schema
ReplicateDoTable	string	A comma-separated list of tables to replicate.	test_table,test_table_1
ReplicateIgnoreTable	string	A comma-separated list of tables to ignore during replication.	temp_table,temp_table_1
ReplicateWildDoTable	string	A comma-separated list of table patterns to replicate.	test_table.%
ReplicateWildIgnoreTable	string	A comma-separated list of table patterns to ignore during replication.	temp_table.%

Examples

Success response

JSON format

{
  "RequestId": "847BA085-B377-4BFA-8267-F82345ECE1D2",
  "ExternalReplication": "ON",
  "ReplicationSource": "192.168.XX.XX",
  "ReplicationState": "Stopped",
  "ReplicationDelay": "0",
  "ReplicationErrorMessage": "Got fatal error 1236 from master when reading data from binary log...",
  "ReplicationIp": "192.168.10.x",
  "ReplicationPort": "3306",
  "GtidExecuted": "bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567",
  "ImportStatus": "COMPLETED",
  "SlaveStatusList": [
    {
      "SlaveIoRunning": "Yes",
      "SlaveSqlRunning": "Yes",
      "SecondsBehindMaster": 0,
      "SlaveIoState": "Waiting for master to send event",
      "SlaveSqlRunningState": "Slave has read all relay log; waiting for more updates",
      "ExecutedGtidSet": "bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567",
      "MasterHost": "192.168.10.100",
      "MasterUser": "repl_user",
      "MasterUuid": "bd2a34b9-8b8d-11ef-8917-00163e1298b9",
      "LastErrno": 0,
      "LastSqlErrno": 0,
      "LastIoErrno": 0,
      "LastSqlError": "",
      "LastIoError": "",
      "ChannelName": "my_test_channel",
      "ReplicateDoDb": "test_db,test_db_1",
      "ReplicateIgnoreDb": "information_schema,performance_schema",
      "ReplicateDoTable": "test_table,test_table_1",
      "ReplicateIgnoreTable": "temp_table,temp_table_1",
      "ReplicateWildDoTable": "test_table.%",
      "ReplicateWildIgnoreTable": "temp_table.%"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	Pricing plan price result not found.	Pricing plan price result not found.
400	Order.NoRealNameAuthentication	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the user center for real-name authentication.	You have not passed the real-name authentication and do not meet the purchase conditions. Please log in to the cost and cost for real-name authentication.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.	Your account available limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.	Failed to call commodity service return.
400	RegionDissolvedEOM	Dear customer, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will cease operations. You are currently unable to operate new purchase orders. Thank you for your understanding and support.	Hello, Alibaba Cloud plans to optimize and adjust the current region. Cloud services in this region will stop operating. In order to ensure your business continuity and smooth transition of data migration, you are currently unable to operate new purchase orders. Thank you for your understanding and support.
400	Commodity.InvalidComponent	The module you purchased is not legal, please buy it again.	The module you purchased is not legal, please buy it again.
400	RegionEndTimeDissolvedAustralia	Cloud services in the Australia (Sydney) region will be discontinued. Set the validity date to September 30, 2024 or earlier than September 30, 2024.	Hello customer, this area has been abolished.
400	Price.CommoditySys	Commodity system call exception.	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.	Insufficient available balance.
400	Order.PeriodInvalid	There is a problem with the period you selected, please choose again.	There is a problem with the period you selected, please choose again.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.	Your basic information is not complete, please complete your basic information before operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.	The current interface does not support.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.	You cannot place the order because a tag indicates that order placement is prohibited. Contact your distributor.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.	The DBInstanceId provided does not exist.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type	The current instance type does not support the specified storage type.
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.	The specified wal_level parameter is invalid. There is still a copy slot in the instance, so it cannot be set to replica.
400	KmsApiError	User secret key invalid.	The user key is invalid.
400	System.SaleValidateFailed	Sales expression validation system error.	A system error occurs when the sales expression is verified.
400	Abs.InvalidAccount.NotFound	account is not found.	The account does not exist.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.	SQL command execution failed or timed out
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.	This operation is not supported by the instance type.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.	The link address name is duplicate. Please reset the connection string.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.	Cold Data won't open with CrossBackup or Flash Backup, please check Backup Policy.
400	InvalideStatus.Format	The instance status does not support this operation.
400	InvalidReleasedKeepPolicy.Format	Specified Released Keep Policy is not valid.	Specified Released Keep Policy is not valid.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.	This operation is not supported for the database engine of the instance.
400	Pay.NoCreditCard	No credit cards.	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.	Failed to query product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.	The instance has been released, please verify and place an order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	The service request failed. Please try again later or contact service personnel.	The service request failed. Please try again later or contact service personnel.
500	InvokeProxyFailure	The request processing has failed due to service failure of rds api.	The request failed to be processed due to an RDS API failure.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.	The instance has an unpaid order. Please pay first and try again.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.	The scale-in target capacity cannot be less than the current storage space usage
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.	The user is not authorized to perform this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.	This operation is not supported for the current minor engine version.
403	OperationDenied.ZoneResource	There is no available zone for inventory.	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.	The specified database instance type does not support this operation.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.	The operation failed. The RDS instance is not in a ready state.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.	The instance does not have permissions to access Key Management Service (KMS).
404	Request.NotFound	The requested resource is not available.	The requested resources are unavailable.
404	HostInfo.NotFound	The specified host info is not found.
404	InvalidReplicationChannel.NotFound	Specified replication channel does not exist.	Specified replication channel does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.

ApsaraDB RDS:DescribeDBInstanceReplication