DescribeNetworkChannel - 查询网络通道_云原生数据库 PolarDB(PolarDB)-阿里云帮助中心

查询网络通道

调试

您可以在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。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。