ListVpds-阿里云帮助中心

Queries the details of one or more Lingjun CIDR blocks, including the status of Lingjun CIDR blocks, Cidr addresses, service CIDR blocks, and Subnet.

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

get

*Vpd

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

None

Request parameters

Parameter	Type	Required	Description	Example
VpdName	string	No	The name of the VPD instance.	vpd-1
RegionId	string	Yes	The region ID.	cn-wulanchabu
VpdId	string	No	The ID of the VPD instance.	vpd-fuliephf
Status	string	No	The status of the CLB instance. Valid values: Available: Normal. Not Available: Not available. Executing: The task is being executed. Deleting: The account is being deleted	Available
WithDependence	boolean	No	Specifies whether to include the dependent resource information. We recommend that you do not query the dependent resource information when you query by page. You can query the dependent resource information separately when you delete it. Possible values: true: with dependency information. false: does not include dependency information.	false
ForSelect	boolean	No	If you select a drop-down list, only the basic information (including the instance ID and instance name) is returned. Possible values: true: Select Query Use from the drop-down list. false: Normal queries are used.	true
WithoutVcc	boolean	No	Queries the information about a Lingjun CIDR block that is not bound to a Lingjun connection. Possible values: true: filters out VPDs that have been bound to VCC false: does not filter VPD that has been bound to VCC	true
FilterErId	string	No	Queries the network segments of Lingjun that are not bound to a specified Lingjun HUB.	er-kkopgtne
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	Details of 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-vpd-region
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.	wulanchabu
PageNumber	integer	No	The page number of the page to return. Start value: 1 Default value: 1.	1
PageSize	integer	No	The number of entries per page.	20
EnablePage	boolean	No	Specifies whether to enable paged query.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
Code	integer	The response status code.	0
Message	string	The additional information that is returned.	success
RequestId	string	The request ID.	9C50C9CD-E799-54DA-BA7A-1FAF3DF80857
Content	object	The response data.
Total	integer	The total number of entries that are returned.	0
Data	array<object>	The returned data.
	array<object>	The additional information.
TenantId	string	The tenant ID.	1655449505171
RegionId	string	The region ID.	cn-wulanchabu
VpdId	string	The ID of the VPD instance.	vpd-lg4dppgi
VpdName	string	The name of the VPD.	vpd-1
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/8
ServiceCidr	string	The Service CIDR block.	169.254.252.0/23
Status	string	The task status.	Available
Message	string	The returned message.	成功
NcCount	integer	nc quantity.	16
NetworkInterfaceCount	integer	Number of Lingjun network interface controller	1
SubnetCount	integer	The number of subnets.	1
CreateTime	string	The time when the activation code was created.	1678273219000
GmtModified	string	The time when the O&M task was modified.	1678273219000
Dependence	object	Dependencies.
	any	The list of dependencies.	{ "subnet": [ { "tenantId": "1620939556166277", "regionId": "cn-wulanchabu", "zoneId": "cn", "type": null, "subnetId": "subnet-zqebaxa0", "name": "lql_testVPD" } ], "nc": [{}] }
ErInfos	array<object>	The information list of the bound Lingjun HUB(ER).
	object	The information of the bound Lingjun HUB(ER).
CreateTime	string	The time when the activation code was created.	1678273219000
GmtModified	string	The time when the O&M task was modified.	1678273219000
Message	string	The returned message.	成功
ErId	string	The ID of the Elastic Router (ER) instance.	er-63vzm0fw
RegionId	string	The supported region.	cn-wulanchabu
TenantId	string	The tenant ID.	1620939556166277
Status	string	The task status.	Available
ErName	string	The name of the Lingjun HUB(ER) instance.	er-1
MasterZoneId	string	The primary zone.	cn-wulanchabu-b
Description	string	The description of the synchronization task.	描述
Connections	integer	The number of connections.	2
RouteMaps	integer	The number of routing policy.	2
Tags	array<object>	The tag information. You can specify up to 20 tags.
	object	The tags.
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-vpd-region
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.	cn-wulanchabu
ResourceGroupId	string	The ID of your Alibaba Cloud resource group. For more information about resource groups, see Resource groups.	rg-aek2l4sq6l7unhi
SecondaryCidrBlocks	array	The list of additional CIDR blocks.
	string	The additional network segment of the VPD.	10.0.0.0/8
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "success",
  "RequestId": "9C50C9CD-E799-54DA-BA7A-1FAF3DF80857",
  "Content": {
    "Total": 0,
    "Data": [
      {
        "TenantId": "1655449505171",
        "RegionId": "cn-wulanchabu",
        "VpdId": "vpd-lg4dppgi",
        "VpdName": "vpd-1",
        "Cidr": "10.0.0.0/8",
        "ServiceCidr": "169.254.252.0/23",
        "Status": "Available",
        "Message": "成功",
        "NcCount": 16,
        "NetworkInterfaceCount": 1,
        "SubnetCount": 1,
        "CreateTime": "1678273219000",
        "GmtModified": "1678273219000",
        "Dependence": {
          "key": "{\n    \"subnet\": [\n        {\n            \"tenantId\": \"1620939556166277\",\n            \"regionId\": \"cn-wulanchabu\",\n            \"zoneId\": \"cn\",\n            \"type\": null,\n            \"subnetId\": \"subnet-zqebaxa0\",\n            \"name\": \"lql_testVPD\"\n        }\n    ],\n    \"nc\": [{}]\n}"
        },
        "ErInfos": [
          {
            "CreateTime": "1678273219000",
            "GmtModified": "\t\n1678273219000",
            "Message": "成功",
            "ErId": "er-63vzm0fw",
            "RegionId": "cn-wulanchabu",
            "TenantId": "1620939556166277",
            "Status": "Available",
            "ErName": "er-1",
            "MasterZoneId": "cn-wulanchabu-b",
            "Description": "描述",
            "Connections": 2,
            "RouteMaps": 2
          }
        ],
        "Tags": [
          {
            "TagKey": "tag-vpd-region",
            "TagValue": "cn-wulanchabu"
          }
        ],
        "ResourceGroupId": "rg-aek2l4sq6l7unhi",
        "SecondaryCidrBlocks": [
          "10.0.0.0/8"
        ]
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.