DescribeDBInstanceAttribute を使用してインスタンスの詳細をクエリ - AnalyticDB

AnalyticDB for PostgreSQL インスタンスの詳細情報を照会します。

操作説明

操作手順

この API は、通常、AnalyticDB for PostgreSQL インスタンスのスペック、ネットワークタイプ、インスタンスステータスなどの情報を表示するために使用されます。

クエリ/秒 (QPS) 制限

この API のデフォルト QPS 制限は、ユーザーあたり 1 秒あたり 1000 クエリです。この制限を超えると、API 呼び出しがレート制限され、ビジネス運用に影響を及ぼす可能性があります。適切に API を呼び出してください。

今すぐお試しください

この 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 ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

gpdb:DescribeDBInstanceAttribute

get

*DBInstance

acs:gpdb:*:{#accountId}:dbinstance/{#DBInstanceId}

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ResourceGroupId	string	任意	このパラメーターは非推奨であり、指定する必要はありません。	null
DBInstanceId	string	必須	インスタンス ID。説明ターゲットリージョン内のすべての AnalyticDB for PostgreSQL インスタンスのインスタンス ID を表示するには、DescribeDBInstances API を呼び出すことができます。	gp-bp13ue79qk8y1****

レスポンスフィールド

フィールド	型	説明	例
	object
Items	object
DBInstanceAttribute	array<object>	インスタンス詳細のリスト。
	array<object>	詳細。
AvailabilityValue	string	現在のインスタンス可用性ステータスをパーセント (%) で照会します。説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	100.0%
ConnectionMode	string	アクセスモード。有効な値は以下のとおりです。 Performance：標準アクセスモード。 Safty：高セキュリティアクセスモード。 LVS：LVS リンクモード。	LVS
ConnectionString	string	インスタンスの接続アドレス。	gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com
CoreVersion	string	マイナーエンジンバージョン番号。	mm.v6.3.10.1-202207141918
CpuCores	integer	計算ノード上の CPU コア数（コア単位）。	2
CpuCoresPerNode	integer	ノードあたりの CPU コア数。説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	0
CreationTime	string	インスタンスの作成時刻。	2022-08-11T09:16:26Z
DBInstanceCategory	string	インスタンスエディション。有効な値は以下のとおりです。 Basic：Basic Edition。 HighAvailability：High-availability Edition。	HighAvailability
DBInstanceClass	string	インスタンスタイプ。説明このパラメーターは、ストレージ予約モードのインスタンスにのみ適用されます。	gpdb.group.segsdx1
DBInstanceClassType	string	インスタンスファミリー。有効な値は以下のとおりです。 s：共有タイプ。 x：汎用タイプ。 d：専用プラン。 h：専用物理マシン。	x
DBInstanceCpuCores	integer	CPU コア数。	2
DBInstanceDescription	string	インスタンスの説明。	gp-bp13ue79qk8y1****
DBInstanceDiskMBPS	integer	計算グループの最大 BPS（ディスクスループット）、Mbps 単位。説明このパラメーターは、ストレージ予約モードのインスタンスにのみ適用されます。	0
DBInstanceGroupCount	string	計算グループの数。説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	0
DBInstanceId	string	インスタンス ID。	gp-bp13ue79qk8y1****
DBInstanceMemory	integer	計算ノードのメモリ。説明単位は、予約済みストレージモードでは MB、Serverless モードおよびエラスティックストレージモードでは GB です。	16
DBInstanceMode	string	インスタンスのリソースタイプ。有効な値は以下のとおりです。 Serverless：Serverless モード。 StorageElastic：ストレージエラスティシティモード。 Classic：予約済みストレージモード。	StorageElastic
DBInstanceNetType	string	このパラメーターは非推奨であり、値は返されません。	null
DBInstanceStatus	string	インスタンスステータス。詳細については、DBInstanceStatus パラメーターの補足説明をご参照ください。	Running
DBInstanceStorage	integer	レプリカあたりの最大ストレージ容量（GB 単位）。	50
DeployMode	string	デプロイメントモード	single
EncryptionKey	string	暗号化キー。説明このパラメーターは、ディスク暗号化が有効になっているインスタンスに対してのみ返されます。	0d2470df-da7b-4786-b981-************
EncryptionType	string	暗号化タイプ。有効な値は以下のとおりです。 CloudDisk：ディスク暗号化。説明このパラメーターは、ディスク暗号化が有効になっているインスタンスに対してのみ返されます。	CloudDisk
Engine	string	データベースエンジン。	gpdb
EngineVersion	string	データベースバージョン。	6.0
ExpireTime	string	インスタンスの有効期限（UTC）。説明従量課金インスタンスの有効期限は `2999-09-08T16:00:00Z` です。	2999-09-08T16:00:00Z
HostType	string	計算グループのマシンタイプ。有効な値は以下のとおりです。 0：SSD 1：HDD 説明このパラメーターは、ストレージ予約モードのインスタンスにのみ適用されます。	0
IdleTime	integer	アイドル時のリリース待機時間（秒単位）。説明このパラメーターは、Serverless 自動スケジューリングモードのインスタンスに対してのみ返されます。	600
InstanceNetworkType	string	インスタンスのネットワークタイプ。有効な値は以下のとおりです。 Classic：クラシックネットワーク。 VPC：VPC ネットワーク。	VPC
LockMode	string	ロックモード。有効な値は以下のとおりです。 Unlock：正常。 ManualLock：手動でロックされています。 LockByExpiration：インスタンスの有効期限切れにより自動ロックされています。 LockByRestoration：インスタンスロールバック前に自動ロックされています。 LockByDiskQuota：インスタンスストレージ容量がいっぱいになったため自動ロックされています。	Unlock
LockReason	string	このパラメーターは非推奨であるため、パラメーター値は返されません。	null
MaintainEndTime	string	メンテナンス終了時刻。	22:00Z
MaintainStartTime	string	メンテナンスウィンドウの開始時刻。	18:00Z
MasterCU	integer	マスターリソース。	4
MasterNodeNum	integer	マスターノードの数量。	1
MaxConnections	integer	インスタンスの同時接続数の上限。説明このパラメーターは、ストレージ予約モードのインスタンスにのみ適用されます。	500
MemoryPerNode	integer	レプリカあたりのメモリサイズ。単位については MemoryUnit パラメーターをご参照ください。説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	0
MemorySize	integer	計算ノードのメモリサイズ。説明単位は、予約済みストレージモードでは MB、Serverless モードおよびエラスティックストレージモードでは GB です。	16
MemoryUnit	string	メモリ単位。説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	GB
MinorVersion	string	マイナーエンジンバージョン。	6.3.10.1-202207141918
PayType	string	課金タイプ。有効な値は以下のとおりです。 Postpaid：従量課金。 Prepaid：サブスクリプション。	Postpaid
Port	string	インスタンスのポート番号。	5432
ProdType	string	プロダクトタイプ	standard
ReadDelayTime	string	このパラメーターは非推奨であるため、値は返されません。	null
RegionId	string	リージョン ID。	cn-hangzhou
ResourceGroupId	string	インスタンスが属するリソースグループの ID。	rg-bp67acfmxazb4p****
RunningTime	string	インスタンスの実行時間。	4 days 22:58:55
SecurityIPList	string	このパラメーターは非推奨であり、値は返されません。	null
SegDiskPerformanceLevel	string	パフォーマンスレベル (PL)。現在は PL1 のみサポートされています。	PL1
SegNodeNum	integer	セグメントノードの数。説明このパラメーターは、エラスティックストレージモードおよび手動スケジューリングの Serverless モードのインスタンスにのみ適用されます。	4
SegmentCounts	integer	計算グループの数。説明このパラメーターは、ストレージ予約モードのインスタンスにのみ適用されます。	0
ServerlessMode	string	Serverless インスタンスモード。有効な値は以下のとおりです。 Manual：手動スケジュール。 Auto：自動スケジュール。説明このパラメーターは、Serverless インスタンスに対してのみ返されます。 AnalyticDB for PostgreSQL Serverless の自動スケジュールモードは現在、招待プレビュー中です。この機能を使用するには、「チケットを送信」してアクセス権をリクエストしてください。	Auto
ServerlessResource	integer	計算リソースのしきい値（ACU 単位）。説明このパラメーターは、Serverless 自動スケジューリングモードのインスタンスに対してのみ返されます。	32
StandbyZoneId	string	セカンダリゾーン ID。	cn-hangzhou-i
StartTime	string	インスタンスの実行開始時刻。	2022-08-11T09:26:43Z
StoragePerNode	integer	レプリカあたりのストレージサイズ。単位については StorageUnit パラメーターをご参照ください。説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	0
StorageSize	integer	バケットサイズ（GB 単位）。	50
StorageType	string	ストレージクラス。有効な値は以下のとおりです。 cloud_essd：ESSD (エンタープライズ SSD)。 cloud_efficiency：Ultra ディスク。説明このパラメーターは、ストレージエラスティシティモードのインスタンスにのみ適用されます。	cloud_essd
StorageUnit	string	ストレージ単位。有効な値は以下のとおりです。 GB SSD TB SSD GB HDD 説明このパラメーターは、予約済みストレージモードのインスタンスにのみ適用されます。	GB SSD
SupportRestore	boolean	バックアップ復元がサポートされているかどうかを示します。有効な値は以下のとおりです。 true：バックアップ復元がサポートされています。 false：バックアップ復元はサポートされていません。	true
Tags	object
Tag	array<object>	タグのキーと値のペア。
	object	タグの詳細は以下のとおりです。
Key	string	タグキー。	test-key
Value	string	タグ値。	test-value
VSwitchId	string	vSwitch ID。	vsw-bp1cpq8mr64paltkb****
VectorConfigurationStatus	string	ベクトルエンジン最適化が有効かどうかを示します。有効な値は以下のとおりです。 enabled：ベクトルエンジン最適化が有効になっています。 disabled：ベクトルエンジン最適化が無効になっています。	enabled
VpcId	string	VPC ID。	vpc-bp19ame5m1r3oejns****
ZoneId	string	ゾーン ID。	cn-hangzhou-j
SegmentAISpec	string	インスタンスの計算 AI ノードスペック。計算ノードが AI ノードでない場合は、空の値が返されます。	ADB.AIMedium.2
MasterAISpec	string	インスタンスのマスター AI ノードスペックを返します。マスターノードが AI ノードでない場合は、空の値が返されます。	ADB.AIMedium.2
CacheStorageSize	string	キャッシュディスクの合計サイズ（GB 単位）。	64
InstanceSpec	string	計算ノードのノードスペック。	2C16G
GraphEngineStatus	string	グラフエンジンが有効かどうかを示します。有効な値は以下のとおりです。 enabled：グラフエンジンが有効になっています。 disabled：グラフエンジンが無効になっています。	enabled
RequestId	string	リクエスト ID。	5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68

DBInstanceStatus パラメーターの補足説明

DBInstanceStatus パラメーターには、以下の値を設定できます。

Creating：作成中。
Running：使用中。
Deleting：削除中。
Rebooting：再起動中。
DBInstanceClassChanging：スケールアップまたはスケールダウン中。
Transfering：移行中。
EngineVersionUpgrading：バージョンアップ中。
TransferingToOtherInstance：別の AnalyticDB for PostgreSQL インスタンスにデータを移行中。
GuardDBInstanceCreating：ディザスタリカバリインスタンスを作成中。
Restoring：バックアップからの復元中。
Importing：データインポート中。
ImportingFromOtherInstance：別の AnalyticDB for PostgreSQL インスタンスからデータをインポート中。
DBInstanceNetTypeChangin：内部ネットワークとパブリックネットワークのタイプを切り替え中。
GuardSwitching：フェイルオーバー中。

例

成功レスポンス

JSONJSON

{
  "Items": {
    "DBInstanceAttribute": [
      {
        "AvailabilityValue": "100.0%",
        "ConnectionMode": "LVS",
        "ConnectionString": "gp-bp13ue79qk8y1****-master.gpdb.rds.aliyuncs.com",
        "CoreVersion": "mm.v6.3.10.1-202207141918",
        "CpuCores": 2,
        "CpuCoresPerNode": 0,
        "CreationTime": "2022-08-11T09:16:26Z",
        "DBInstanceCategory": "HighAvailability",
        "DBInstanceClass": "gpdb.group.segsdx1",
        "DBInstanceClassType": "x",
        "DBInstanceCpuCores": 2,
        "DBInstanceDescription": "gp-bp13ue79qk8y1****",
        "DBInstanceDiskMBPS": 0,
        "DBInstanceGroupCount": "0",
        "DBInstanceId": "gp-bp13ue79qk8y1****",
        "DBInstanceMemory": 16,
        "DBInstanceMode": "StorageElastic",
        "DBInstanceNetType": "null",
        "DBInstanceStatus": "Running",
        "DBInstanceStorage": 50,
        "DeployMode": "single",
        "EncryptionKey": "0d2470df-da7b-4786-b981-************",
        "EncryptionType": "CloudDisk",
        "Engine": "gpdb",
        "EngineVersion": "6.0",
        "ExpireTime": "2999-09-08T16:00:00Z",
        "HostType": "0",
        "IdleTime": 600,
        "InstanceNetworkType": "VPC",
        "LockMode": "Unlock",
        "LockReason": "null",
        "MaintainEndTime": "22:00Z",
        "MaintainStartTime": "18:00Z",
        "MasterCU": 4,
        "MasterNodeNum": 1,
        "MaxConnections": 500,
        "MemoryPerNode": 0,
        "MemorySize": 16,
        "MemoryUnit": "GB",
        "MinorVersion": "6.3.10.1-202207141918",
        "PayType": "Postpaid",
        "Port": "5432",
        "ProdType": "standard",
        "ReadDelayTime": "null",
        "RegionId": "cn-hangzhou",
        "ResourceGroupId": "rg-bp67acfmxazb4p****",
        "RunningTime": "4 days 22:58:55",
        "SecurityIPList": "null",
        "SegDiskPerformanceLevel": "PL1",
        "SegNodeNum": 4,
        "SegmentCounts": 0,
        "ServerlessMode": "Auto",
        "ServerlessResource": 32,
        "StandbyZoneId": "cn-hangzhou-i",
        "StartTime": "2022-08-11T09:26:43Z",
        "StoragePerNode": 0,
        "StorageSize": 50,
        "StorageType": "cloud_essd",
        "StorageUnit": "GB SSD",
        "SupportRestore": true,
        "Tags": {
          "Tag": [
            {
              "Key": "test-key",
              "Value": "test-value"
            }
          ]
        },
        "VSwitchId": "vsw-bp1cpq8mr64paltkb****",
        "VectorConfigurationStatus": "enabled",
        "VpcId": "vpc-bp19ame5m1r3oejns****",
        "ZoneId": "cn-hangzhou-j",
        "SegmentAISpec": "ADB.AIMedium.2",
        "MasterAISpec": "ADB.AIMedium.2",
        "CacheStorageSize": "64",
        "InstanceSpec": "2C16G",
        "GraphEngineStatus": "enabled"
      }
    ]
  },
  "RequestId": "5E6EDEB8-D73E-5F2D-B948-86C8AEB05A68"
}

エラーコード

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

変更履歴

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