DescribeDBInstances - PolarDB - Alibaba Cloud ドキュメントセンター

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

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

polardbx:DescribeDBInstances

get

*すべてのリソース。

*

なし

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	インスタンスのリージョン ID。	cn-hangzhou
PageNumber	integer	任意	ページ番号。ページは 1 から始まります。	1
PageSize	integer	任意	ページサイズ。有効な値:	30
ResourceGroupId	string	任意	リソースグループの ID。	rg-acfmyst47******
Tags	string	任意	タグのリスト。	[{\"TagKey\":\"test\",\"TagValue\":\"テスト値\"}]
InstanceId	string	任意	インスタンスの ID。	dinga93c84f4d***
Series	string	任意	インスタンスエディション。有効な値:	enterprise
MustHasCdc	boolean	任意	インスタンスにログエンジンが必要かどうかを指定します。	true
DbVersion	string	任意
Description	string	任意	データベースの説明。	app-test

レスポンスフィールド

フィールド	型	説明	例
	object	レスポンスボディ。
RequestId	string	リクエスト ID。	C458B1E8-1683-3645-B154-6BA32080EEA
PageNumber	integer	ページ番号。	1
PageSize	integer	ページサイズ。	30
TotalNumber	integer	エントリの総数。	30
DBInstances	array<object>	インスタンスのリスト。
	array<object>	インスタンスの詳細。
Type	string	インスタンスタイプ。	ReadWrite
Status	string	インスタンスステータス。詳細については、「インスタンスステータステーブル」を参照してください。	Running
CommodityCode	string	商品コード。	drds_polarxpre_public_cn
ExpireTime	string	有効期限の時間。	2021-12-01T16:00:00.000+0000
Expired	boolean	インスタンスが期限切れかどうかを示します。	false
CreateTime	string	作成時間。	2021-11-01T03:49:50.000+0000
PayType	string	インスタンスの課金方法。有効な値:	Prepaid
LockReason	string	ロックの理由。	Overdue
DBType	string	データベースタイプ。	polarx
LockMode	string	インスタンスがロック済みかどうかを示します。	Unlock
VPCId	string	VPC の ID。	VPCID
MinorVersion	string	現在の Milvus バージョン。	polarx-kernel_5.4.12-16349923_xcluster-20210926
RegionId	string	リージョン ID。	cn-hangzhou
Network	string	ネットワークタイプ。	VPC
DBVersion	string	データベースエンジンのバージョン。	5.7
Description	string	データベースの説明。	Test
NodeClass	string	ノードスペック。	polarx.x4.large.2e
StorageUsed	integer	ストレージの使用量。	40658534400
NodeCount	integer	ノードの数。	5
ZoneId	string	ゾーンの ID。	cn-hangzhou-g
Engine	string	エンジンタイプ。	polarx
Id	string	インスタンスの ID。	pxc-hzr2yeov******
Nodes	array<object>	ノードのリスト。
	object	ノードのリスト。
ZoneId	string	ゾーン ID。	cn-hangzhou-g。
Id	string	ノード ID。	pxi-zd89wrzqh******
RegionId	string	リージョン ID。	cn-hangzhou-g-aliyun。
ClassCode	string	インスタンスの仕様。	polarx.x4.large.2e。
Name	string
ReadDBInstances	array	読み取り専用インスタンスのリスト。
	string	読み取り専用インスタンスの名前。	pxr-hzr2yeov******
ColumnarReadDBInstances	array	列のストア読み取り専用インスタンス情報。
	string	列のストア読み取り専用インスタンス情報。	xxxxxxxx
ResourceGroupId	string	リソースグループの ID。	rg-xxxxxx
TagSet	array<object>	タグのセット。
	object	タグのセット。
Key	string	タグキー。	key1
Value	string	タグ値。	値1
DBInstanceName	string	データベースインスタンス名。	pxc-xxxxx
DnNodeCount	integer	DN ノードの数。	2
CnNodeCount	integer	CN ノードの数。	2
CnNodeClassCode	string	CN ノードのノードスペック。	polarx.x4.large.2e
DnNodeClassCode	string	DN ノードのノードスペック。	mysql.n4.medium.25
Series	string	インスタンスエディション。有効な値:	enterprise
ContainBinlogX	boolean	インスタンスにマルチストリームログサービスが含まれているかどうかを指定します。有効な値:	true
SupportBinlogX	boolean	インスタンスがマルチストリームをサポートしているかどうかを示します。有効な値:	true
CdcInstanceName	string	ログノードの名前。	pxc-c-dmlgit****
TopologyType	string	トポロジータイプ。	3aゾーン
TertiaryZone	string	3 ゾーン Deployment の第 3 アクティブなゾーン。	cn-hangzhou-k
PrimaryZone	string	プライマリゾーン。	cn-hangzhou-j
SecondaryZone	string	セカンダリゾーン。	cn-hangzhou-l
ColumnarInstanceName	string	列のストアエンジンインスタンスの名前。	xxxxxxxx
isInGdn	boolean
gdnRole	string
CpuType	string
PrimaryInstanceId	string
StorageType	string
EngineVersion	string

例

成功レスポンス

JSONJSON

{
  "RequestId": "C458B1E8-1683-3645-B154-6BA32080EEA。",
  "PageNumber": 1,
  "PageSize": 30,
  "TotalNumber": 30,
  "DBInstances": [
    {
      "Type": "ReadWrite。",
      "Status": "Running。",
      "CommodityCode": "drds_polarxpre_public_cn。",
      "ExpireTime": "2021-12-01T16:00:00.000+0000",
      "Expired": true,
      "CreateTime": "2021-11-01T03:49:50.000+0000",
      "PayType": "Prepaid。",
      "LockReason": "Overdue.",
      "DBType": "polarx。",
      "LockMode": "Unlock。",
      "VPCId": "VPCID。",
      "MinorVersion": "polarx-kernel_5.4.12-16349923_xcluster-20210926",
      "RegionId": "cn-hangzhou。",
      "Network": "VPC。",
      "DBVersion": "5.7",
      "Description": "Test.",
      "NodeClass": "polarx.x4.large.2e。",
      "StorageUsed": 40658534400,
      "NodeCount": 5,
      "ZoneId": "cn-hangzhou-g。",
      "Engine": "polarx。",
      "Id": "pxc-hzr2yeov******",
      "Nodes": [
        {
          "ZoneId": "cn-hangzhou-g。",
          "Id": "pxi-zd89wrzqh******",
          "RegionId": "cn-hangzhou-g-aliyun。",
          "ClassCode": "polarx.x4.large.2e。",
          "Name": ""
        }
      ],
      "ReadDBInstances": [
        "pxr-hzr2yeov******"
      ],
      "ColumnarReadDBInstances": [
        "xxxxxxxx。"
      ],
      "ResourceGroupId": "rg-xxxxxx。",
      "TagSet": [
        {
          "Key": "key1",
          "Value": "値1"
        }
      ],
      "DBInstanceName": "pxc-xxxxx。",
      "DnNodeCount": 2,
      "CnNodeCount": 2,
      "CnNodeClassCode": "polarx.x4.large.2e。",
      "DnNodeClassCode": "mysql.n4.medium.25",
      "Series": "enterprise。",
      "ContainBinlogX": true,
      "SupportBinlogX": true,
      "CdcInstanceName": "pxc-c-dmlgit****",
      "TopologyType": "3 ゾーン",
      "TertiaryZone": "cn-hangzhou-k。",
      "PrimaryZone": "cn-hangzhou-j。",
      "SecondaryZone": "cn-hangzhou-l。",
      "ColumnarInstanceName": "xxxxxxxx。",
      "isInGdn": false,
      "gdnRole": "",
      "CpuType": "",
      "PrimaryInstanceId": "",
      "StorageType": "",
      "EngineVersion": ""
    }
  ]
}

エラーコード

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

変更履歴

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