DescribeDBInstanceAttribute操作を呼び出して、インスタンスに関する詳細を照会できます。
デバッグ
リクエストパラメーター
項目 | データ型 | 必須/任意 | 例: | 説明 |
---|---|---|---|---|
操作 | String | 必須 | DescribeDBInstanceAttribute | 実行する操作です。 値をDescribeDBInstanceAttributeに設定します。 |
DBInstanceId | String | 必須 | rm-uf6wjk5 ***** | インスタンスの ID です。 1回のリクエストで最大30個のインスタンスIDを指定できます。 複数のインスタンスIDを指定する場合は、インスタンスIDをコンマ (,) で区切ります。 |
Expired | String | 任意 | 間違い | インスタンスの有効期限が切れるかどうかを指定します。 有効な値:
|
レスポンスパラメーター
項目 | データ型 | 例: | 説明 |
---|---|---|---|
RequestId | String | 1AD222E9-E606-4A42-BF6D-8A4442913CEF | リクエストの ID です。 |
項目 | DBInstanceAttributeの配列 | インスタンスに関する詳細で構成される配列。 |
|
DBInstanceAttribute | |||
VpcId | String | vpc-***** | インスタンスが属する仮想プライベートクラウド (VPC) のID。 |
CreationTime | String | 2011-05-30T12:11:04Z | インスタンスが作成された時間。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。 |
IncrementSourceDBInstanceId | String | rm-uf6wjk5 ***** | 増分データの送信元のインスタンスのID。 ディザスタリカバリインスタンスまたは読み取り専用インスタンスの増分データは、プライマリインスタンスから取得されます。 このパラメーターが返されない場合、インスタンスはプライマリインスタンスです。 |
MaintainTime | String | 00:00Z-02:00Z | インスタンスのメンテナンス期間。 時刻は UTC で表示されます。 ApsaraDB RDSコンソールに表示されるメンテナンスウィンドウは、このパラメーターの値に8時間を加えた値に等しいことに注意してください。 |
PayType | String | Postpaid | インスタンスの課金方法です。 有効な値:
|
AvailabilityValue | String | 100.0% | インスタンスの可用性ステータス (パーセンテージ) 。 |
EngineVersion | String | 5.5 | インスタンスのデータベースエンジンバージョンです。 |
DedicatedHostGroupId | String | dhg-7a9 ***** | インスタンスが属する専用クラスターのID。 |
ConnectionString | String | rm-uf6wjk5 ***** .mysql.rds.aliyuncs.com | インスタンスの内部エンドポイント。 |
SuperPermissionMode | String | 無効 | インスタンスが、システム管理者 (SA) アカウント、Active Directory (AD) アカウント、ホストアカウントなどのスーパーユーザーアカウントをサポートしているかどうかを示します。
|
InstanceNetworkType | String | Classic | インスタンスのネットワークタイプです。 有効な値:
|
MasterInstanceId | String | rm-uf6wjk5 ***** | プライマリインスタンスのID。 説明 このパラメーターが返されない場合、インスタンスはプライマリインスタンスです。 |
AutoUpgradeMinorVersion | String | Auto | インスタンスのマイナーエンジンバージョンを更新するために使用されるメソッド。 有効な値:
|
ExpireTime | String | 2019-03-27T16:00:00Z | インスタンスの有効期限が切れる時刻。 日時は ISO 8601 規格 (yyyy-MM-ddTHH:mm:ssZ 形式) に準拠します。 時刻は UTC で表示されます。 説明 従量課金インスタンスの有効期限はありません。 |
AccountMaxQuantity | Integer | 50 | インスタンスに作成できるアカウントの最大数。 |
マスターゾーン | String | 5454284 | プライマリゾーンのID。 |
GuardDBInstanceId | String | rm-uf64zsu ***** | インスタンスにアタッチされているディザスタリカバリインスタンスのID。 |
DBInstanceStorage | Integer | 10 | インスタンスのストレージ容量。 単位 : GB |
タイムゾーン | String | 中央標準時 | インスタンスのタイムゾーン。 |
LatestKernelVersion | String | rds_20201031 | インスタンスでサポートされている最新のマイナーエンジンバージョン。 |
TipsLevel | Integer | 1 | インスタンスで検出される例外の重大度。 このパラメーターは、インスタンスがRDS Standard EditionでMySQLを実行し、専用クラスターで作成された場合にのみ返されます。 有効な値:
|
ZoneId | String | cn-hangzhou-a | ゾーン ID。 |
MaxConnections | Integer | 60 | インスタンスによって許可される同時接続の最大数。 |
DBInstanceId | String | rm-uf6wjk5 ***** | インスタンスの ID です。 |
TempDBInstanceId | String | rm-uf64zsu ***** | インスタンスにアタッチされている一時インスタンスのID。 |
AdvancedFeatures | String | LinkedServer | インスタンスで有効になっている高度な機能。 複数の詳細フィーチャが有効になっている場合、詳細フィーチャはコンマ (,) で区切られます。 このパラメーターは、SQL Serverを実行するインスタンスでのみ使用できます。 有効な値:
|
DBInstanceStorageType | String | local_ssd | インスタンスのストレージタイプを示します。 有効な値:
|
DBInstanceMemory | Long | 4096 | インスタンスのメモリーサイズ。 単位:MB。 |
IPType | String | IPv4 | インスタンスによって使用されるIPアドレスのタイプ。 値はIPv4として固定されています。 |
ConsoleVersion | String | 2 | インスタンスによって使用されるプロキシのタイプ。 有効な値:
説明 このパラメーターの代わりにProxyTypeパラメーターを使用することを推奨します。 |
ConnectionMode | String | スタンダード | インスタンスの接続モード。 有効な値:
|
ポート | String | 3306 | インスタンスへの接続に使用される内部ポート番号。 |
LockMode | String | Unlock | インスタンスのロックモード。 有効な値:
|
GeneralGroupName | String | テストグループ | インスタンスが属する専用クラスターの名前。 このパラメーターは、インスタンスがRDS Standard EditionでMySQLを実行し、専用クラスターで作成された場合にのみ返されます。 |
VpcCloudInstanceId | String | vpc-23rsxdf ***** | VPC の ID です。 このパラメーターは、インスタンスがVPCにある場合にのみ返されます。 |
照合 | String | Chinese_PRC_CI_AS | インスタンスの文字セットの照合順序。 |
MaxIOPS | Integer | 150 | インスタンスが1秒あたりに処理できるI/Oリクエストの最大数。 |
MaxIOMBPS | Integer | 0メガバイト/秒 | 最大I/Oスループット。 単位:MB/秒。 |
ヒント | String | すべてが大丈夫です。 | インスタンスで検出された例外に関する情報。 このパラメーターは、インスタンスがRDS Standard EditionでMySQLを実行し、専用クラスターで作成された場合にのみ返されます。 |
SecurityIPList | String | 192.168.XX.XX/24 | IP アドレスホワイトリスト内の IP アドレス。 |
SecurityIPMode | String | normal | インスタンスのホワイトリストモード。 有効な値:
|
DBInstanceClassType | String | 秒 | インスタンスが属するインスタンスファミリー。 有効な値:
|
ProxyType | Integer | 1 | インスタンスでサポートされているプロキシのタイプ。 有効な値:
|
CurrentKernelVersion | String | rds_20181010 | インスタンスのマイナーエンジンバージョン。 |
DBInstanceDescription | String | Test database | インスタンスの説明。 |
DBInstanceCPU | String | 2 | インスタンスに設定されているコアの数。 |
DBInstanceNetType | String | インターネット | インスタンスが接続されているネットワークのタイプ。 有効な値:
|
DBInstanceType | String | Primary | インスタンスのタイプ。 有効な値:
|
LockReason | String | instance_expired | インスタンスがロックされた理由。 |
DBInstanceStatus | String | Running | インスタンスのステータス。 詳細は、「インスタンスの状態」をご参照ください。 |
DBMaxQuantity | Integer | 200 | インスタンスに作成できるデータベースの最大数。 |
RegionId | String | cn-hangzhou | インスタンスのリージョン ID です。 |
ReadonlyInstanceSQLDelayedTime | String | 30 | システムが読み取り専用インスタンスにデータをレプリケートするレイテンシ。 システムは、ReadonlyInstanceSQLDelayedTimeパラメーターで指定されたレイテンシで、プライマリインスタンスから読み取り専用インスタンスにデータをレプリケートします。 単位:秒。 |
VSwitchId | String | vsw-***** | VSwitch の ID です。 |
ResourceGroupId | String | rg-acfmy ***** | リソースグループの ID です。 |
カテゴリー | String | 基本 | インスタンスのRDSエディション。 有効な値:
|
DBInstanceClass | String | rds.mys2.small | インスタンスのインスタンスタイプ。 詳細については、「プライマリApsaraDB RDSインスタンスタイプ」をご参照ください。 |
Engine | String | MySQL | インスタンスのデータベースエンジン。 有効な値:
|
SlaveZones | SlaveZoneの配列 | セカンダリゾーンに関する詳細で構成される配列。 |
|
SlaveZone | |||
ZoneId | String | cn-hangzhou-a | インスタンスのゾーンを設定します 。 |
ReadOnlyDBInstanceIds | ReadOnlyDBInstanceIdの配列 | プライマリインスタンスにアタッチされた読み取り専用インスタンスのIDで構成される配列。 |
|
ReadOnlyDBInstanceId | |||
DBInstanceId | String | rm-bp ***** | 読み取り専用インスタンスのID。 |
Extra | オブジェクト | インスタンスに関する拡張情報。 |
|
DBInstanceIds | 文字列の配列 | rm-uf6wjk5 ***** | インスタンスの ID です。 |
DeletionProtection | ブール | 真実 | リリース保護機能が有効になっているかどうかを示します。 有効な値:
|
ServerlessConfig | オブジェクト | サーバーレスインスタンスの設定。 |
|
ScaleMin | double | 0.5 | RDSキャパシティーユニット (RCUs) の最小値。 |
ScaleMax | double | 8 | RCUsの最大値。 |
自動一時停止 | ブール | 真実 | サーバーレスインスタンスの自動起動および停止機能が有効になっているかどうかを示します。 有効な値:
説明 開始および停止機能を有効にした後、10分以内にインスタンスへの接続が確立されない場合、インスタンスは一時停止されます。 インスタンスへの接続が確立されると、インスタンスは自動的に再開されます。 |
SwitchForce | ブール | 偽 | サーバーレスインスタンスに対して強制スケーリング機能が有効になっているかどうかを示します。
説明 ほとんどの場合、ApsaraDB RDSは、ビジネス要件に基づいてリアルタイムでサーバーレスインスタンスのRCUを自動的にスケールインまたはスケールアウトします。 スケーリングがリアルタイムで有効にならない場合もあります。 強制スケーリング機能を有効にすると、インスタンスのRCUを強制的にスケールインまたはスケールアウトできます。 |
BabelfishConfig | オブジェクト | インスタンスのBabelfishの設定。 説明 このパラメーターは、Babelfishが有効になっているApsaraDB RDS for PostgreSQLインスタンスにのみ適しています。 詳細については、「バベルフィッシュ入門」をご参照ください。 |
|
BabelfishEnabled | String | 真実 | Babelfishを有効または無効にするスイッチ。 説明 ApsaraDB RDS for PostgreSQLインスタンスの購入時にBabelfishが有効になっている場合、このパラメーターはtrueに固定されます。 |
MigrationMode | String | single-db | バベルフィッシュの移行モード。 有効な値:
説明 Babelfishの移行モードの詳細については、「移行モード」をご参照ください。 |
kindCode | String | なし | 内部パラメーター。 この操作では、このパラメーターの値は返されません。 |
InstructionSetArch | String | x86 | インスタンスのアーキテクチャタイプ。 有効な値:
|
DBClusterNodes | DBClusterNodeの配列 | クラスター内のノードに関する情報。 |
|
DBClusterNode | |||
NodeRegionId | String | cn-beijing | リージョンのID。 |
NodeZoneId | String | cn-北京-h | ゾーン ID。 |
NodeId | String | rn-**** | ノードの ID です。 |
NodeRole | String | primary | ノード名 有効な値:
|
クラスコード | String | mysql.n2.medium.xc | ノードの仕様。 |
例
リクエストの例
http(s):// rds.aliyuncs.com/?Action=DescribeDBInstanceAttribute
&DBInstanceId=rm-uf6wjk5 *****
&期限切れ=偽
&共通リクエストパラメータ
正常に処理された場合のレスポンス例
XML
形式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeDBInstanceAttributeResponse>
<RequestId>1AD222E9-E606-4A42-BF6D-8A4442913CEF</RequestId>
<Items>
<VpcId>vpc-*****</VpcId>
<CreationTime>2011-05-30T12:11:04Z</CreationTime>
<IncrementSourceDBInstanceId>rm-uf6wjk5 *****</IncrementSourceDBInstanceId>
<MaintainTime>00:00Z-02:00Z</MaintainTime>
<PayType>Postpaid</PayType>
<AvailabilityValue>100.0%</AvailabilityValue>
<EngineVersion>5.5</EngineVersion>
<DedicatedHostGroupId>dhg-7a9 *****</DedicatedHostGroupId>
<ConnectionString>rm-uf6wjk5 ***** .mysql.rds.aliyuncs.com</ConnectionString>
<SuperPermissionMode> 無効 </SuperPermissionMode>
<InstanceNetworkType> クラシック </InstanceNetworkType>
<MasterInstanceId>rm-uf6wjk5 *****</MasterInstanceId>
<AutoUpgradeMinorVersion> 自動 </AutoUpgradeMinorVersion>
<ExpireTime>2019-03-27T16:00:00Z</ExpireTime>
<AccountMaxQuantity>50</AccountMaxQuantity>
<MasterZone>5454284</MasterZone>
<GuardDBInstanceId>rm-uf64zsu *****</GuardDBInstanceId>
<DBInstanceStorage>10</DBInstanceStorage>
<TimeZone> 中央標準時 </TimeZone>
<LatestKernelVersion>rds_20201031</LatestKernelVersion>
<TipsLevel>1</TipsLevel>
<ZoneId>cn-hangzhou-a</ZoneId>
<MaxConnections>60</MaxConnections>
<DBInstanceId>rm-uf6wjk5 *****</DBInstanceId>
<TempDBInstanceId>rm-uf64zsu *****</TempDBInstanceId>
<AdvancedFeatures>LinkedServer</AdvancedFeatures>
<DBInstanceStorageType>local_ssd</DBInstanceStorageType>
<DBInstanceMemory>4096</DBInstanceMemory>
<IPType>IPv4</IPType>
<ConsoleVersion>2</ConsoleVersion>
<ConnectionMode> 標準 </ConnectionMode>
<Port>3306</Port>
<LockMode>Unlock</LockMode>
<GeneralGroupName>TestGroup</GeneralGroupName>
<VpcCloudInstanceId>vpc-23rsxdf *****</VpcCloudInstanceId>
<Collation>Chinese_PRC_CI_AS</Collation>
<MaxIOPS>150</MaxIOPS>
<ヒント> 通常どおり実行 </ヒント>
<SecurityIPList>192.168.XX.XX/24</SecurityIPList>
<SecurityIPMode> 通常 </SecurityIPMode>
<DBInstanceClassType> </DBInstanceClassType>
<ProxyType>1</ProxyType>
<CurrentKernelVersion>rds_20181010</CurrentKernelVersion>
<DBInstanceDescription>Test database</DBInstanceDescription>
<DBInstanceCPU>2</DBInstanceCPU>
<DBInstanceNetType> インターネット </DBInstanceNetType>
<DBInstanceType> プライマリ </DBInstanceType>
<LockReason>instance_expired</LockReason>
<DBInstanceStatus>Running</DBInstanceStatus>
<DBMaxQuantity>200</DBMaxQuantity>
<RegionId>cn-hangzhou </RegionId>
<ReadonlyInstanceSQLDelayedTime>30</ReadonlyInstanceSQLDelayedTime>
<VSwitchId>vsw-*****</VSwitchId>
<ResourceGroupId>rg-acfmy *****</ResourceGroupId>
<カテゴリ> 基本 </カテゴリ>
<DBInstanceClass>rds.mys2.small</DBInstanceClass>
<Engine>MySQL</Engine>
<SlaveZones>
<ZoneId>cn-hangzhou-a</ZoneId>
</SlaveZones>
<ReadOnlyDBInstanceIds>
<DBInstanceId>rm-bp *****</DBInstanceId>
</ReadOnlyDBInstanceIds>
<エクストラ>
<DBInstanceIds>rm-uf6wjk5 *****</DBInstanceIds>
</エクストラ>
<DeletionProtection>true</DeletionProtection>
<ServerlessConfig>
<ScaleMin>0.5</ScaleMin>
<ScaleMax>8</ScaleMax>
<AutoPause>true</AutoPause>
<SwitchForce>false</SwitchForce>
</ServerlessConfig>
<BabelfishConfig>
<BabelfishEnabled>true</BabelfishEnabled>
<MigrationMode>single-db</MigrationMode>
</BabelfishConfig>
<kindCode> なし </kindCode>
<InstructionSetArch>x86</InstructionSetArch>
<DBClusterNodes>
<NodeRegionId>cn-beijing</NodeRegionId>
<NodeZoneId>cn-beijing-h</NodeZoneId>
<NodeId>rn-****</NodeId>
<NodeRole> プライマリ </NodeRole>
<ClassCode>mysql.n2.medium.xc</ClassCode>
</DBClusterNodes>
</アイテム>
</DescribeDBInstanceAttributeResponse>
JSON
形式
HTTP/1.1 200 OK
Content-Type:application/json
{
"RequestId" : "1AD222E9-E606-4A42-BF6D-8A4442913CEF" 、
"Items" : [ {
"VpcId" : "vpc-*****" 、
"CreationTime" : "2011-05-30T12:11:04Z" 、
"IncrementSourceDBInstanceId" : "rm-uf6wjk5 *****" 、
"MaintainTime" : "00:00Z-02:00Z" 、
"PayType" : "後払い" 、
"AvailabilityValue" : "100.0%" 、
"EngineVersion" : "5.5" 、
"DedicatedHostGroupId" : "dhg-7a9 *****" 、
"ConnectionString" : "rm-uf6wjk5 ***** .mysql.rds.aliyuncs.com" 、
"SuperPermissionMode" : "無効" 、
"InstanceNetworkType" : "クラシック" 、
"MasterInstanceId" : "rm-uf6wjk5 *****" 、
"AutoUpgradeMinorVersion" : "Auto" 、
"ExpireTime" : "2019-03-27T16:00:00Z" 、
"AccountMaxQuantity" : 50、
"MasterZone" : "5454284" 、
"GuardDBInstanceId" : "rm-uf64zsu *****" 、
"DBInstanceStorage" : 10、
"TimeZone" : "中央標準時" 、
"LatestKernelVersion" : "rds_20201031" 、
"TipsLevel" : 1、
"ZoneId" : "cn-hangzhou-a" 、
"MaxConnections" : 60、
"DBInstanceId" : "rm-uf6wjk5 *****" 、
"TempDBInstanceId" : "rm-uf64zsu *****" 、
"AdvancedFeatures" : "LinkedServer" 、
"DBInstanceStorageType" : "local_ssd" 、
"DBInstanceMemory" : 4096、
"IPType" : "IPv4" 、
"ConsoleVersion" : "2" 、
"ConnectionMode" : "標準" 、
"ポート" : "3306" 、
"LockMode" : "ロック解除" 、
"GeneralGroupName" : "TestGroup" 、
"VpcCloudInstanceId" : "vpc-23rsxdf *****" 、
「照合」: 「Chinese_PRC_CI_AS」、
"MaxIOPS" : 150、
"ヒント" : "通常通り実行" 、
"SecurityIPList" : "192.168.XX.XX/24" 、
"SecurityIPMode" : "normal" 、
"DBInstanceClassType" : "s" 、
"ProxyType" : 1、
"CurrentKernelVersion" : "rds_20181010" 、
"DBInstanceDescription": "テストデータベース" 、
"DBInstanceCPU" : "2" 、
"DBInstanceNetType" : "インターネット" 、
"DBInstanceType" : "プライマリ" 、
"LockReason" : "instance_expired" 、
"DBInstanceStatus" : "Running" 、
"DBMaxQuantity" : 200、
"RegionId" : "cn-hangzhou" 、
"ReadonlyInstanceSQLDelayedTime" : "30" 、
"VSwitchId" : "vsw-*****" 、
"ResourceGroupId" : "rg-acfmy *****" 、
"カテゴリ" : "基本" 、
"DBInstanceClass" : "rds.mys2.small" 、
"エンジン" : "MySQL" 、
"SlaveZones" : [ {
"ZoneId" : "cn-hangzhou-a"
} ],
"ReadOnlyDBInstanceIds" : [ {
"DBInstanceId" : "rm-bp *****"
} ],
"Extra" : {
"DBInstanceIds" : [ "rm-uf6wjk5 *****"]
},
"DeletionProtection" : true、
"ServerlessConfig" : {
"ScaleMin" : 0.5、
"ScaleMax" : 8、
"AutoPause" : true、
"SwitchForce" : false
},
"BabelfishConfig" : {
"BabelfishEnabled" : "true" 、
"MigrationMode" : "single-db"
},
"kindCode" : "なし" 、
"InstructionSetArch" : "x86" 、
"DBClusterNodes" : [ {
"NodeRegionId" : "cn-beijing" 、
"NodeZoneId" : "cn-beijing-h" 、
"NodeId" : "rn-****" 、
"NodeRole" : "primary" 、
"ClassCode" : "mysql.n2.medium.xc"
} ]
} ]
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
---|---|---|---|
400 | ConnectTimeoutRetryLater | 後で接続タイムアウトの再試行。 | インスタンスへの接続がタイムアウトした場合に返されるエラーメッセージ。 しばらくしてからもう一度お試しください。 |
400 | DataNotExist | データが存在しません。 | 利用可能なデータがない場合に返されるエラーメッセージ。 |
エラーコードの一覧については、「サービスエラーコード」をご参照ください。