Docs
api
Private Network(UVPC)
DescribeVPCIntercom

Obtain VPC Intercommunication Information - DescribeVPCIntercom

Overview

Obtain VPC Intercommunication Information

Definition

Public Parameters

Parameter NameTypeDescription InformationRequired
ActionstringCorresponding API command name, the current API is DescribeVPCIntercom.Yes
PublicKeystringThe user's public key can be obtained from Console (opens in a new tab)Yes
SignaturestringUser signature generated based on public key and API command, see Signature AlgorithmYes

Request Parameters

Parameter NameTypeDescription InformationRequired
RegionstringThe region where the source VPC is located. See List of Regions and Availability ZonesYes
ProjectIdstringThe Project ID where the source VPC is located. If not filled in, it defaults to the default project, and sub-accounts must fill in. Please refer to the GetProjectList interface.No
VPCIdstringVPC Short IDYes
DstRegionstringTarget VPC region, default is all regionsNo
DstProjectIdstringTarget Project ID, default is all projectsNo

Response Field

Field NameTypeDescription InformationRequired
RetCodeintReturn status code. If it is 0, it means successful return. If it is not 0, it means failure.Yes
ActionstringOperation command name.Yes
MessagestringReturns an error message, providing detailed description when RetCode is non-zero.No
DataSetarray[VPCIntercomInfo]UVPC Information ArrayNo

Data Model

VPCIntercomInfo

Field NameTypeDescription InformationRequired
ProjectIdstringProject IdNo
VPCTypeintVPC type (1 represents Managed VPC, 0 represents Public Cloud VPC)Yes
AccountIdintProject Id (Number)Yes
Networkarray[string]Address Space of VPCNo
DstRegionstringRegionNo
NamestringVPC NameNo
VPCIdstringVPCIdNo
TagstringBusiness Group (displayed as Default if not grouped)No

Example

Request Example

https://api.ucloud-global.com/?Action=DescribeVPCIntercom
&Region=cn-sh2
&ProjectId=org-XXX
&VPCId=uvnet-XXXX
&HasHybrid=1
&HasHybrid=6
&HasHybrid=7
&HasHybrid=6

Response Example

{
  "Action": "DescribeVPCIntercomResponse",
  "DataSet": [
    {
      "DstRegion": "ge-fra",
      "Name": "DefaultVPC",
      "Network": [
        "10.29.XX.0/16"
      ],
      "ProjectId": "org-XXXXX",
      "Tag": "Default",
      "VPCId": "uvnet-XXXXX"
    },
    {
      "DstRegion": "cn-sh2",
      "Name": "ulb-vpc",
      "Network": [
        "172.16.XX.0/12",
        "10.1.XX.0/16"
      ],
      "ProjectId": "org-XXX",
      "Remark": "",
      "Tag": "Default",
      "VPCId": "uvnet-XXXX"
    }
  ],
  "RetCode": 0
}