查詢實例的連接信息。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息，可以在RAM權限策略語句的Action元素中使用，用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下：
- 操作：是指具體的權限點。
- 訪問級別：是指每個操作的訪問級別，取值為寫入（Write）、讀取（Read）或列出（List）。
- 資源類型：是指操作中支持授權的資源類型。具體說明如下：
- 對于必選的資源類型，用背景高亮的方式表示。
- 對于不支持資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指云產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限，操作才能成功。
| 操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
| gpdb:DescribeDBInstanceNetInfo | get |
|
| 無 |
請求參數
| 名稱 | 類型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| DBInstanceId | string | 是 | 實例 ID。 說明
您可以調用 DescribeDBInstances 接口查看目標地域下所有的 AnalyticDB PostgreSQL 實例的詳情，包括實例 ID。
| gp-0xin9q82c33xc**** |
| ConnectionString | string | 否 | 數據庫連接地址。 說明
如果不指定該參數，將會返回所有數據庫連接地址的相關信息。
| gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com |
返回參數
示例
正常返回示例
JSON格式
{
"RequestId": "7565770E-7C45-462D-BA4A-8A5396F2CAD1",
"DBInstanceNetInfos": {
"DBInstanceNetInfo": [
{
"VSwitchId": "vsw-0xi4kt4dho2kx79p1****",
"ConnectionString": "gp-0xin9q82c33xc****-master.gpdb.rds.aliyuncs.com",
"IPType": "Inner",
"Port": "3432",
"VpcInstanceId": "vpc-0xi8hbevlbj3bq0co****",
"VPCId": "vpc-0xi8hbevlbj3bq0co****",
"IPAddress": "127.0.0.1",
"AddressType": "Primary"
}
]
},
"InstanceNetworkType": "VPC"
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2023-07-31 | OpenAPI 入參發生變更 | 查看變更詳情 |