GetVpd-阿里云帮助中心

Queries the details of a Lingjun CIDR block, including the status of the Lingjun CIDR block, the CIDR block, the number of subnets and NCs.

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

get

*Vpd

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

None

Request parameters

Parameter	Type	Required	Description	Example
VpdId	string	Yes	The ID of the VPD instance.	vpd-ze3na***
RegionId	string	Yes	The region ID.	cn-wulanchabu

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.	A88DFED5-24B7-5A3E-87DE-380BF06F3C90
Content	object	The data returned.
RegionId	string	The region ID.	cn-wulanchabu
VpdId	string	The ID of the VPD instance.	vpd-fulie***
VpdName	string	The name of the Lingjun CIDR block.	vpd-1
Cidr	string	The CIDR block.	10.0.0.0/8
ServiceCidr	string	Internal Service CIDR block.	169.254.252.0/23
Status	string	The current state of the instance. Valid value: Not Available: Not Available. Available: Normal: Available: Normal. Deleting: Deleting: Deleting: Deleting. Executing: executing: Executing: executing. Valid values: Not Available：不可用 : Available：正常 : Deleting：删除中 : Executing：执行中 :	Available
Message	string	The error message. (If the instance is in the Exception state, the exception cause is prompted.)	可用
NcCount	integer	The number of NCs.	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.	2023-10-25 15:57:16
GmtModified	string	The time when the O&M task was modified.	2023-10-25 15:57:16
TenantId	string	The tenant ID.	162093***166279
ErInfos	array<object>	The information 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.	2023-10-25 15:57:16
GmtModified	string	The time when the O&M task was modified.	2023-10-25 15:57:16
Message	string	The returned message.	success
ErId	string	The ID of the Elastic Router (ER) instance.	er-a7rqv1rq***
RegionId	string	The ID of the region to which the Elastic Router (ER) belongs.	cn-wulanchabu
TenantId	string	The tenant ID.	162093***166279
Status	string	The task status.	Available
ErName	string	Elastic Router (ER) Instance Name	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
AttachErStatus	boolean	Whether the Lingjun HUB(ER) has been bound. true: ER is bound. false: No ER is bound.	true
ResourceGroupId	string	The ID of your Alibaba Cloud resource group. For more information about resource groups, see Resource groups.	rg-aek2l4sq6l7u***
Tags	array<object>	The tag information. You can specify up to 20 tags.
	object	The details of the resource 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-subent-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
Quota	integer	The total quota information.	10
PrivateIpCount	integer	The total number of secondary private IP addresses.	10
SecondaryCidrBlocks	array	The list of additional CIDR blocks.
	string	The information about the secondary CIDR block.	10.0.0.0/8
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "success",
  "RequestId": "A88DFED5-24B7-5A3E-87DE-380BF06F3C90",
  "Content": {
    "RegionId": "cn-wulanchabu",
    "VpdId": "vpd-fulie***",
    "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": "2023-10-25 15:57:16",
    "GmtModified": "2023-10-25 15:57:16",
    "TenantId": "162093***166279",
    "ErInfos": [
      {
        "CreateTime": "2023-10-25 15:57:16",
        "GmtModified": "2023-10-25 15:57:16",
        "Message": "success",
        "ErId": "er-a7rqv1rq***",
        "RegionId": "cn-wulanchabu",
        "TenantId": "162093***166279\n",
        "Status": "Available",
        "ErName": "er-1",
        "MasterZoneId": "cn-wulanchabu-b",
        "Description": "描述",
        "Connections": 2,
        "RouteMaps": 2
      }
    ],
    "AttachErStatus": true,
    "ResourceGroupId": "rg-aek2l4sq6l7u***",
    "Tags": [
      {
        "TagKey": "tag-subent-region",
        "TagValue": "cn-wulanchabu"
      }
    ],
    "Quota": 10,
    "PrivateIpCount": 10,
    "SecondaryCidrBlocks": [
      "10.0.0.0/8\n"
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.