All Products
Search
Document Center

Virtual Private Cloud:GetVpcPeerConnectionAttribute

Last Updated:Jun 25, 2024

Queries the details of a virtual private cloud (VPC) peering connection.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
InstanceIdstringYes

The ID of the VPC peering connection.

pcc-lnk0m24khwvtkm****

Response parameters

ParameterTypeDescriptionExample
object

The request ID.

RequestIdstring

The request ID.

473469C7-AA6F-4DC5-B3DB-A3AC0DE3C83E
InstanceIdstring

The ID of the VPC peering connection.

pcc-lnk0m24khwvtkm****
GmtCreatestring

The time when the VPC peering connection was created. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2022-04-24T09:02:36Z
GmtModifiedstring

The time when the VPC peering connection was modified. The time follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss format. The time is displayed in UTC.

2022-04-24T19:20:45Z
Namestring

The name of the VPC peering connection.

vpcpeer
Descriptionstring

The description of the VPC peering connection.

test
OwnerIdlong

The ID of the Alibaba Cloud account to which the requester VPC belongs.

253460731706911258
AcceptingOwnerUidlong

The ID of the Alibaba Cloud account to which the accepter VPC belongs.

283117732402483989
RegionIdstring

The region ID of the requester VPC.

cn-hangzhou
AcceptingRegionIdstring

The region ID of the accepter VPC.

cn-hangzhou
Bandwidthinteger

The bandwidth of the VPC peering connection. Unit: Mbit /s. The value is an integer greater than 0.

Note A value of -1 indicates that the bandwidth is unlimited.

Default value:

  • The default bandwidth value of an inter-region VPC peering connection is 1,024 Mbit/s.
  • The default bandwidth value of an intra-region VPC peering connection is -1 Mbit/s, which indicates that the bandwidth is unlimited.
1024
Statusstring

The status of the VPC peering connection. Valid values:

  • Creating
  • Accepting
  • Updating
  • Rejected
  • Expired
  • Activated
  • Deleting
  • Deleted

For more information about the status of VPC peering connections, see Overview .

Activated
BizStatusstring

The status of the VPC peering connection. Valid values:

  • Normal
  • FinancialLocked
Normal
GmtExpiredstring

The expiration time of the VPC peering connection.

A valid expiration time is returned only when the Status of the VPC peering connection is Accepting or Expired. Otherwise, null is returned.

2022-05-01T09:02:36Z
ResourceGroupIdstring

The ID of the resource group.

rg-acfmz7hy5z267ni
Vpcobject

The details of the requester VPC.

VpcIdstring

The ID of the requester VPC.

vpc-bp1gsk7h12ew7oegk****
Ipv4Cidrsarray

The CIDR block of the requester VPC.

string

The CIDR block of the requester VPC.

192.168.0.0/16
Ipv6Cidrsarray

The IPv6 CIDR block of the requester VPC.

string

The IPv6 CIDR block of the requester VPC.

2408:XXXX:3c5:6e00::/56
AcceptingVpcobject

The details of the accepter VPC.

VpcIdstring

The ID of the accepter VPC.

vpc-bp1vzjkp2q1xgnind****
Ipv4Cidrsarray

The CIDR block of the accepter VPC.

string

The CIDR block of the accepter VPC.

10.0.0.0/16
Ipv6Cidrsarray

The IPv6 CIDR block of the accepter VPC.

string

The IPv6 CIDR block of the accepter VPC.

2408:XXXX:3b8:3a00::/56
Tagsobject []

The tag list.

Keystring

The tag key.

FinanceDept
Valuestring

The tag value.

FinanceJoshua

Examples

Sample success responses

JSONformat

{
  "RequestId": "473469C7-AA6F-4DC5-B3DB-A3AC0DE3C83E",
  "InstanceId": "pcc-lnk0m24khwvtkm****",
  "GmtCreate": "2022-04-24T09:02:36Z",
  "GmtModified": "2022-04-24T19:20:45Z",
  "Name": "vpcpeer",
  "Description": "test",
  "OwnerId": 253460731706911260,
  "AcceptingOwnerUid": 283117732402484000,
  "RegionId": "cn-hangzhou",
  "AcceptingRegionId": "cn-hangzhou",
  "Bandwidth": 1024,
  "Status": "Activated",
  "BizStatus": "Normal",
  "GmtExpired": "2022-05-01T09:02:36Z",
  "ResourceGroupId": "rg-acfmz7hy5z267ni",
  "Vpc": {
    "VpcId": "vpc-bp1gsk7h12ew7oegk****",
    "Ipv4Cidrs": [
      "192.168.0.0/16"
    ],
    "Ipv6Cidrs": [
      "2408:XXXX:3c5:6e00::/56"
    ]
  },
  "AcceptingVpc": {
    "VpcId": "vpc-bp1vzjkp2q1xgnind****",
    "Ipv4Cidrs": [
      "10.0.0.0/16"
    ],
    "Ipv6Cidrs": [
      "2408:XXXX:3b8:3a00::/56"
    ]
  },
  "Tags": [
    {
      "Key": "FinanceDept",
      "Value": "FinanceJoshua"
    }
  ]
}

Error codes

HTTP status codeError codeError messageDescription
400ResourceNotFound.InstanceIdThe specified resource of %s is not found.The specified instance is not found

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-01-23API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 400
2023-05-30The Error code has changed. The response structure of the API has changedsee changesets
Change itemChange content
Error CodesThe Error code has changed.
    delete Error Codes: 400
Output ParametersThe response structure of the API has changed.