DescribeNetworkPeerConnections - ENS - Alibaba Cloud Documentation Center

Call DescribeNetworkPeerConnections to query network peer connections.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The ID of the network peer connection.	pcc-5inkeimcipxk26yqtzm4q****
EnsRegionId	string	No	The ID of the ENS node.	cn-xian-unicom
Name	string	No	The name of the network peer connection.	test0
NetworkIds	array	No	The IDs of the networks involved in the connection. The query does not distinguish between the requester and accepter.
	string	No	A network ID.	n-5****
PageNumber	integer	No	The page number for the returned results. Default: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default: 10. Valid values: 10 to 100.	10

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	CEF72CEB-54B6-4AE8-B225-F876FF7BA984
PageNumber	string	The current page number.	1
PageSize	string	The number of entries per page.	30
TotalCount	string	The total number of entries.	1
NetworkPeerConnects	array<object>	A list of the network peering connections.
	array<object>	Details of a network peering connection.
InstanceId	string	The ID of the network peering connection.	pcc-521pzxdg****
CreationTime	string	The creation time in UTC.	2024-05-31T06:43:29Z
Name	string	The name of the network peering connection.	test
Description	string	The description of the network peering connection.	desc
EnsRegionId	string	The ID of the ENS node.	cn-dongguan-9
Status	string	The status of the network peering connection. Valid values: `Creating`: The connection is being created. `Activated`: The connection is active. `Deleting`: The connection is being deleted.	Activated
NetworkId	string	The network ID of the requester.	n-5q73bm****
AcceptingNetworkId	string	The network ID of the accepter.	n-5q28114****
Network	object	Details of the requester network.
NetworkId	string	The network ID of the requester.	n-5q73bm****
Ipv4Cidrs	array	The CIDR blocks of the requester network.
	string	A CIDR block of the requester network.	10.0.0.0/8
AcceptingNetwork	object	Details of the accepter network.
NetworkId	string	The network ID of the accepter.	n-5q28114****
Ipv4Cidrs	array	The CIDR blocks of the accepter network.
	string	A CIDR block of the accepter network.	192.168.0.0/16

Examples

Success response

JSON format

{
  "RequestId": "CEF72CEB-54B6-4AE8-B225-F876FF7BA984",
  "PageNumber": "1",
  "PageSize": "30",
  "TotalCount": "1",
  "NetworkPeerConnects": [
    {
      "InstanceId": "pcc-521pzxdg****",
      "CreationTime": "2024-05-31T06:43:29Z",
      "Name": "test",
      "Description": "desc",
      "EnsRegionId": "cn-dongguan-9",
      "Status": "Activated",
      "NetworkId": "n-5q73bm****",
      "AcceptingNetworkId": "n-5q28114****\n",
      "Network": {
        "NetworkId": "n-5q73bm****",
        "Ipv4Cidrs": [
          "10.0.0.0/8"
        ]
      },
      "AcceptingNetwork": {
        "NetworkId": "n-5q28114****",
        "Ipv4Cidrs": [
          "192.168.0.0/16"
        ]
      }
    }
  ]
}

Error codes

HTTP status code	Error code	Error message
400	ens.interface.error	Failed to call API.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.