全部產品
Search
文件中心

PolarDB:DescribeNetworkChannel - 查詢網路通道

更新時間:Sep 17, 2025

查詢網路通道

調試

您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。

調試

授權資訊

下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:

  • 操作:是指具體的許可權點。

  • 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。

  • 資源類型:是指操作中支援授權的資源類型。具體說明如下:

    • 對於必選的資源類型,用前面加 * 表示。

    • 對於不支援資源級授權的操作,用全部資源表示。

  • 條件關鍵字:是指雲產品自身定義的條件關鍵字。

  • 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。

操作

存取層級

資源類型

條件關鍵字

關聯操作

polardb:DescribeNetworkChannel

get

*DBCluster

acs:polardb:{#regionId}:{#accountId}:dbcluster/{#DbClusterId}

請求參數

名稱

類型

必填

描述

樣本值

ResourceGroupId

string

資源群組 ID。

rg-************

DBClusterId

string

源執行個體名

pc-*************

ChannelName

string

通道名稱

ch4

VpcId

string

訪問端點所在的專用網路 ID。

vpc-bp1qpo0kug3a20qqe****

RegionId

string

地區 ID。

cn-hangzhou

ClientToken

string

該參數用於保證請求的等冪性。由用戶端產生該參數值,保證在不同請求間該參數值的唯一性。該參數區分大小寫、長度不超過 64 個 ASCII 字元。

6000170000591aed949d0f54a343f1a4233c1e7d1c5******

返回參數

名稱

類型

描述

樣本值

object

Schema of Response

ChannelInfos

array<object>

通道網路列表

object

通道網路資料

ChannelName

string

通道名稱

ch4

DBClusterId

string

源執行個體名

pc-*************

Notes

string

備忘資訊。

test update

RegionId

string

地區 ID。

cn-hangzhou

TargetDBClusterId

string

目標執行個體名。

pc-*************

TargetIp

string

目標執行個體 IP。

33.*.*.240

TargetPort

string

目標執行個體連接埠。

3389

TargetType

string

目標執行個體類型。

polardb_for_postgresql

VpcId

string

訪問端點所在的專用網路 ID。

vpc-2ze13g2c6j7j2jl*******

RequestId

string

Id of the request

925B84D9-CA72-432C-95CF-738C22******

樣本

正常返回樣本

JSON格式

{
  "ChannelInfos": [
    {
      "ChannelName": "ch4",
      "DBClusterId": "pc-*************\n",
      "Notes": "test update",
      "RegionId": "cn-hangzhou",
      "TargetDBClusterId": "pc-*************\n",
      "TargetIp": "33.*.*.240",
      "TargetPort": "3389",
      "TargetType": "polardb_for_postgresql",
      "VpcId": "vpc-2ze13g2c6j7j2jl*******"
    }
  ],
  "RequestId": "925B84D9-CA72-432C-95CF-738C22******"
}

錯誤碼

HTTP status code

錯誤碼

錯誤資訊

描述

404 InvalidDBClusterId.NotFound The DBInstanceId provided does not exist in our records. 當前的記錄中不存在提供的DBClusterId。

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊,參考變更詳情