Obtain VPC Intercommunication Information - DescribeVPCIntercom
Overview
Obtain VPC Intercommunication Information
Definition
Public Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Action | string | Corresponding API command name, the current API is DescribeVPCIntercom . | Yes |
PublicKey | string | The user's public key can be obtained from Console (opens in a new tab) | Yes |
Signature | string | User signature generated based on public key and API command, see Signature Algorithm | Yes |
Request Parameters
Parameter Name | Type | Description Information | Required |
---|---|---|---|
Region | string | The region where the source VPC is located. See List of Regions and Availability Zones | Yes |
ProjectId | string | The 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 |
VPCId | string | VPC Short ID | Yes |
DstRegion | string | Target VPC region, default is all regions | No |
DstProjectId | string | Target Project ID, default is all projects | No |
Response Field
Field Name | Type | Description Information | Required |
---|---|---|---|
RetCode | int | Return status code. If it is 0, it means successful return. If it is not 0, it means failure. | Yes |
Action | string | Operation command name. | Yes |
Message | string | Returns an error message, providing detailed description when RetCode is non-zero. | No |
DataSet | array[VPCIntercomInfo] | UVPC Information Array | No |
Data Model
VPCIntercomInfo
Field Name | Type | Description Information | Required |
---|---|---|---|
ProjectId | string | Project Id | No |
VPCType | int | VPC type (1 represents Managed VPC, 0 represents Public Cloud VPC) | Yes |
AccountId | int | Project Id (Number) | Yes |
Network | array[string] | Address Space of VPC | No |
DstRegion | string | Region | No |
Name | string | VPC Name | No |
VPCId | string | VPCId | No |
Tag | string | Business Group (displayed as Default if not grouped) | No |
Example
Request Example
https://api.surfercloud.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
}