Queries information about available vSwitches.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| ens:DescribeVSwitches | get | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| EnsRegionId | string | No | The ID of the edge node. | cn-xian-unicom |
| VSwitchId | string | No | The ID of the vSwitch. | vsw-5m9xhlq8oh*** |
| VSwitchName | string | No | The name of the vSwitch. | testVSwitchName |
| NetworkId | string | No | The ID of the VPC to which the vSwitches belong. | vpc-25cdvfeq58pl**** |
| PageNumber | integer | No | The page number of the returned page. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Valid values: 1 to 50. Default value: 10. | 10 |
| OrderByParams | string | No | The order in which you want to sort the returned data. Example: {"EnsRegionId":"desc"}. By default, the nodes are sorted by IDs in descending order. | {"EnsRegionId":"desc"} |
Response parameters
Examples
Sample success responses
JSONformat
{
"PageSize": 2,
"RequestId": "473469C7-AA6F-4DC5-B3DB-A3DC0DE3C83E",
"PageNumber": 1,
"TotalCount": 3,
"VSwitches": {
"VSwitch": [
{
"EnsRegionId": "cn-xian-unicom",
"Status": "Pending",
"FreeIpCount": 1024,
"VSwitchId": "vsw-5m9xhlq8oh***",
"CidrBlock": "10.21.224.0/22",
"Description": "VSwitchDescription",
"NetworkId": "vpc-25cdvfeq58pl****",
"CreatedTime": "2020-06-16T06:33:15Z",
"VSwitchName": "testVSwitchName"
}
]
}
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | MissingParameter | The input parameter that is mandatory for processing this request is not supplied. | - |
| 400 | NoPermission | Permission denied. | - |
| 400 | InvalidParameter.%s | The specified field %s invalid. Please check it again. | - |
| 400 | InvalidParameter | The errorMessage is %s. Please check it again. | - |
| 400 | InvalidSecurityGroupId.NotFound | The specified SecurityGroupId does not exist. | - |
| 400 | SecurityGroupRuleConflict.Duplicated | The SecurityGroup rule already exists. | - |
| 400 | AuthorizationLimitExceed | The limit of authorization records in the security group reaches. | - |
| 400 | ens.interface.error | An error occurred while calling the API. | - |
| 400 | CallInterface | Call Interface Happen Error. | An error occurred when you call the operation. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2023-12-21 | API Description Update. The Error code has changed. The request parameters of the API has changed | View Change Details |