DescribeNetworkInstanceRelationList - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the relationships between network instances.

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
Lang	string	No	The language of the response. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the response. Valid values: en : English zh : Chinese	zh
ConnectType	string	No	The connection type. Valid values: expressconnect : Express Connect cen : Cloud Enterprise Network (CEN)	cen
FirewallConfigureStatus	string	No	The configuration status of Cloud Firewall. Valid values: configured : Cloud Firewall is configured. notconfigured : Cloud Firewall is not configured.	notconfigured
NetworkInstanceId	string	No	The ID of the local network instance.	vpc-2vcwkr****
PeerNetworkInstanceId	string	No	The ID of the peer network instance.	vpc-dsf232d****

Response elements

Element	Type	Description	Example
	object
TotalCount	integer	The total number of entries.	12
RequestId	string	The request ID.	284FF89D-4F70-546F-8EF6-77E0A530****
NetworkInstanceList	array<object>	The information about the network instances.
	array<object>	The information about the network instance.
ConnectType	string	The connection type. Valid values: expressconnect : Express Connect cen : Cloud Enterprise Network (CEN)	cen
NetworkInstanceName	string	The name of the network instance.	vpc-test
NetworkInstanceId	string	The ID of the network instance.	vpc-2vcwfqbrh4kr****
RegionNo	string	The region ID.	cn-shanghai
NetworkInstanceType	string	The type of the network instance. Valid values: vbr : vbr vpc : vpc	VPC
PeerNetworkInstanceList	array<object>	The list of peer network instances.
	array<object>	The peer network instance.
NetworkInstanceId	string	The ID of the network instance.	vpc-dsf232d****
NetworkInstanceName	string	The name of the network instance.	vpc-test
RegionNo	string	The region.	cn-shenzhen
NetworkInstanceType	string	The type of the network instance. Valid values: vbr : vbr vpc : vpc	vpc
AssociatedCen	array<object>	The associated CEN instance.
	object	The associated CEN instance.
CenId	string	The ID of the CEN instance.	cen-sdij1***
CenName	string	The name of the CEN instance.	test
TransitRouterType	string	The version of the transit router. Valid values: Basic: Basic Edition transit router. Enterprise: Enterprise Edition transit router.	Enterprise
AttachmentId	string	The ID of the network instance connection.	tr-attach-b9dyqn***
AttachmentName	string	The name of the network instance connection.	att-test2
AssociatedCen	array<object>	The associated CEN instance.
	object	The associated CEN instance.
CenId	string	The ID of the CEN instance.	cen-sdij1***
CenName	string	The name of the CEN instance.	test
TransitRouterType	string	The type of the transit router. Valid values: Basic: Basic Edition transit router. Enterprise: Enterprise Edition transit router.	Enterprise
AttachmentId	string	The ID of the network instance connection.	tr-attach-b92yqn***
AttachmentName	string	The name of the network instance connection.	att-test1

Examples

Success response

JSON format

{
  "TotalCount": 12,
  "RequestId": "284FF89D-4F70-546F-8EF6-77E0A530****",
  "NetworkInstanceList": [
    {
      "ConnectType": "cen",
      "NetworkInstanceName": "vpc-test",
      "NetworkInstanceId": "vpc-2vcwfqbrh4kr****",
      "RegionNo": "cn-shanghai",
      "NetworkInstanceType": "VPC",
      "PeerNetworkInstanceList": [
        {
          "NetworkInstanceId": "vpc-dsf232d****",
          "NetworkInstanceName": "vpc-test",
          "RegionNo": "cn-shenzhen",
          "NetworkInstanceType": "vpc",
          "AssociatedCen": [
            {
              "CenId": "cen-sdij1***",
              "CenName": "test",
              "TransitRouterType": "Enterprise",
              "AttachmentId": "tr-attach-b9dyqn***",
              "AttachmentName": "att-test2"
            }
          ]
        }
      ],
      "AssociatedCen": [
        {
          "CenId": "cen-sdij1***",
          "CenName": "test",
          "TransitRouterType": "Enterprise",
          "AttachmentId": "tr-attach-b92yqn***",
          "AttachmentName": "att-test1"
        }
      ]
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorAliUid	Aliuid invalid.	The aliuid is invalid.
400	ErrorDBSelectError	A database select error occurred.	The error message returned because an internal error has occurred in querying the database.
400	ErrorInvalidMemberUid	Member uid is invalid	The member is invalid.
400	ErrorConfigureStatus	firewall configure status invalid.	Firewall status parameter error, please re-select.
400	ErrorConnectType	Connect type invalid.	Incorrect selection of interworking type. Please select again.
400	ErrorNetworkInstanceIdBothEmpty	The parameters NetworkInstanceId and PeerNetworkInstanceId must be both empty or neither empty.	The parameters NetworkInstanceId and PeerNetworkInstanceId must be both empty or neither empty.
400	ErrorNetworkInstanceIdSame	The NetworkInstanceId and PeerNetworkInstanceId parameters cannot be the same.	Parameter NetworkInstanceId and PeerNetworkInstanceId cannot be the same

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.