DescribeDBInstanceReplication - ApsaraDB RDS - Alibaba Cloud ドキュメントセンター

この API は、ネイティブレプリケーションインスタンスのステータスと構成を返します。

操作説明

適用エンジン

RDS MySQL

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

rds:DescribeDBInstanceReplication

get

*All Resource

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。 DescribeRegions 操作を呼び出して、最新のリージョンリストを照会できます。	cn-hangzhou
DBInstanceId	string	必須	インスタンス ID です。DescribeDBInstances 操作を呼び出して、インスタンスの詳細を照会できます。	rm-uf6wjk5****
ResourceGroupId	string	任意	リソースグループ ID。	rg-acfmx****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーターの詳細。
RequestId	string	リクエスト ID。	847BA085-B377-4BFA-8267-F82345ECE1D2
ExternalReplication	string	ネイティブレプリケーションが有効かどうかを示します。有効値： ON：有効。 OFF：無効。	ON
ReplicationSource	string	ネイティブレプリケーションのレプリケーションソース。	192.168.XX.XX
ReplicationState	string	現在のレプリケーションステータス。有効値： Running Connecting Stopped Error	Stopped
ReplicationDelay	string	現在のレプリケーションの遅延 (秒単位)。	0
ReplicationErrorMessage	string	レプリケーションエラーメッセージ。	Got fatal error 1236 from master when reading data from binary log...
ReplicationIp	string	レプリカノードの IP アドレス。	192.168.10.x
ReplicationPort	string	レプリカノードのポート。	3306
GtidExecuted	string	実行されたグローバルトランザクション識別子 (GTID)。	bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567
ImportStatus	string	インポートステータス。このパラメーターは、ソースインスタンスの完全データがレプリカインスタンスに正常にインポートされたかどうかを示します。	COMPLETED
SlaveStatusList	array<object>	各レプリカインスタンスのレプリケーションステータスの詳細。	[{"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	I/O スレッドが実行中かどうかを示します。有効値は `Yes` と `No` です。	Yes
SlaveSqlRunning	string	SQL スレッドが実行中かどうかを示します。有効値は `Yes` と `No` です。	Yes
SecondsBehindMaster	integer	レプリカインスタンスがソースインスタンスから遅延している秒数。	0
SlaveIoState	string	I/O スレッドの状態。	Waiting for master to send event
SlaveSqlRunningState	string	SQL スレッドの状態。	Slave has read all relay log; waiting for more updates
ExecutedGtidSet	string	レプリカインスタンスによって実行された GTID セット。	bd2a34b9-8b8d-11ef-8917-00163e1298b9:1-20567
MasterHost	string	ソースインスタンスのホスト名または IP アドレス。	192.168.10.100
MasterUser	string	レプリケーションのためにソースインスタンスへの接続に使用されるユーザー名。	repl_user
MasterUuid	string	ソースインスタンスの UUID。	bd2a34b9-8b8d-11ef-8917-00163e1298b9
LastErrno	integer	最後のエラーのエラー番号。値が `0` の場合は、エラーが発生しなかったことを示します。	0
LastSqlErrno	integer	SQL スレッドで発生した最後のエラーのエラー番号。値が `0` の場合は、エラーが発生しなかったことを示します。	0
LastIoErrno	integer	I/O スレッドで発生した最後のエラーのエラー番号。値が `0` の場合は、エラーが発生しなかったことを示します。	0
LastSqlError	string	SQL スレッドで発生した最後のエラーのメッセージ。
LastIoError	string	I/O スレッドで発生した最後のエラーのメッセージ。
ChannelName	string	レプリケーションチャンネルの名前。	my_test_channel
ReplicateDoDb	string	レプリケーションするデータベースのカンマ区切りリスト。	test_db,test_db_1
ReplicateIgnoreDb	string	レプリケーション中に無視するデータベースのカンマ区切りリスト。	information_schema,performance_schema
ReplicateDoTable	string	レプリケーションするテーブルのカンマ区切りリスト。	test_table,test_table_1
ReplicateIgnoreTable	string	レプリケーション中に無視するテーブルのカンマ区切りリスト。	temp_table,temp_table_1
ReplicateWildDoTable	string	レプリケーションするテーブルパターンのカンマ区切りリスト。このパラメーターはワイルドカードをサポートしています。	test_table.%
ReplicateWildIgnoreTable	string	レプリケーション中に無視するテーブルパターンのカンマ区切りリスト。このパラメーターはワイルドカードをサポートしています。	temp_table.%

例

成功レスポンス

JSONJSON

{
  "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.%"
    }
  ]
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	Order.ComboInstanceNotAllowOperate	A package instance is not allowed to operate independently.
400	Price.PricingPlanResultNotFound	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.
400	InsufficientAvailableQuota	Your account quota limit is less than 0, please recharge before trying to purchase.
400	CommodityServiceCalling.Exception	Failed to call commodity service.
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.
400	Commodity.InvalidComponent	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.
400	Price.CommoditySys	Commodity system call exception.
400	Pay.InsufficientBalance	Insufficient available balance.
400	Order.PeriodInvalid	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.
400	BasicInfoUncompleted	Your information is incomplete. Complete your information before the operation.
400	Risk.RiskControlRejection	Your account is abnormal, please contact customer service for details.
400	Api.NotSupport	Specified api is not supported.
400	ContainForbiddenLabelError	There is a label that prohibits placing orders. Please contact your distributor for assistance.
400	InvalidDBInstanceId.NotFound	The DBInstanceId provided does not exist in records.
400	InvalidInstanceLevel.DiskType	Specified instance level not support request disk type
400	InvalidParam	Sepcified wal level Parameter is invalid. There are still logical slots in instance, so it can not be set as replica.
400	KmsApiError	User secret key invalid.
400	System.SaleValidateFailed	Sales expression validation system error.
400	Abs.InvalidAccount.NotFound	account is not found.
400	SqlExecuteFailedOrTimeout	sql command execution failed or timed out:%s.
400	ColdData.EngineVersionNotSupport	The current instance engine version not support coldDataEnabled.
400	ColdData.MinorVersionNotSupport	The current instance minor version not support coldDataEnabled.
400	IncorrectTargetClasscode	The current instance type does not support this operation.
400	InvalidConnectionString.Duplicate	Specified connection string already exists in the RDS.
400	RequiredParam.NotFound	Required input param is not found.
400	Parameters.Invalid	Parameter error, please check the parameters.
400	BackupPolicyNotSupport	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.
400	InvalidDBInstanceEngineType.Format	the DB instance engine type does not support this operation.
400	Pay.NoCreditCard	No credit cards.
400	VpcNetworkTypeNotSupport	The vpc network type instance does not support this operation.
400	MirrorInsExists	Specified DB instance mirror ins already existed.
400	UnsupportedClassCode	The specified DB instance class stops selling.
400	InvalidBackupSet	The specified database does not exist in the backup set.
400	OrdTCommodityQueryError	Failed to query for product.
400	ProductInstanceReleased	The instance has been released. Please check before placing the order.
400	RegionEndTimeDissolvedIndia	The region is no longer supported.
500	ExternalFailure	The request processing has failed due to external service failure.
500	RequestMetaDataFailed	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.
403	OrderStatus.UnPaid	The specified db instance has unpaid order.
403	InvalidReduceDiskSize	The storage capacity after the scale-down must be larger than the used amount.
403	CloudSSDNotSupport	Cloud ssd does not support this operation, please upgrade to essd.
403	InvalidUserOperatorPermission	The user permission does not support this operation.
403	InvalidVswitchId	Specified conn vswitch id is not valid.
403	IncorrectMinorVersion	Current engine minor version does not support operations.
403	OperationDenied.ZoneResource	There is no available zone for inventory.
403	NotInFlowController	Sorry,no permission.
403	InvalidKmsKey	Kms key is disabled.
403	InvalidInstanceLevel.Malformed	Current DB instance level does not support this operation.
403	IncorrectDBInstanceType	Current DB instance type does not support this operation.
404	InvalidClusterKms	The current instance does not authorized to access the Key Management Service.
404	Request.NotFound	The requested resource is not available.
404	HostInfo.NotFound	The specified host info is not found.
404	InvalidReplicationChannel.NotFound	Specified replication channel does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。

ApsaraDB RDS:DescribeDBInstanceReplication