DescribeExpressConnectRouterAllowedPrefixHistory - Express Connect

Queries the prefix route history for 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:DescribeExpressConnectRouterAllowedPrefixHistory

list

*ExpressConnectRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of the Express Connect Router (ECR) instance.	ecr-mezk2idmsd0vx2****
InstanceId	string	No	The ID of the network instance that is associated with the ECR. Note Specify either the InstanceId or AssociationId parameter.	vbr-j6cwxhgg0s5nuephp****
InstanceType	string	No	The type of the network instance. Valid values: VPC: A virtual private cloud (VPC) instance. TR: A transit router (TR) instance.	VPC
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: The system runs a check request. It does not modify any resources. false (default): The system sends a normal request.	true
ClientToken	string	No	A client token to ensure that the request is idempotent. Generate a unique client-side value to ensure that the request is idempotent. The client token can contain only ASCII characters. Note If you do not specify this parameter, the system uses the RequestId as the ClientToken. The RequestId is unique for each request.	FF9nMec/RZ6H9oqFn1pvyir/SLRlxCCyHJonbGzqL01hiM6Jb3wJowdHvjCfog7ww1b9rSHMRFJnrUBfVba68TJg==
AssociationId	string	No	The ID of the association between the ECR and the VPC or transit router. Note Specify either the InstanceId or AssociationId parameter.	ecr-assoc-9p2qxx5phpca2m****

Response elements

Element	Type	Description	Example
	object	RpcResponse
RequestId	string	The request ID.	6FABF516-FED3-5697-BDA2-B18C5D9A****
Success	boolean	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	True
Code	string	The response code. A value of 200 indicates that the request was successful. Other values indicate that the request failed. For more information, see the Error codes section.	200
Message	string	The response message.	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` placeholder in the error message. Note For example, if the error message is The value of input parameter %s is not valid. and this parameter returns DtsJobId, it means the specified DtsJobId parameter is invalid.	The param format of EcrId **** is illegal.
AccessDeniedDetail	string	Details about the access denial.	Authentication is failed for ****
AllowedPrefixHistoryList	array<object>	The list of historical prefix routes.
	object
AllowedPrefix	array	The prefix routes.
	string	A prefix route.	10.0../1
GmtCreate	string	The time when the historical route was created.	1673751163000

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId\n",
  "DynamicMessage": "The param format of EcrId **** is illegal.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "AllowedPrefixHistoryList": [
    {
      "AllowedPrefix": [
        "10.0.**.**/1"
      ],
      "GmtCreate": "1673751163000"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	ResourceNotFound.InstanceId	The instance id does not exist.	The currently entered VPC/TR instance does not exist
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
404	ResourceNotFound.AssociationId	EcrAssociationId not found.	ECR Association instance does not exist

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.