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

ContextDB-X インスタンスの情報を照会します。

操作説明

説明

PolarDB-X 2.0 の SQL 監査および分析機能は無料です。ただし、Simple Log Service ではストレージ容量、読み取りトラフィック、リクエスト数、データ変換、データ転送に対して料金が発生します。SQL 監査機能の詳細については、「SQL 監査および分析の有効化」を参照してください。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
RegionId	string	必須	リージョン ID。	cn-hangzhou
DBInstanceName	string	必須	インスタンス名。	pxc-********

レスポンスフィールド

フィールド	型	説明	例
	object
RequestId	string	リクエストの ID。	1A586DCB-39A6-4050-81CC-C7BD4CCDB49F
Data	object	インスタンスデータ。
Instance	object	インスタンス情報。
InstanceId	string		pxc-spsil01pww4hfz-mem
RegionId	string		ap-southeast-1
ZoneId	string		ap-southeast-1a
ClassCode	string		mysql.x2.large.2c
NodeCount	integer		1
CreateTime	string		2026-02-17T02:00:20Z
Status	string		Running
StorageType	string		local_ssd
VPCId	string		vpc-t4n4hf9xey7ea3lp4bwwx
VSwitchId	string		vsw-t4ny14pr37spmjsbv5dc2
OpenSearchInstanceName	string		pxs-********
ConnAddrs	array<object>
	object
NodeType	string		service
Type	string		VPC
VPCId	string		vpc-t4n4hf9xey7ea3lp4bwwx
VSwitchId	string		vsw-t4ny14pr37spmjsbv5dc2
Port	integer		3306
VpcInstanceId	string		pxc-spsil01pww4hfzjayd-cn-20251013180429
ConnectionString	string		pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com
ReplicaSets	array<object>
	array<object>
NodeType	string		service
InstanceId	string		pxc-hzrbqgiocrpu8a
ZoneId	string		cn-beijing-i
ClassCode	string		pg.x2.13large.2c
NodeCount	integer		1
CreateTime	string		2026-07-28T02:01:13Z
Status	string		enabled
StorageType	string		cloud_essd
ConnAddrs	array<object>
	object
NodeType	string		service
Type	string		RemoveHeader
VPCId	string		vpc-bp1550umsomy2mw24vhwl
VSwitchId	string		vsw-2zedp17pfss1133bvdizl
Port	integer		3306
VpcInstanceId	string		vpc-8vbdw66evguopfcfvieoi
ConnectionString	string		pxc-hzrlz8e3khuaoz.polarx.rds.aliyuncs.com
DBInstanceName	string		pxc-hzr9qzafkeury3
AccessDeniedDetail	object	アクセス拒否の詳細。
AuthAction	string	認証操作。	xxx
AuthPrincipalType	string	認証プリンシパルのタイプ。	222
AuthPrincipalOwnerId	string	認証プリンシパルのオーナー ID。	111
AuthPrincipalDisplayName	string	認証プリンシパルの表示名。	xxx
PolicyType	string	ポリシータイプ。	PRIORITY
NoPermissionType	string	不足している権限のタイプ。	ImplicitDeny
EncodedDiagnosticMessage	string	診断情報。	AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg==

例

成功レスポンス

JSONJSON

{
  "RequestId": "1A586DCB-39A6-4050-81CC-C7BD4CCDB49F",
  "Data": {
    "Instance": {
      "InstanceId": "pxc-spsil01pww4hfz-mem",
      "RegionId": "ap-southeast-1",
      "ZoneId": "ap-southeast-1a",
      "ClassCode": "mysql.x2.large.2c",
      "NodeCount": 1,
      "CreateTime": "2026-02-17T02:00:20Z",
      "Status": "Running",
      "StorageType": "local_ssd",
      "VPCId": "vpc-t4n4hf9xey7ea3lp4bwwx",
      "VSwitchId": "vsw-t4ny14pr37spmjsbv5dc2",
      "OpenSearchInstanceName": "pxs-********",
      "ConnAddrs": [
        {
          "NodeType": "service",
          "Type": "VPC",
          "VPCId": "vpc-t4n4hf9xey7ea3lp4bwwx",
          "VSwitchId": "vsw-t4ny14pr37spmjsbv5dc2",
          "Port": 3306,
          "VpcInstanceId": "pxc-spsil01pww4hfzjayd-cn-20251013180429",
          "ConnectionString": "pxc-spsil01pww4hfz.polarx.singapore.rds.aliyuncs.com"
        }
      ],
      "ReplicaSets": [
        {
          "NodeType": "service",
          "InstanceId": "pxc-hzrbqgiocrpu8a",
          "ZoneId": "cn-beijing-i",
          "ClassCode": "pg.x2.13large.2c",
          "NodeCount": 1,
          "CreateTime": "2026-07-28T02:01:13Z",
          "Status": "enabled",
          "StorageType": "cloud_essd",
          "ConnAddrs": [
            {
              "NodeType": "service",
              "Type": "RemoveHeader",
              "VPCId": "vpc-bp1550umsomy2mw24vhwl",
              "VSwitchId": "vsw-2zedp17pfss1133bvdizl",
              "Port": 3306,
              "VpcInstanceId": "vpc-8vbdw66evguopfcfvieoi",
              "ConnectionString": "pxc-hzrlz8e3khuaoz.polarx.rds.aliyuncs.com"
            }
          ]
        }
      ],
      "DBInstanceName": "pxc-hzr9qzafkeury3"
    }
  },
  "AccessDeniedDetail": {
    "AuthAction": "xxx",
    "AuthPrincipalType": "222",
    "AuthPrincipalOwnerId": "111",
    "AuthPrincipalDisplayName": "xxx",
    "PolicyType": "PRIORITY",
    "NoPermissionType": "ImplicitDeny",
    "EncodedDiagnosticMessage": "AQEAAAAAaKPfwjY0MzMyODRGLUZCQkQtNTA1RS04MUUxLTc5NTkzODk2MUIzMg=="
  }
}

エラーコード

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

変更履歴

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