ListTransitRouterMulticastDomainVSwitches - Cloud Enterprise Network

Queries the vSwitches of multicast domains in a virtual private cloud (VPC).

Operation Description

You can query vSwitches only in VPCs that are connected to Enterprise Edition transit routers.

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 Resources is 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	Association operation
cen:ListTransitRouterMulticastDomainVSwitches	Read	CEN acs:cen:*:{#accountId}:ceninstance/{#ceninstanceId}	none	none

Request parameters

Parameter	Type	Required	Description	Example
CenId	string	Yes	The ID of the Cloud Enterprise Network (CEN) instance.	cen-44m0p68spvlrqq****
VpcId	string	Yes	The ID of the VPC.	vpc-p0wr1cd4fcuxy3ui0****
VSwitchIds	array	No	The vSwitch IDs.
	string	No	The ID of the vSwitch. You can specify at most 50 vSwitch IDs in each call.	vsw-p0w5ejr9bzfsttiza****
MaxResults	integer	No	The number of entries to return on each page. Minimum value: 0. Default value: 20.	20
NextToken	string	No	The token that determines the start point of the query. Valid values: If this is your first query or no subsequent query is to be sent, ignore this parameter. If a next query is to be sent, set the value to the value of NextToken that is returned from the last call.	FFmyTO70tTpLG6I3FmYAXGKPd****

Response parameters

Parameter	Type	Description	Example
	object	The response.
NextToken	string	The token that determines the start point of the query. Valid values: If NextToken was not returned, it indicates that no additional results exist. If NextToken was returned in the previous query, specify the value to obtain the next set of results.	FFmyTO70tTpLG6I3FmYAXGKPd****
RequestId	string	The ID of the request.	B0E7E43C-979A-5130-AA0D-B3ADA69E0827
TotalCount	integer	The total number of entries returned.	2
MaxResults	integer	The number of entries returned on each page.	20
VSwitchIds	array	The vSwitch IDs.
	string	The ID of the vSwitch.	vsw-p0w5ejr9bzfsttiza****

Examples

Sample success responses

JSONformat

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "B0E7E43C-979A-5130-AA0D-B3ADA69E0827",
  "TotalCount": 2,
  "MaxResults": 20,
  "VSwitchIds": [
    "vsw-p0w5ejr9bzfsttiza****"
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParam.NextToken	The specified NextToken is invalid.	The error message returned because the NextToken parameter is set to an invalid value.
400	IllegalParam.TrInstance	The specified TransitRouter is invalid.	The error message returned because the TransitRouter parameter is set to an invalid value.
400	IllegalParam.Region	The specified Region is invalid.	The error message returned because the specified region is invalid.
400	InvalidCenId.NotFound	CenId is not found.	The error message returned because the specified CEN instance does not exist.

For a list of error codes, visit the Service error codes.