ListVccs-阿里云帮助中心

query the details of one or more lingjun connections, including the specification, Express Connect circuit access port type, instance status, bandwidth, and bgp network segment.

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:ListVccs

get

*Vcc

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-wulanchabu
VpdId	string	No	Lingjun CIDR block instance ID	vpd-omqutbff
VpcId	string	No	Virtual Private Cloud IDs; What is Virtual Private Cloud You can call the DescribeVpcs operation to query the specified VPC.	vpc-bp1nrtkmamy329u6a1z0i
CenId	string	No	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-95iwtpyvj3kk1v0ao0
Bandwidth	integer	No	The peak bandwidth of the Lingjun connection instance. Unit: Mbit/s. Valid values: 1000 to 400000	5000
Status	string	No	The instance status.	Available
ExStatus	string	No	Excludes all data in the specified status. If the status parameter exists, ExStatus does not take effect.	Prepaid
VccId	string	No	The ID of the Lingjun connection instance.	vcc-cn-zvp2w222001
FilterErId	string	No	Filter queries by Lingjun HUB instance ID	er-a7rqv1rq
ResourceGroupId	string	No	The resource group ID. For more information about resource groups, see Resource groups.	rg-aeky5f3qx6ceapq
Tag	array<object>	No	The tag information. You can specify up to 20 tags.
	object	No	The tag.
Key	string	No	The tag key of the VPN attachment. 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
Value	string	No	The tag value of the VPN connection. 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
PageNumber	integer	No	The page number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 20.	20
EnablePage	boolean	No	Specifies whether to enable paged query. Optional values: true: Enable pagination query false: Pagination query is disabled	false

Response elements

Element	Type	Description	Example
	object	AjaxResult<PageResult>
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	28451248-7038-5184-B5D3-80F104654BE8
Content	object	The response parameters.
Total	integer	The total number of entries returned.	0
Data	array<object>	Lingjun Connection Information List
	array<object>	Lingjun Connection Information
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-zvp2w222001
VpdId	string	Lingjun CIDR block instance ID	vpd-eoiy88ju
VpcId	string	Virtual Private Cloud IDs; What is Virtual Private Cloud You can call the DescribeVpcs operation to query the specified VPC.	vpc-f8ziirfl9k25h2qn7y4f8
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-w15qot0pfvs83pkckj
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	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	CO
Spec	string	The compute specification.	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)	100GBase-LR
Status	string	The state of the rule.	Init
CurrentNode	string	Current process node	Persisting resource data
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.	1678273219000
GmtModified	string	The time when the cluster was updated.	1678273219000
TaskId	string	The job ID.	task-cd544092-ed0a-49e9-83eb-e8c94770dccf
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-9n7ioqrp
VpdName	string	Lingjun CIDR block instance name	yzp-rg-test3
Cidr	string	The CIDR block of the VPD. We recommend that you use an RFC private endpoint as the Lingjun CIDR block, such as 10.0.0.0/8,172.16.0.0/12,192.168.0.0/16. In scenarios where the Doringjun CIDR block is connected to each other or where the Lingjun CIDR block is connected to a VPC, make sure that the addresses do not conflict with each other. You can also use a custom CIDR block other than 100.64.0.0/10, 224.0.0.0/4, 127.0.0.0/8, or 169.254.0.0/16 and their subnets as the primary IPv4 CIDR block of the VPD.	10.0.0.0/13
CreateTime	string	The time when the data address was created.	1668158213000
Rate	number	Process progress; value returns 0 to 1; not started is null	1
BandwidthStr	string	The bandwidth of the port.	1000
CommodityCode	string	Commodity code	bccluster_cloudconnectionpre_public_cn
BgpCidr	string	bgp network segment	172.16.128.0/24
ExpirationDate	string	The time when the application expired.	1678273219000
ResourceGroupId	string	The ID of your Alibaba Cloud resource group. For more information about resource groups, see Resource groups.	rg-aek2l4sq6l7unhi
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.	1678273219000
GmtModified	string	The time when the agent was last modified.	1678273219000
Message	string	The message that is returned.	Success
ErId	string	Elastic Router ID	er-a7rqv1rq
RegionId	string	ER 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	ER 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
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 cen belongs	1238685214107736
BgpAsn	string	bgp as number	4200057312
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "Success",
  "RequestId": "28451248-7038-5184-B5D3-80F104654BE8",
  "Content": {
    "Total": 0,
    "Data": [
      {
        "TenantId": "1620939556166279\n",
        "RegionId": "cn-wulanchabu",
        "ZoneId": "cn-wulanchabu-b",
        "VccId": "vcc-cn-zvp2w222001",
        "VpdId": "vpd-eoiy88ju",
        "VpcId": "vpc-f8ziirfl9k25h2qn7y4f8",
        "CenId": "cen-w15qot0pfvs83pkckj",
        "VccName": "vcc-heyuan-backup",
        "AccessPointId": "ap-cn-wulanchabu-jn-ts-A",
        "LineOperator": "CO",
        "Spec": "Large",
        "PortType": "100GBase-LR\n",
        "Status": "Init",
        "CurrentNode": "持久化资源数据",
        "Message": "Success",
        "CreateTime": "1678273219000",
        "GmtModified": "1678273219000",
        "TaskId": "task-cd544092-ed0a-49e9-83eb-e8c94770dccf",
        "VpdBaseInfo": {
          "VpdId": "vpd-9n7ioqrp",
          "VpdName": "yzp-rg-test3",
          "Cidr": "10.0.0.0/13",
          "CreateTime": "1668158213000"
        },
        "Rate": 1,
        "BandwidthStr": "1000",
        "CommodityCode": "bccluster_cloudconnectionpre_public_cn",
        "BgpCidr": "172.16.128.0/24",
        "ExpirationDate": "1678273219000",
        "ResourceGroupId": "rg-aek2l4sq6l7unhi",
        "ErInfos": [
          {
            "CreateTime": "1678273219000",
            "GmtModified": "1678273219000",
            "Message": "Success",
            "ErId": "er-a7rqv1rq",
            "RegionId": "cn-wulanchabu",
            "TenantId": "1620939556166277",
            "Status": "Available",
            "ErName": "er-1",
            "MasterZoneId": "cn-wulanchabu-b",
            "Description": "Description",
            "Connections": 2,
            "RouteMaps": 2
          }
        ],
        "Tags": [
          {
            "TagKey": "tag-vcc",
            "TagValue": "vcc-group-1"
          }
        ],
        "ConnectionType": "CENTR",
        "CenOwnerId": "1238685214107736",
        "BgpAsn": "4200057312"
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.