Query VSwitch Attributes via DescribeVSwitchAttributes - ENS

Call the DescribeVSwitchAttributes interface to query the configuration of a specified VSwitch.

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

ens:DescribeVSwitchAttributes

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
VSwitchId	string	Yes	The ID of the VSwitch.	vsw-5****

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID.	C0003****2A8
EnsRegionId	string	The ENS node ID.	cn-xian-unicom
NetworkId	string	The network ID.	n-257gqcdfvx6n****
VSwitchName	string	The name of the VSwitch.	Test-switch
CidrBlock	string	The IPv4 CIDR block of the network.	10.0.0.0/24
Status	string	The status of the VSwitch, as follows: Pending Available Releasing	Available
Description	string	The description of the VSwitch.	This is my vswitch.
CreatedTime	string	The creation time, in UTC format (yyyy-MM-ddTHH:mm:ssZ).	2019-06-01T00:00:00Z
InstanceIds	object
InstanceId	array	A list of instance IDs.
	string	The instance ID.	i-5****4evfn
NetworkInterfaceIds	object
NetworkInterfaceId	array	A list of elastic network interface IDs.
	string	The elastic network interface ID.	eni-5****yfjm
LoadBalancerIds	object
LoadBalancerId	array	A list of load balancer instance IDs.
	string	The load balancer instance ID.	lb-5****
NatGatewayIds	object
NatGatewayId	array	A list of NAT gateway IDs.
	string	The NAT gateway ID.	nat-5****
HaVipIds	object
HaVipId	array	A list of high-availability VIP instance IDs.
	string	The high-availability VIP instance ID.	havip-5****
VSwitchId	string	The ID of the VSwitch.	vsw-5****
AvailableIpAddressCount	integer	The number of available IP addresses in the VSwitch.	253

Examples

Success response

JSON format

{
  "RequestId": "C0003****2A8",
  "EnsRegionId": "cn-xian-unicom",
  "NetworkId": "n-257gqcdfvx6n****",
  "VSwitchName": "Test-switch",
  "CidrBlock": "10.0.0.0/24",
  "Status": "Available",
  "Description": "This is my vswitch.",
  "CreatedTime": "2019-06-01T00:00:00Z",
  "InstanceIds": {
    "InstanceId": [
      "i-5****4evfn"
    ]
  },
  "NetworkInterfaceIds": {
    "NetworkInterfaceId": [
      "eni-5****yfjm"
    ]
  },
  "LoadBalancerIds": {
    "LoadBalancerId": [
      "lb-5****"
    ]
  },
  "NatGatewayIds": {
    "NatGatewayId": [
      "nat-5****"
    ]
  },
  "HaVipIds": {
    "HaVipId": [
      "havip-5****"
    ]
  },
  "VSwitchId": "vsw-5****",
  "AvailableIpAddressCount": 253
}

Error codes

HTTP status code	Error code	Error message	Description
400	ens.interface.error	Failed to call API.
400	InvalidVSwitchId.NotFound	Specified virtual switch does not exist.	The specified virtual switch ID does not exist.
400	NoPermission	Permission denied.
400	InvalidParameter.%s	The specified field %s invalid. Please check it again.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.