PolarDB Network Channel Architecture & DescribeNetworkChannel Reference - PolarDB - Alibaba Cloud - PolarDB

Queries a network channel.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:DescribeNetworkChannel

get

*DBCluster

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

None

Request parameters

Parameter	Type	Required	Description	Example
ResourceGroupId	string	No	The resource group ID.	rg-************
DBClusterId	string	Yes	The source instance name.	pc-*************
ChannelName	string	No	The channel name.	ch4
VpcId	string	No	The ID of the VPC where the access endpoint resides.	vpc-bp1qpo0kug3a20qqe****
RegionId	string	No	The region ID.	cn-hangzhou
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. The client generates the token and ensures that it is unique across requests. The token is case-sensitive and can contain up to 64 ASCII characters.	6000170000591aed949d0f54a343f1a4233c1e7d1c5******

Response elements

Element	Type	Description	Example
	object	Schema of Response
ChannelInfos	array<object>	The list of network channels.
	object	The network channel data.
ChannelName	string	The channel name.	ch4
DBClusterId	string	The source instance name.	pc-*************
EniId	string	The ID of the elastic network interfaces (ENIs) used by the reverse access link of the network channel. The network interface controller (NIC) is used for the connection.	eni-2z******
Notes	string	The remarks.	test update
RegionId	string	The region ID.	cn-hangzhou
TargetDBClusterId	string	The target instance name.	pc-*************
TargetIp	string	The IP address of the target instance.	33...240
TargetPort	string	The port of the target instance.	3389
TargetType	string	The target instance type.	polardb_for_postgresql
VpcId	string	The ID of the VPC where the access endpoint resides.	vpc-2ze13g2c6j7j2jl*******
RequestId	string	Id of the request	925B84D9-CA72-432C-95CF-738C22******

Examples

Success response

JSON format

{
  "ChannelInfos": [
    {
      "ChannelName": "ch4",
      "DBClusterId": "pc-*************\n",
      "EniId": "eni-2z******",
      "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******"
}

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidDBClusterId.NotFound	The DBInstanceId provided does not exist in our records.	The specified DBClusterId parameter does not exist in the current record.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.