ListErRouteMaps-阿里云帮助中心

Routing policies are queried.

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

eflo:ListErRouteMaps

list

*ErRouteMap

acs:eflo:{#regionId}:{#accountId}:Er_RMap/{#ErRouteMapId}

None

Request parameters

Parameter	Type	Required	Description	Example
ErRouteMapId	string	No	routing policy ID	er-rmap-uwglhzom
ErRouteMapNum	integer	No	Policy number (default for automatic creation is 3000; The value range of the policy number manually created by the user is 1001-2000)	1001
RouteMapAction	string	No	Policy behavior; optional values: permit: Allow deny: Rejected	deny
TransmissionInstanceId	string	No	Release Instance ID	vpd-xsdlg2xb
TransmissionInstanceName	string	No	Release Instance Name	vpd1
TransmissionInstanceType	string	No	The type of the published instance. Optional values: VPD: Lingjun network segment. VCC: Lingjun Connection.	VPD
ReceptionInstanceId	string	No	Receive Instance ID	vpd-x2lohgpv
ReceptionInstanceName	string	No	Receive Instance Name	vpd2
ReceptionInstanceType	string	No	The type of the received instance. Optional values: VPD: Lingjun network segment. VCC: Lingjun Connection.	VPD
DestinationCidrBlock	string	No	Destination CIDR Block	0.0.0.0/0
ResourceGroupId	string	No	Resource group instance ID	rg-acfmzzka6bnjvbi
RegionId	string	Yes	The region ID.	cn-wulanchabu
ErId	string	Yes	Elastic Router ID	er-kkopgtne
PageNumber	integer	No	The page number of the page to return. Pages start from page 1. Default value: 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value: 10.	10
EnablePage	boolean	No	Specifies whether to enable paged query.	false

Response elements

Element	Type	Description	Example
	object	AjaxResult<PageResult>
Code	integer	The response status code.	0
Message	string	The error message. (If the instance is in the Exception state, the exception cause is prompted.)	成功
RequestId	string	The request ID.	0901F411-28FA-5B9C-BAEE-7776463FF0DC
Content	object	The response parameters.
Total	integer	The total number of entries returned.	0
Data	array<object>	routing policy information list
	object	routing policy information
RegionId	string	The region ID.	cn-wulanchabu
TenantId	string	The ID of the tenant.	1655449505171
CreateTime	string	The time when the data address was created.	1601176751000
GmtModified	string	The time when the agent was last modified.	1601176751000
Message	string	The message that is returned.	成功
Status	string	Status The status of the instance. Valid values: Available Not Available: Unavailable Executing: Executing Deleting: The node is being deleted.	Available
ErRouteMapId	string	routing policy ID	er-rmap-uwglhzom
ErId	string	Lingjun HUB ID	er-kkopgtne
RouteMapNum	integer	The ID of the policy. A smaller sequence number indicates a lower priority. When a route is matched, a policy with a higher priority is preferentially matched. Valid values: 1001 to 2000	1001
Description	string	Policy description	描述
DestinationCidrBlock	string	Destination CIDR Block	0.0.0.0/0
TransmissionInstanceName	string	Release Instance Name	vpd-transmit
TransmissionInstanceId	string	Release Instance ID	vpd-8rgvqazb
TransmissionInstanceType	string	The type of the published instance. Possible values: VPD: Lingjun network segment. VCC: Lingjun Connection.	VPD
ReceptionInstanceName	string	Receive Instance Name	vpd-reception
ReceptionInstanceId	string	Receive Instance ID	vpd-9rgxqazc
ReceptionInstanceType	string	The type of the received instance. Possible values: VPD: Lingjun network segment. VCC: Lingjun Connection.	VPD
Action	string	Policy behavior; optional values: permit: Allow deny: Prohibited	permit
TransmissionInstanceOwner	string	The tenant to which the published instance belongs	1620939556166277
ReceptionInstanceOwner	string	The tenant to which the receiving instance belongs	1620939556166277
ResourceGroupId	string	Resource group instance ID	rg-acfm4c7urez5byi
AccessDeniedDetail	string	The details about the access denial.	None

Examples

Success response

JSON format

{
  "Code": 0,
  "Message": "成功",
  "RequestId": "0901F411-28FA-5B9C-BAEE-7776463FF0DC",
  "Content": {
    "Total": 0,
    "Data": [
      {
        "RegionId": "cn-wulanchabu",
        "TenantId": "1655449505171",
        "CreateTime": "1601176751000",
        "GmtModified": "1601176751000",
        "Message": "成功",
        "Status": "Available",
        "ErRouteMapId": "er-rmap-uwglhzom",
        "ErId": "er-kkopgtne",
        "RouteMapNum": 1001,
        "Description": "描述",
        "DestinationCidrBlock": "0.0.0.0/0",
        "TransmissionInstanceName": "vpd-transmit",
        "TransmissionInstanceId": "vpd-8rgvqazb",
        "TransmissionInstanceType": "VPD",
        "ReceptionInstanceName": "vpd-reception",
        "ReceptionInstanceId": "vpd-9rgxqazc",
        "ReceptionInstanceType": "VPD",
        "Action": "permit",
        "TransmissionInstanceOwner": "1620939556166277",
        "ReceptionInstanceOwner": "1620939556166277",
        "ResourceGroupId": "rg-acfm4c7urez5byi"
      }
    ]
  },
  "AccessDeniedDetail": "None"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.