DescribeExpressConnectRouterRouteEntries - Express Connect

Describes the route entries of an Express Connect Router (ECR).

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

expressconnectrouter:DescribeExpressConnectRouterRouteEntries

list

*ExpressConnectRouter

acs:expressconnectrouter::{#accountId}:expressconnectrouter/{#EcrId}

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of the ECR instance.	ecr-mezk2idmsd0vx2****
QueryRegionId	string	No	The region where the ECR instance is deployed.	cn-hangzhou
DestinationCidrBlock	string	No	The destination CIDR block of the route that you want to query.	172.20.47.0/24
NexthopInstanceId	string	No	The ID of the next hop instance.	br-hp3u4u5f03tfuljis****
AsPath	string	No	The AS path of the route.	[64993,64512]
Community	string	No	The community value of the Border Gateway Protocol (BGP) route.	9001:9263
NextToken	string	No	The token that is used for the next query. Valid values: Leave this parameter empty for the first query or if no subsequent queries are required. If a subsequent query is required, set the value to the NextToken value returned from the previous API call.	FF9nMec/RZ6H9oqFn1pvyir/SLRlxCCyHJonbGzqL01hiM6Jb3wJowdHvjCfog7ww1b9rSHMRFJnrUBfVba68TJg==
MaxResults	integer	No	The maximum number of entries to return on each page. Valid values: 1 to 2147483647. Default value: 10.	10
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: performs a dry run but does not modify the service resource. false (default): sends the request.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.	02fb3da4-130e-11e9-8e44-00****

Response parameters

Parameter	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	6FABF516-FED3-5697-BDA2-B18C5D9A****
Success	boolean	Indicates whether the call is successful. Valid values: True: The call is successful. False: The call failed.	True
Code	string	Indicates whether the call is successful. A value of 200 indicates that the call is successful. Other values indicate that the call failed. For more information, see the Error Codes section.	200
Message	string	The message that is returned.	OK
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	IllegalParamFormat.EcrId
DynamicMessage	string	The dynamic error message. This message is used to replace the `%s` variable in the value of the ErrMessage parameter. Note For example, if the value of ErrMessage is The Value of Input Parameter %s is not valid and the value of DynamicMessage is DtsJobId, the specified DtsJobId parameter is invalid.	The param format of EcrId **** is illegal.
AccessDeniedDetail	string	The details of the access denial.	Authentication is failed for ****
TotalCount	integer	The total number of entries.	2
MaxResults	integer	The maximum number of entries returned per page. Valid values: 1 to 2147483647. Default value: 10.	6
NextToken	string	The token that is used for the next query. Valid values: If this parameter is empty, no subsequent query is sent. If a value is returned, the value is the token that is used for the next query.	gAAAAABkWwFTUMNCdWC0VMYOIylA56Hx6JUfCZlk5hQ5g_fnKmetN6303tqq5UJ2ouJzyT2fDOdzb-NqyEB5jcY8Z2euX7qHDA==
RouteEntriesList	array<object>	The list of routes.
	object
DestinationCidrBlock	string	The destination CIDR block of the route.	192.168.0.0/16
Status	string	The status of the ECR instance.	ACTIVE
NexthopInstanceId	string	The ID of the next hop instance.	br-hp3u4u5f03tfuljis****
NexthopInstanceRegionId	string	The region where the next hop instance is deployed.	cn-hangzhou
AsPath	string	The AS path of the route.	[64993,64512]
Community	string	The community value of the BGP route.	9001:9263
Med	integer	The MED value of the BGP route. The MED value is used to select the optimal route between an ECR and a transit router. You can set the MED value to 2,000 and the path between the TR and the ECR becomes the default path. If the path is not the default path, this parameter is empty. For transit routers in the same CEN, you can set the MED value of only one associated object to 2000.	2000

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId",
  "DynamicMessage": "The param format of EcrId **** is illegal.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "TotalCount": 2,
  "MaxResults": 6,
  "NextToken": "gAAAAABkWwFTUMNCdWC0VMYOIylA56Hx6JUfCZlk5hQ5g_fnKmetN6303tqq5UJ2ouJzyT2fDOdzb-NqyEB5jcY8Z2euX7qHDA==",
  "RouteEntriesList": [
    {
      "DestinationCidrBlock": "192.168.0.0/16",
      "Status": "ACTIVE",
      "NexthopInstanceId": "br-hp3u4u5f03tfuljis****\n",
      "NexthopInstanceRegionId": "cn-hangzhou",
      "AsPath": "[64993,64512]",
      "Community": "9001:9263",
      "Med": 2000
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParamFormat.DestinationCidrBlock	The format of the specified destination Cidr route parameter is incorrect.	The format of the destination Cidr routing parameter you specified is incorrect. Please check and enter it again.
400	MissingParam.%s	The param of %s is missing.	The request parameters are not specified. Please check the corresponding parameters and try again.
400	IllegalParamFormat.%s	The param format of %s is illegal.	Illegal parameter format
400	IllegalParam.%s	The param of %s is illegal.	Illegal parameter
404	ResourceNotFound.EcrId	EcrId not found.	ECR instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.