DescribeDBInstanceAttribute操作を呼び出して、インスタンスの属性を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardbx:DescribeDBInstanceAttribute |
get |
*All Resource
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| RegionId |
string |
必須 |
インスタンスが存在するリージョン。 |
cn-hangzhou |
| DBInstanceName |
string |
必須 |
インスタンスの名前。 |
pxc-******** |
| ResourceGroupId |
string |
任意 |
リソースグループID。 |
rg-aekzaxhezhs5*** |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエストID。 |
9B2F3840-5C98-475C-B269-2D5C3A31797C |
| DBInstance |
object |
データベースインスタンス情報。 |
|
| Type |
string |
インスタンスタイプ。有効な値：
|
ReadWrite |
| Status |
string |
インスタンスのステータス。詳細については、インスタンスステータス一覧をご参照ください。 |
Running |
| RightsSeparationStatus |
string |
三権分立モードのステータス。有効な値：
|
disabled |
| DBNodeCount |
integer |
インスタンスノードの数。 |
2 |
| Expired |
string |
インスタンスの有効期限が切れているかどうかを示します。有効な値：
|
false |
| CreateTime |
string |
作成時刻。 |
2021-08-31T08:56:25.000+0000 |
| PayType |
string |
インスタンスの課金方式。有効な値：
|
Postpaid |
| Port |
string |
内部ネットワーク接続ポート。 |
3306 |
| LockMode |
string |
インスタンスのロックモード。有効な値：
|
Unlock |
| Description |
string |
インスタンスの説明。 |
test instance |
| ConnectionString |
string |
内部ネットワーク接続文字列。 |
pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com |
| StorageUsed |
integer |
使用済みストレージ容量（バイト単位）。 |
17042505728 |
| ExpireDate |
string |
有効期限。形式：yyyy-MM-ddTHH:mm:ss.sss+0000（UTC）。 |
2022-08-31T16:00:00.000+0000 |
| CommodityCode |
string |
インスタンスのコモディティコード。値はdrds_polarxpost_public_cnに固定されています。 |
drds_polarxpost_public_cn |
| MaintainStartTime |
string |
メンテナンスウィンドウの開始時刻。時刻はUTCです。コンソールに表示されるメンテナンスウィンドウを取得するには、8 時間を加算してください。 |
06:00 |
| DBInstanceType |
string |
インスタンスタイプ。有効な値：
|
ReadWrite |
| DBNodeClass |
string |
インスタンスのノード仕様。 |
polarx.x4.large.2e |
| LatestMinorVersion |
string |
インスタンスでサポートされている最新のマイナーエンジンバージョン。 |
polarx-kernel_5.4.11-16301083_xcluster-20210805 |
| MaintainEndTime |
string |
メンテナンスウィンドウの終了時刻。時刻はUTCです。コンソールに表示されるメンテナンスウィンドウを取得するには、8 時間を加算してください。 |
06:00 |
| DBType |
string |
データベースタイプ。値はpolarxに固定されています。 |
polarx |
| RightsSeparationEnabled |
boolean |
三権分立モードのステータス。有効な値：
|
false |
| VPCId |
string |
VPC ID。 |
vpc-xxxxx |
| MinorVersion |
string |
現在のマイナーエンジンバージョン。 |
polarx-kernel_5.4.11-16301083_xcluster-20210805 |
| RegionId |
string |
インスタンスが存在するリージョン。 |
cn-hangzhou |
| Network |
string |
インスタンスのネットワークタイプ。VPCのみサポートされ、Virtual Private Cloudを示します。 |
VPC |
| DBVersion |
string |
データベースバージョン。 |
5.5 |
| VSwitchId |
string |
vSwitch ID。 |
vsw-******** |
| ZoneId |
string |
インスタンスが存在するゾーン。 |
cn-hangzhou-a |
| Engine |
string |
データベースタイプ。値はpolarxに固定されています。 |
polarx |
| KindCode |
integer |
インスタンスのエンジンバージョン。内部パラメータです。 |
18 |
| Id |
string |
プライマリインスタンスのID。このパラメータが返されない場合、そのインスタンスはプライマリインスタンスです。 |
pxc-zkralxpc5d**** |
| DBNodes |
array<object> |
データベースノード情報。 |
|
|
object |
|||
| ComputeNodeId |
string |
コンピュートノードの名前。 |
pxc-i-******** |
| NodeClass |
string |
ノードの仕様。 |
polarx.x4.large.2e |
| DataNodeId |
string |
ストレージノードの名前。 |
pxc-xdb-xxxxxx |
| ZoneId |
string |
ノードが存在するゾーン。 |
cn-hangzhou-a |
| Id |
string |
論理ノードID。 |
pxi-********* |
| RegionId |
string |
ノードのリージョンID。 |
cn-hangzhou |
| ConnAddrs |
array<object> |
エンドポイント情報。 |
|
|
object |
|||
| Type |
string |
接続タイプ。VPCは内部ネットワーク接続を示します。PUBLICはパブリックネットワーク接続を示します。 |
VPC |
| VSwitchId |
string |
vSwitch ID。 |
vsw-********* |
| Port |
integer |
接続ポート番号。 |
3306 |
| VPCId |
string |
VPC ID。 |
vpc-xxxxxx |
| ConnectionString |
string |
エンドポイント。 |
polardbx-xxx.aliyuncs.com |
| VpcInstanceId |
string |
VPC 内の内部 CloudInstanceId。このパラメーターは無視できます。 |
pxc-zkralxpc5d**** |
| ReadDBInstances |
array |
読み取り専用インスタンス名のリスト。 |
|
|
string |
読み取り専用インスタンスの名前。 |
pxr-********* |
|
| ColumnarReadDBInstances |
array |
列ストア読み取り専用インスタンス情報。 |
|
|
string |
列ストア読み取り専用インスタンス情報。 |
xxx |
|
| ResourceGroupId |
string |
リソースグループID。 |
rg-********* |
| TagSet |
array<object> |
タグセット。 |
|
|
object |
|||
| Key |
string |
タグキー。 |
key2 |
| Value |
string |
タグ値。 |
value2 |
| CnNodeCount |
integer |
CNノードの数。 |
2 |
| DnNodeCount |
integer |
DNノードの数。 |
2 |
| CnNodeClassCode |
string |
CNノードの仕様。有効な値：
|
polarx.x4.xlarge.2e |
| DnNodeClassCode |
string |
DNノードの仕様。有効な値：
|
mysql.x8.large.25 |
| Series |
string |
インスタンスのエディション。有効な値：
|
enterprise |
| LTSVersions |
array |
||
|
string |
LTSバージョン番号。 |
X.X.X.X |
|
| TopologyType |
string |
トポロジタイプ。有効な値：
|
3azones |
| PrimaryZone |
string |
プライマリゾーン。 |
cn-shenzhen-e |
| SecondaryZone |
string |
セカンダリゾーン。 |
cn-shenzhen-a |
| TertiaryZone |
string |
3ゾーンデプロイメントのターシャリゾーン。 |
cn-shenzhen-e |
| DifferentDNSpec |
boolean |
インスタンスのDNノードの仕様が異なるかどうかを示します。有効な値：
|
false |
| ColumnarInstanceName |
string |
列ストアエンジンインスタンスの名前。 |
xxxx |
| CanNotCreateColumnar |
boolean |
インメモリ列インデックス機能がサポートされているかどうかを示します。 |
true |
| GdnInstanceName |
string |
||
| GdnMemberList |
array<object> |
||
|
object |
|||
| Role |
string |
||
| MemberName |
string |
||
| Status |
string |
||
| SpecCategory |
string |
||
| GdnRole |
string |
||
| PrimaryInstanceId |
string |
||
| StorageType |
string |
||
| CpuType |
string |
||
| EngineVersion |
string |
||
| DnStorageSpace |
string |
DNデータノードのディスク容量（GB 単位）。 |
|
| AiGatewayEnabled |
string |
例
成功レスポンス
JSONJSON
{
"RequestId": "9B2F3840-5C98-475C-B269-2D5C3A31797C",
"DBInstance": {
"Type": "ReadWrite",
"Status": "Running",
"RightsSeparationStatus": "disabled",
"DBNodeCount": 2,
"Expired": "false",
"CreateTime": "2021-08-31T08:56:25.000+0000",
"PayType": "Postpaid",
"Port": "3306",
"LockMode": "Unlock",
"Description": "test instance",
"ConnectionString": "pxc-sprpx766vo****.polarx.singapore.rds.aliyuncs.com",
"StorageUsed": 17042505728,
"ExpireDate": "2022-08-31T16:00:00.000+0000",
"CommodityCode": "drds_polarxpost_public_cn",
"MaintainStartTime": "06:00",
"DBInstanceType": "ReadWrite",
"DBNodeClass": "polarx.x4.large.2e",
"LatestMinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
"MaintainEndTime": "06:00",
"DBType": "polarx",
"RightsSeparationEnabled": false,
"VPCId": "vpc-xxxxx",
"MinorVersion": "polarx-kernel_5.4.11-16301083_xcluster-20210805",
"RegionId": "cn-hangzhou",
"Network": "VPC",
"DBVersion": "5.5",
"VSwitchId": "vsw-********",
"ZoneId": "cn-hangzhou-a",
"Engine": "polarx",
"KindCode": 18,
"Id": "pxc-zkralxpc5d****",
"DBNodes": [
{
"ComputeNodeId": "pxc-i-********",
"NodeClass": "polarx.x4.large.2e",
"DataNodeId": "pxc-xdb-xxxxxx",
"ZoneId": "cn-hangzhou-a",
"Id": "pxi-*********",
"RegionId": "cn-hangzhou"
}
],
"ConnAddrs": [
{
"Type": "VPC",
"VSwitchId": "vsw-*********",
"Port": 3306,
"VPCId": "vpc-xxxxxx",
"ConnectionString": "polardbx-xxx.aliyuncs.com",
"VpcInstanceId": "pxc-zkralxpc5d****"
}
],
"ReadDBInstances": [
"pxr-*********"
],
"ColumnarReadDBInstances": [
"xxx"
],
"ResourceGroupId": "rg-*********",
"TagSet": [
{
"Key": "key2",
"Value": "value2"
}
],
"CnNodeCount": 2,
"DnNodeCount": 2,
"CnNodeClassCode": "polarx.x4.xlarge.2e",
"DnNodeClassCode": "mysql.x8.large.25",
"Series": "enterprise",
"LTSVersions": [
"X.X.X.X"
],
"TopologyType": "3azones",
"PrimaryZone": "cn-shenzhen-e",
"SecondaryZone": "cn-shenzhen-a",
"TertiaryZone": "cn-shenzhen-e",
"DifferentDNSpec": false,
"ColumnarInstanceName": "xxxx",
"CanNotCreateColumnar": true,
"GdnInstanceName": "",
"GdnMemberList": [
{
"Role": "",
"MemberName": "",
"Status": ""
}
],
"SpecCategory": "",
"GdnRole": "",
"PrimaryInstanceId": "",
"StorageType": "",
"CpuType": "",
"EngineVersion": "",
"DnStorageSpace": "",
"AiGatewayEnabled": ""
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。