ModifyExpressConnectRouter - Express Connect - Alibaba Cloud Documentation Center

Modifies the properties of an Express Connect Router (ECR), such as its name.

Operation description

You can modify an Express Connect Router (ECR) instance only when it is in the Active state.

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:ModifyExpressConnectRouter

update

*ExpressConnectRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	Yes	The ID of ECR.	ecr-fu8rszhgv7623c****
Name	string	No	The name of ECR. Note The name can be empty or 0 to 128 characters in length. It cannot start with http:// or https://.	test
Description	string	No	The description of ECR. Note The description can be empty or 0 to 256 characters in length. It cannot start with http:// or https://.	test
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request without modifying the service resource. false (default): Sends a normal request.	false
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a unique value for this parameter from your client. 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 of each request is unique.	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 ECR instance was successfully modified. Valid values: true: The instance was modified. false: The modification failed.	True
Code	string	The response code. A value of 200 indicates that the request was successful. For more information about other error codes, see the "Error codes" section.	200
Message	string	The returned message.	OK
HttpStatusCode	integer	The HTTP status code.	200
DynamicCode	string	The dynamic error code.	IllegalParamFormat.Name
DynamicMessage	string	The dynamic error message that is used to replace the `%s` placeholder in the ErrMessage parameter. Note If ErrMessage returns The Value of Input Parameter %s is not valid and DynamicMessage returns DtsJobId, it indicates that the specified DtsJobId parameter is invalid.	The param format of Name **** is illegal.
AccessDeniedDetail	string	The details of the access denial.	Authentication is failed for ****

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****\n",
  "Success": true,
  "Code": "200",
  "Message": "OK\n",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.Name\n",
  "DynamicMessage": "The param format of Name **** is illegal.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n"
}

Error codes

HTTP status code	Error code	Error message	Description
400	IncorrectStatus.Ecr	Ecr Status does not allow current operation.	The status of the express connect gateway instance does not allow the current operation. Currently, other operations are being performed or the express connect gateway instance is being deleted. Please try again later.
400	OperationDenied.ForceDeleting	The current instance is being deleted.	Your current operation is rejected and the leased line gateway instance is being forcibly deleted. Please try again later.
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	Conflict.Lock	There are other unfinished operations.	You currently have other unfinished operations, please try again later
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.