GetUserVpcVSwitch - Performance Testing - Alibaba Cloud Documentation Center

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

pts:GetUserVpcVSwitch

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
PageNumber	integer	Yes	The page number for a paged query.	1
PageSize	integer	Yes	The number of records to display on each page.	1
RegionId	string	Yes	The region ID.	cn-hangzhou
VpcId	string	Yes	The virtual private cloud (VPC) ID.	vpc-2ze22scdz2ebdfjasdfjkqhf4pyj

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The system status code.	200
HttpStatusCode	integer	The HTTP status code.	200
Message	string	The error message. This parameter is empty if the request is successful.	空
PageNumber	integer	The page number for a paged query.	1
PageSize	integer	The number of records displayed on each page.	5
RequestId	string	The request ID.	0235E5FC-4C7C-5F0C-843C-FC674F15F947
Success	boolean	Indicates whether the request was successful. true: The request was successful. false: The request failed.	true
VSwitchCount	integer	The number of vSwitches.	6
VSwitchList	array<object>	The list of vSwitches.
	object	The vSwitch information.
AvailableIpAddressCount	integer	The number of available IP addresses in the vSwitch.	1000
MaxAgentCount	integer	The maximum number of pressure-testing agents that can be added.	1000
VSwitchId	string	The vSwitch ID.	vsw-bp1eil9df23rsd8l1sevebiszooj
VSwitchName	string	The name of the virtual switch.	my-vswitch
VpcId	string	The VPC ID.	vpc-wz9bpdaebft6j23fesdf84v2f1um3a

Examples

Success response

JSON format

{
  "Code": "200",
  "HttpStatusCode": 200,
  "Message": "空",
  "PageNumber": 1,
  "PageSize": 5,
  "RequestId": "0235E5FC-4C7C-5F0C-843C-FC674F15F947",
  "Success": true,
  "VSwitchCount": 6,
  "VSwitchList": [
    {
      "AvailableIpAddressCount": 1000,
      "MaxAgentCount": 1000,
      "VSwitchId": "vsw-bp1eil9df23rsd8l1sevebiszooj",
      "VSwitchName": "my-vswitch",
      "VpcId": "vpc-wz9bpdaebft6j23fesdf84v2f1um3a"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
403	Code	The specified parameter is invalid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.