インスタンスのエンドポイントを使用して、インスタンスの基本情報を取得します。
今すぐお試しください
テスト
RAM 認証
|
アクション |
アクセスレベル |
リソースタイプ |
条件キー |
依存アクション |
|
polardbx:DescribeDBInstanceViaEndpoint |
none |
*すべてのリソース。
|
なし | なし |
リクエストパラメーター
|
パラメーター |
型 |
必須 / 任意 |
説明 |
例 |
| Endpoint |
string |
必須 |
インスタンスのエンドポイント。 |
pxc-hz*******.polarx.rds.aliyuncs.com |
| RegionId |
string |
必須 |
リージョン ID。 |
cn-hangzhou |
レスポンスフィールド
|
フィールド |
型 |
説明 |
例 |
|
object |
|||
| RequestId |
string |
リクエスト ID。 |
14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC |
| DBInstance |
object |
インスタンス情報。 |
|
| Type |
string |
インスタンスタイプ。有効な値: |
ReadWrite |
| Status |
string |
インスタンスステータス。詳細については、「インスタンスステータス」を参照してください。 |
Running |
| RightsSeparationStatus |
string |
3 ロールモードのステータス。有効な値: |
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 |
インスタンスの説明。 |
テストインスタンス |
| 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-カーネル_5.4.11-16301083_xcluster-20210805 |
| MaintainEndTime |
string |
メンテナンスウィンドウの終了時刻。時刻は UTC です。コンソールに表示されるメンテナンスウィンドウを取得するには、8 時間を加算してください。 |
06:00 |
| DBType |
string |
データベースタイプ。値は polarx に固定されています。 |
polarx |
| RightsSeparationEnabled |
boolean |
3 ロールモードが有効かどうかを示します。有効な値: |
false |
| VPCId |
string |
VPC の ID。 |
vpc-xxxxx |
| MinorVersion |
string |
現在のカーネルバージョン。 |
polarx-カーネル_5.4.11-16301083_xcluster-20210805 |
| RegionId |
string |
インスタンスが存在するリージョン。 |
cn-hangzhou |
| Network |
string |
インスタンスのネットワークタイプ。VPC のみがサポートされており、仮想非公開クラウド (VPC) を示します。 |
VPC |
| DBVersion |
string |
データベースのバージョン。 |
5.5 |
| VSwitchId |
string |
vSwitch の ID。 |
vsw-******** |
| ZoneId |
string |
インスタンスが存在するゾーン。 |
cn-hangzhou-a |
| Engine |
string |
データベースタイプ。値は MySQL に固定されています。 |
MySQL |
| KindCode |
integer |
インスタンスの DPI エンジンバージョン。これは内部パラメーターです。 |
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 内の内部クラウドインスタンス ID。このパラメーターは無視できます。 |
pxc-zkralxpc5d**** |
| ReadDBInstances |
array |
読み取り専用インスタンスの名前。 |
|
|
string |
読み取り専用インスタンスの名前。 |
pxr-********* |
|
| ResourceGroupId |
string |
リソースグループ ID。 |
rg-xxxx |
| 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 |
LTS バージョン番号。 |
|
|
string |
LTS バージョン番号。 |
X.X.X.X |
例
成功レスポンス
JSONJSON
{
"RequestId": "14036EBE-CF2E-44DB-ACE9-AC6157D3A6FC",
"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": "MySQL",
"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-*********"
],
"ResourceGroupId": "rg-xxxx",
"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"
]
}
}エラーコード
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。