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

インスタンスのリストを照会します。

説明

この API は廃止されました。一時的にアクセス可能ですが、更新やバグ修正対応は一切行われません。代わりに Rds(2014-08-15) - DescribeDBInstances への移行を推奨します。より強化された機能に加え、サポートも引き続きご利用いただけます。

操作説明

この操作は廃止されました。

今すぐお試しください

この 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:DescribeDBInstancesForClone

get

*DBInstance

acs:rds:{#regionId}:{#accountId}:dbinstance/{#DbInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ClientToken	string	任意	リクエストのべき等性を保証するために使用されるクライアントトークン。クライアント側でトークンを生成できますが、異なるリクエスト間で一意であることを確認する必要があります。トークンには ASCII 文字のみを含めることができ、長さは 64 文字を超えることはできません。	ETnLKlblzczshOTUbOCzxxxxxxxxxx
proxyId	string	任意	プロキシモードの ID。	API
Engine	string	任意	インスタンスのデータベースエンジン。有効な値： MySQL SQLServer PostgreSQL PPAS MariaDB デフォルトでは、この操作はサポートされているいずれかのデータベースエンジンタイプを実行するインスタンスを照会します。	MySQL
ZoneId	string	任意	インスタンスのゾーン ID。	cn-hangzhou-h
DBInstanceStatus	string	任意	インスタンスのステータス。詳細については、「インスタンスの状態表」をご参照ください。	Running
Expired	string	任意	インスタンスの有効期限が切れているかどうかを指定します。有効な値： True：有効期限が切れたインスタンスを照会します。 False：有効期限が切れたインスタンスを照会しません。	True
SearchKey	string	任意	検索に使用されるキーワード。キーワードは、インスタンス ID またはインスタンスの説明の一部にすることができます。	rm-uf6w
DBInstanceId	string	任意	インスタンスの ID。	rm-uf6wjk5xxxxxxxxxx
DBInstanceType	string	任意	照会したいインスタンスのロール。有効な値： Primary：プライマリインスタンス Readonly：読み取り専用インスタンス Guard：ディザスタリカバリインスタンス Temp：一時インスタンスデフォルトでは、この操作はすべてのロールのインスタンスを照会します。	Primary
RegionId	string	必須	インスタンスのリージョン ID。	cn-hangzhou
PageSize	integer	任意	各ページに返すエントリ数。有効な値：1～100。デフォルト値：30。	30
PageNumber	integer	任意	返すページ番号。	1
InstanceNetworkType	string	任意	インスタンスのネットワークタイプ。有効な値： Classic VPC	Classic
VpcId	string	任意	VPC (Virtual Private Cloud) の ID。	vpc-j6cjvqms29yxxxxxxxxxx
VSwitchId	string	任意	vSwitch の ID。	vsw-j6csw46bgrgkxxxxxxxxxx
DBInstanceClass	string	任意	インスタンスのインスタンスタイプ。詳細については、「インスタンスタイプ」をご参照ください。	mysql.n1.micro.1
EngineVersion	string	任意	データベースエンジンのバージョン。	5.7
NodeType	string	任意	データベースノードのタイプ。有効な値： Master：プライマリノード Slave：セカンダリノード	Master
PayType	string	任意	インスタンスの課金方法。有効な値： Postpaid：従量課金 Prepaid：サブスクリプションデフォルトでは、この操作はサポートされているいずれかの課金方法を使用するインスタンスを照会します。	Postpaid
ConnectionMode	string	任意	インスタンスの接続モード。有効な値： Standard：標準モード Safe：データベースプロキシモードデフォルトでは、この操作はサポートされているいずれかの接続モードを使用するインスタンスを照会します。	Standard
CurrentInstanceId	string	任意	現在のインスタンスの ID。	rm-uf6wjk5xxxxxxxxxx
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmy*****

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスパラメーター。
Items	object
DBInstance	array<object>	インスタンスの詳細で構成される配列。
	array<object>
Category	string	インスタンスの RDS エディション。有効な値： Basic：RDS Basic Edition HighAvailability：RDS High-availability Edition Finance：RDS Enterprise Edition	HighAvailability
ConnectionMode	string	インスタンスの接続モード。有効な値： Standard：標準モード Safe：データベースプロキシモード	Standard
CreateTime	string	インスタンスが作成された時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。	2018-11-05T11:26:02Z
DBInstanceClass	string	インスタンスのインスタンスタイプ。詳細については、「インスタンスタイプ」をご参照ください。	mysql.n1.micro.1
DBInstanceDescription	string	インスタンスの名前。長さは 2～256 文字である必要があります。値には、文字、数字、アンダースコア (_)、ハイフン (-) を含めることができます。値は文字で始まる必要があります。説明値は http:// または https:// で始めることはできません。	Test
DBInstanceId	string	インスタンスの ID。	rm-uf6wjk5xxxxxxxxxx
DBInstanceNetType	string	インスタンスのネットワーク接続タイプ。有効な値： Internet Intranet	Intranet
DBInstanceStatus	string	インスタンスのステータス。詳細については、「インスタンスの状態表」をご参照ください。	Running
DBInstanceStorageType	string	インスタンスのストレージタイプ。有効な値： local_ssd/ephemeral_ssd：ローカル SSD cloud_ssd：標準 SSD。 cloud_essd：ESSD (Enhanced SSD)	local_ssd
DBInstanceType	string	インスタンスのロール。有効な値： Primary：プライマリインスタンス Readonly：読み取り専用インスタンス Guard：ディザスタリカバリインスタンス Temp：一時インスタンス	Primary
DestroyTime	string	インスタンスが削除された時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。	2018-12-05T11:26:02Z
Engine	string	インスタンスのデータベースエンジン。有効な値： MySQL SQLServer PostgreSQL PPAS MariaDB	MySQL
EngineVersion	string	データベースエンジンのバージョン。	5.7
ExpireTime	string	インスタンスの有効期限が切れた時刻。時刻は ISO 8601 標準に準拠した yyyy-MM-ddTHH:mm:ssZ 形式で、UTC で表示されます。	2018-11-28T11:26:02Z
GuardDBInstanceId	string	ディザスタリカバリインスタンスの ID。このパラメーターは、インスタンスがプライマリインスタンスであり、ディザスタリカバリインスタンスを持つ場合にのみ返されます。	rm-uf64zsuxxxxxxxxxx
InsId	integer	インスタンスロールの ID。	1
InstanceNetworkType	string	インスタンスのネットワークタイプ。有効な値： Classic VPC	VPC
LockMode	string	インスタンスのロックモード。有効な値： Unlock：インスタンスはロックされていません。 ManualLock：インスタンスは手動でロックされています。 LockByExpiration：インスタンスは有効期限が切れると自動的にロックされます。 LockByRestoration：インスタンスはロールバック前に自動的にロックされます。 LockByDiskQuota：インスタンスはストレージ容量が使い果たされ、アクセスできなくなったため、自動的にロックされます。	Unlock
LockReason	string	インスタンスがロックされた理由。	instance_expired
MasterInstanceId	string	プライマリインスタンスの ID。このパラメーターの値が null の場合、インスタンスはプライマリインスタンスです。	rm-uf6wjk5xxxxxxxxxx
MutriORsignle	boolean	マルチリージョン展開が使用されているかどうかを示します。有効な値： true：マルチリージョン展開が使用されています。 false：マルチリージョン展開は使用されていません。	false
PayType	string	インスタンスの課金方法。有効な値： Postpaid：従量課金 Prepaid：サブスクリプション	Postpaid
ReadOnlyDBInstanceIds	object
ReadOnlyDBInstanceId	array<object>	プライマリインスタンスにアタッチされている読み取り専用インスタンスの ID で構成される配列。
	object
DBInstanceId	string	読み取り専用インスタンスの ID。	rm-bpxxxxxxxxx
RegionId	string	インスタンスのリージョン ID。	cn-hangzhou
ReplicateId	string	なし。	无
ResourceGroupId	string	リソースグループの ID。	rg-acfmyxxxxx
TempDBInstanceId	string	一時インスタンスの ID。	sub138xxxxx_rm-xxxxx
VSwitchId	string	vSwitch の ID。	vsw-uf6adz52c2pxxxxxxxxxx
VpcCloudInstanceId	string	VPC 内のインスタンスの ID。	rm-uf6wjk5xxxxxxxxxx
VpcId	string	VPC (Virtual Private Cloud) の ID。	vpc-bp1opxu1zkhxxxxxxxxxx
ZoneId	string	インスタンスのゾーン ID。	cn-hangzhou-h
PageNumber	integer	返されたページのページ番号。	12
PageRecordCount	integer	現在のページで返されたエントリ数。	10
RequestId	string	リクエストの ID。	1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC
TotalRecordCount	integer	返されたエントリの総数。	120

例

成功レスポンス

JSONJSON

{
  "Items": {
    "DBInstance": [
      {
        "Category": "HighAvailability",
        "ConnectionMode": "Standard",
        "CreateTime": "2018-11-05T11:26:02Z",
        "DBInstanceClass": "mysql.n1.micro.1",
        "DBInstanceDescription": "Test",
        "DBInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "DBInstanceNetType": "Intranet",
        "DBInstanceStatus": "Running",
        "DBInstanceStorageType": "local_ssd",
        "DBInstanceType": "Primary",
        "DestroyTime": "2018-12-05T11:26:02Z",
        "Engine": "MySQL",
        "EngineVersion": "5.7",
        "ExpireTime": "2018-11-28T11:26:02Z",
        "GuardDBInstanceId": "rm-uf64zsuxxxxxxxxxx",
        "InsId": 1,
        "InstanceNetworkType": "VPC",
        "LockMode": "Unlock",
        "LockReason": "instance_expired",
        "MasterInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "MutriORsignle": false,
        "PayType": "Postpaid",
        "ReadOnlyDBInstanceIds": {
          "ReadOnlyDBInstanceId": [
            {
              "DBInstanceId": "rm-bpxxxxxxxxx"
            }
          ]
        },
        "RegionId": "cn-hangzhou",
        "ReplicateId": "无",
        "ResourceGroupId": "rg-acfmyxxxxx",
        "TempDBInstanceId": "sub138xxxxx_rm-xxxxx",
        "VSwitchId": "vsw-uf6adz52c2pxxxxxxxxxx\t",
        "VpcCloudInstanceId": "rm-uf6wjk5xxxxxxxxxx",
        "VpcId": "vpc-bp1opxu1zkhxxxxxxxxxx",
        "ZoneId": "cn-hangzhou-h"
      }
    ]
  },
  "PageNumber": 12,
  "PageRecordCount": 10,
  "RequestId": "1E43AAE0-BEE8-43DA-860D-EAF2AA0724DC",
  "TotalRecordCount": 120
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ
400	InvalidDBInstanceType.ValueNotSupport	The specified parameter"DBInstanceType" is not valid.
400	ApiError	API error.
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	pay.noCreditCard	Account not bound to credit card.
400	Order.InstHasUnpaidOrder	There is an unpaid order for the service you have purchased. Please pay or void it before placing the order.
400	noAvailablePaymentMethod	No payment method is specified for your account. We recommend that you add a payment method.
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.
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.

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

変更履歴

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