GetVcc-阿里云帮助中心

Queries the details of a Lingjun connection, including the specification, Express Connect circuit access port type, instance status, bandwidth, and BGP CIDR block.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

eflo:GetVcc

get

*Vcc

acs:eflo:{#regionId}:{#accountId}:vcc/{#VccId}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-wulanchabu
VccId	string	Yes	The ID of the Lingjun connection instance.	vcc-cn-zvp2w222***
PageNumber	integer	No	Paging Parameters: The current parameters are obsolete.	1
PageSize	integer	No	Paging Parameters: The current parameters are obsolete.	20
EnablePage	boolean	No	Paging Parameters: The current parameters are obsolete.	false
ClientToken	string	No	By default, popApi is not ignored and idempotent	c5e3130a-d02f-11ec-a7d3-0242ac110005

Response elements

Element	Type	Description	Example
	object	AjaxResult
Code	integer	The response status code.	0
Message	string	The error message. (If the instance is in the Exception state, the exception cause is prompted.)	Success
RequestId	string	Request ID of the current request	CAD09E47-B651-5206-B2DC-3AB78C8EB446
Content	object	The response parameters.
TenantId	string	The ID of the tenant.	1620939556166279
RegionId	string	The region ID.	cn-wulanchabu
ZoneId	string	The zone ID.	cn-wulanchabu-b
VccId	string	The ID of the Lingjun connection instance.	vcc-cn-cqf2xh40101
VpdId	string	Lingjun CIDR block instance ID	vpd-d3isyds4
VpcId	string	Virtual Private Cloud IDs; What is Virtual Private Cloud You can call the DescribeVpcs operation to query the specified VPC.	vpc-j6ctp4n75306phv5tmpsm
VSwitchId	string	The ID of the vSwitch. Virtual Private Cloud VSwitch. You can call the DescribeVSwitches operation to query created vSwitches.	vsw-uf6u8473r84e6n1n19he5
CenId	string	The ID of the CEN instance; What is the CEN? You can call the DescribeCens to query the information of CEN instances under the current Alibaba Cloud account.	cen-m2iskbojlvda5w65fp
VccName	string	The name of the Lingjun connection instance.	vcc-heyuan-backup
AccessPointId	string	Express Connect circuit access point ID: ap-cn-wulanchabu-jn-ts-A: Ulanqab-Jining-A ap-cn-heyuan-yc-ts-SA127: Heyuan-Yuancheng-A Valid values: ap-cn-heyuan-yc-ts-SA127 : ap-cn-wulanchabu-jn-ts-A :	ap-cn-wulanchabu-jn-ts-A
LineOperator	string	The connectivity provider of the Express Connect circuit. Valid values: CO: other connectivity providers in the Chinese mainland Valid values: CO :	CO
Spec	string	Specification; value: Large: Large	Large
PortType	string	The port type of the Express Connect circuit. Valid values: 100GBase-LR: 100,000 megabytes of single-mode optical port (10 km) Valid values: 100GBase-LR : 100G	100GBase-LR
PricingCycle	string	The billing cycle. Valid values: Month: Billed on a monthly basis Year: Billed on an annual basis	Month
PayType	string	The billing method of the instance. Valid values: PREPAY: subscription POSTPAY: pay-as-you-go	PrePay
Duration	string	Cycle	1
Status	string	The status of the cache reserve instance. Valid values: Available: Normal. Not Available: Not available. Executing: The task is being executed. Deleting: The account is being deleted	Available
CurrentNode	string	Current Node	创建物理专线1
InternetChargeType	string	The billing method for network usage. PayByTraffic: pay-by-traffic PayByBandwidth: pay-by-bandwidth	PayByBandwidth
BandwidthStr	string	The bandwidth of the port.	1G
Message	string	The error message. (If the instance is in the Exception state, the exception cause is prompted.)	Success
CreateTime	string	The time when the data address was created.	1648085472000
GmtModified	string	The time when the agent was last modified.	1648085472000
CommodityCode	string	Commodity code	bccluster_cloudconnectionpre_public_cn
BgpCidr	string	BGP CIDR block	10.4.0.0/24
ExpirationDate	string	The time when the application expired.	1678379917000
VpdBaseInfo	object	Lingjun network segment information (applicable to the scene where the old version of Lingjun connection is directly bound to Lingjun network segment)
VpdId	string	Lingjun CIDR block instance ID	vpd-ppdunxzc
VpdName	string	Lingjun CIDR block instance name	yzp-rg-test3
Cidr	string	Network address segment	172.18.0.0/24
CreateTime	string	The time when the data address was created.	1678379917000
AttachErStatus	boolean	Whether Lingjun HUB has been bound to a network instance true: Bound false: unbound	true
ErInfos	array<object>	List of bound Lingjun HUB information
	object	The information of the bound Lingjun HUB.
CreateTime	string	The time when the data address was created.	1678379917000
GmtModified	string	The time when the agent was last modified.	1678379917000
Message	string	The message that is returned.	Success
ErId	string	Lingjun HUB ID	er-p68b0jwn
RegionId	string	Lingjun HUB Region Information	cn-wulanchabu
TenantId	string	The ID of the tenant.	1620939556166277
Status	string	The status of the intervention entry. Valid value:	Available
ErName	string	Lingjun HUB Instance Name	er-1
MasterZoneId	string	Primary Zone	cn-wulanchabu-b
Description	string	Description	Description
Connections	integer	Connections	2
RouteMaps	integer	Number of routing policy	2
AliyunRouterInfo	array<object>	Alibaba Cloud route information list
	object	Alibaba Cloud routing information
PcId	string	Express Connect circuit ID	pc-0jlof4bphlsnxbdztkvad
VbrId	string	The ID of the VBR.	vbr-2ze4i85p6vb9nwcan5xt0
LocalGatewayIp	string	IPv4 address of Alibaba Cloud-side interconnection	169.254.248.30
PeerGatewayIp	string	Lingjun Side Interconnection IPv4 Address	169.254.248.28
Mask	string	Masking	255.255.255.248
VlanId	string	VLAN ID of the VBR	1042
CisRouterInfo	array<object>	Lingjun Network Routing Information List
	array<object>	Lingjun Network Routing Information
CcrId	string	The ID of the on-cloud router instance.	ccr-1ms84am0
CcInfos	array<object>	Leased Line Information List
	object	Leased Line Information
CcId	string	Leased Line ID	cc-73aeex5o
VlanId	string	Vlan ID of the leased line	Ethernet1042
LocalGatewayIp	string	Lingjun Side Interconnection IPv4 Address	169.254.248.26
RemoteGatewayIp	string	Lingjun Side Interconnection IPv4 Address	169.254.248.30
SubnetMask	string	Subnet mask	255.255.255.248
Status	string	The state of the rule.	Established
ResourceGroupId	string	The ID of your Alibaba Cloud resource group. For more information about resource groups, see Resource groups.	rg-aek2l4sq6l7unhi
Tags	array<object>	The tag information. You can specify up to 20 tags.
	object	The information about the image tag.
TagKey	string	The tag key. You cannot specify an empty string as a tag key. It can be up to 64 characters in length and cannot start with aliyun or acs:. It cannot contain http:// or https://. You can specify at most 20 tag keys in each call.	tag-vcc
TagValue	string	The value of the tag that is added to the resource. The tag value can be empty or a string of up to 128 characters. It cannot start with aliyun or acs:, and cannot contain http:// or https://. Each key-value pair must be unique. You can specify values for at most 20 tag keys in each call.	vcc-group-1
ConnectionType	string	The connection mode. Valid values: VPC CENTR Valid values: VPC : VPC CENTR : CENTR	CENTR
CenOwnerId	string	Account to which the CEN belongs	1620939556166279
VbrInfos	array<object>	Information list of border routers
	array<object>	Border Router Information
VbrId	string	The ID of the border router.	vbr-wz96agu9h3d50z****
CenId	string	CEN ID	cen-cx0qua8q6cm4z9****
Status	string	The status of the VBR. Valid values: unconfirmed active: The VPN gateway is in a normal state. terminating: The connection is being terminated. terminated: The connection is terminated. recovering: The task is being recovered. deleting: The GDN is being deleted. Available: The service is available.	Available
GmtCreate	string	The time when the data address was created.	1683250981000
GmtModified	string	The time when the agent was last modified.	1673578603000
VbrBgpPeers	array<object>	BGP neighbor information list
	object	BGP neighbor information
BgpGroupId	string	BGP Group ID	bgpg-2ze2sit2vakrkapvy****
BgpPeerId	string	BGP peer ID	bgp-uf6heugif9enu48rj****
PeerIpAddress	string	BGP peer IP address	169.254.****
PeerAsn	string	Peer AS No.	98765****
Status	string	The status of the BGP peer. Valid values: Pending: pending Available: The route is available. Modifying: being modified Deleting: The IPv4 gateway is being deleted. Deleted Not Available	Available
BgpAsn	string	BGP AS number	45644
Bandwidth	integer	bandwidth	100
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "CAD09E47-B651-5206-B2DC-3AB78C8EB446",
  "Content": {
    "TenantId": "1620939556166279",
    "RegionId": "cn-wulanchabu",
    "ZoneId": "cn-wulanchabu-b",
    "VccId": "vcc-cn-cqf2xh40101",
    "VpdId": "vpd-d3isyds4",
    "VpcId": "vpc-j6ctp4n75306phv5tmpsm",
    "VSwitchId": "vsw-uf6u8473r84e6n1n19he5",
    "CenId": "cen-m2iskbojlvda5w65fp",
    "VccName": "vcc-heyuan-backup",
    "AccessPointId": "ap-cn-wulanchabu-jn-ts-A",
    "LineOperator": "CO",
    "Spec": "Large",
    "PortType": "100GBase-LR",
    "PricingCycle": "Month",
    "PayType": "PrePay",
    "Duration": "1",
    "Status": "Available",
    "CurrentNode": "创建物理专线1",
    "InternetChargeType": "PayByBandwidth",
    "BandwidthStr": "1G",
    "Message": "成功",
    "CreateTime": "1648085472000",
    "GmtModified": "1648085472000",
    "CommodityCode": "bccluster_cloudconnectionpre_public_cn",
    "BgpCidr": "10.4.0.0/24",
    "ExpirationDate": "1678379917000",
    "VpdBaseInfo": {
      "VpdId": "vpd-ppdunxzc",
      "VpdName": "yzp-rg-test3",
      "Cidr": "172.18.0.0/24",
      "CreateTime": "1678379917000"
    },
    "AttachErStatus": true,
    "ErInfos": [
      {
        "CreateTime": "1678379917000",
        "GmtModified": "1678379917000",
        "Message": "成功",
        "ErId": "er-p68b0jwn",
        "RegionId": "cn-wulanchabu",
        "TenantId": "1620939556166277",
        "Status": "Available",
        "ErName": "er-1",
        "MasterZoneId": "cn-wulanchabu-b",
        "Description": "描述",
        "Connections": 2,
        "RouteMaps": 2
      }
    ],
    "AliyunRouterInfo": [
      {
        "PcId": "pc-0jlof4bphlsnxbdztkvad",
        "VbrId": "vbr-2ze4i85p6vb9nwcan5xt0",
        "LocalGatewayIp": "169.254.248.30",
        "PeerGatewayIp": "169.254.248.28",
        "Mask": "255.255.255.248",
        "VlanId": "1042"
      }
    ],
    "CisRouterInfo": [
      {
        "CcrId": "ccr-1ms84am0",
        "CcInfos": [
          {
            "CcId": "cc-73aeex5o",
            "VlanId": "Ethernet1042",
            "LocalGatewayIp": "169.254.248.26",
            "RemoteGatewayIp": "169.254.248.30\n",
            "SubnetMask": "255.255.255.248",
            "Status": "Established"
          }
        ]
      }
    ],
    "ResourceGroupId": "rg-aek2l4sq6l7unhi",
    "Tags": [
      {
        "TagKey": "tag-vcc",
        "TagValue": "vcc-group-1"
      }
    ],
    "ConnectionType": "CENTR",
    "CenOwnerId": "1620939556166279",
    "VbrInfos": [
      {
        "VbrId": "vbr-wz96agu9h3d50z****",
        "CenId": "cen-cx0qua8q6cm4z9****",
        "Status": "Available",
        "GmtCreate": "1683250981000",
        "GmtModified": "1673578603000",
        "VbrBgpPeers": [
          {
            "BgpGroupId": "bgpg-2ze2sit2vakrkapvy****",
            "BgpPeerId": "bgp-uf6heugif9enu48rj****",
            "PeerIpAddress": "169.254.****",
            "PeerAsn": "98765****",
            "Status": "Available"
          }
        ]
      }
    ],
    "BgpAsn": "45644",
    "Bandwidth": 100
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.