Use ListGrantVSwitchesToCen to query vSwitches in a cross-account VPC - Cloud Enterprise Network - Alibaba Cloud - Cloud Enterprise Network

Operation description

Before you invoke the ListGrantVSwitchesToCen operation, make sure that the CEN instance has been granted authorization to access the cross-account VPC-connected instance. For more information, see GrantInstanceToCen.

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

cen:ListGrantVSwitchesToCen

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the VPC-connected instance. You can invoke the DescribeChildInstanceRegions operation to query region IDs.	cn-hangzhou
CenId	string	Yes	The CEN instance ID.	cen-44m0p68spvlrqq****
VpcId	string	Yes	The VPC-connected instance ID.	vpc-bp12ge2tq5gzdc915****
PageNumber	integer	No	The page number of the list. Default value: 1.	1
PageSize	integer	No	The number of entries per page for paging. Valid values: 1 to 50. Default value: 10.	10
ZoneId	string	No	The zone ID. If you specify a zone ID, the system queries only the vSwitches that are in the specified zone of the VPC-connected instance. If you do not specify a zone ID, the system queries the vSwitches in all active zones of the VPC-connected instance by default. You can invoke the DescribeZones operation to query zone IDs.	cn-hangzhou-h
EnabledIpv6	boolean	No	Specifies whether IPv6 is enabled. A value of true indicates that IPv6 is enabled. A value of false indicates that IPv6 is not enabled. If you leave this parameter empty, the system does not filter by this property.	true

Response elements

Element	Type	Description	Example
	object	The response.
PageSize	integer	The number of entries per page for paging.	10
RequestId	string	The request ID.	A9288C78-881A-5D30-A8A9-68E05EE0A086
PageNumber	integer	The page number of the list.	1
TotalCount	integer	The total number of entries in the list.	2
VSwitches	array<object>	The list of vSwitch information.
	object	The vSwitch information.
VpcId	string	The VPC-connected instance ID to which the vSwitch belongs.	vpc-bp12ge2tq5gzdc915****
ZoneId	string	The zone ID of the vSwitch.	cn-hangzhou-h
VSwitchId	string	The vSwitch instance ID.	vsw-bp1194lh263wx1gsk****
VSwitchName	string	The name of the vSwitch.	nametest

Examples

Success response

JSON format

{
  "PageSize": 10,
  "RequestId": "A9288C78-881A-5D30-A8A9-68E05EE0A086",
  "PageNumber": 1,
  "TotalCount": 2,
  "VSwitches": [
    {
      "VpcId": "vpc-bp12ge2tq5gzdc915****",
      "ZoneId": "cn-hangzhou-h",
      "VSwitchId": "vsw-bp1194lh263wx1gsk****",
      "VSwitchName": "nametest"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameter	Invalid parameter.	The error message returned because the parameter is set to an invalid value.
400	Unauthorized	The AccessKeyId is unauthorized.	The error message returned because you do not have the permissions to perform this operation.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.