ModifyExpressConnectRouterChildInstance

更新时间:
复制 MD 格式

Modifies the properties of a virtual border router (VBR) associated with 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:ModifyExpressConnectRouterChildInstance

update

*ExpressConnectRouter

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

None None

Request parameters

Parameter

Type

Required

Description

Example

EcrId

string

Yes

The ID of the Express Connect Router instance.

ecr-gny3gqp41n7vrrn5iz

ChildInstanceId

string

Yes

The ID of the virtual border router (VBR) instance.

vbr-t4n6xu2d5q0iaad1yl4le

ChildInstanceType

string

Yes

The type of the child instance. Valid value:

  • VBR: a VBR.

VBR

Description

string

No

The description of the child instance. The description must be 0 to 128 characters in length.

test

DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: Performs a dry run to check the request without modifying any resources.

  • false (default): Sends a normal request.

false

ClientToken

string

No

The client token that is used to ensure the idempotence of the request. This token is generated by the client and must be unique among different requests. The token can contain only ASCII characters.

You can generate a token from your client, but you must ensure that the token is unique across different requests. The token can contain only ASCII characters.

Note
  • If you do not specify this parameter, the system uses the RequestId of the request as the ClientToken. The RequestId may be different for each request.

02fb3da4-130e-11e9-8e44-00****

Response elements

Element

Type

Description

Example

object

RpcResponse

RequestId

string

The request ID.

DEB383C4-32C9-53DC-9B8B-8DBA26038074

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 call was successful. For information about other response codes, see the "Error codes" section.

200

Message

string

The response message.

successful

HttpStatusCode

integer

The HTTP status code.

200

DynamicCode

string

The dynamic error code.

IllegalParamFormat.EcrId

DynamicMessage

string

The dynamic error message that 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, this means the DtsJobId parameter that you specified is invalid.

The param format of EcrId **** is illegal.

AccessDeniedDetail

string

The details about the access denial.

Authentication is failed for ****

Examples

Success response

JSON format

{
  "RequestId": "DEB383C4-32C9-53DC-9B8B-8DBA26038074",
  "Success": true,
  "Code": "200",
  "Message": "successful",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.EcrId",
  "DynamicMessage": "The param format of EcrId **** is illegal.",
  "AccessDeniedDetail": "Authentication is failed for ****"
}

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
400 ResourceNotFound.InstanceId The instance id does not exist. The currently entered VPC/TR instance does not exist
400 QuotaExceeded.ChildInstanceNum The number of sub-instances in the switching group exceeds threshold. The number of sub-instances in the switching group exceeds threshold.
400 OperationFailed.NotSupportAcrossRegion Switching groups cannot be formed across regional sub-instances. Switching groups cannot be formed across regional sub-instances.
400 OperationFailed.NotSupportAcrossAccount Switching groups cannot be formed across account sub-instances. Switching groups cannot be formed across account sub-instances.
400 ResourceInConfiguring.NodeId The current subInstance is not in steady state, please try again later. The current subInstance is not in steady state, please try again later.
400 IncorrectStatus.HaVbrGroup The current state of the switching group is not steady state, please try again later. The current state of the switching group is not steady state, please try again later.
400 IncorrectStatus.Vbr The current VBR is not in steady state, please try again later. The current VBR is not in steady state, please try again later.
400 OperationFailed.VbrInUsedByOtherHa The VBR in the input switching group is already in another switching group. The VBR in the input switching group is already in another switching group.
400 OperationFailed.VbrBgpPeerNotEnableBfd The configured BGP PEER of the input VBR in the switching group does not enable BFD. The configured BGP PEER of the input VBR in the switching group does not enable BFD.
400 OperationFailed.VbrEcrNotRelation The VBR in the switching group is not bound to ECR. The VBR in the switching group is not bound to ECR.
400 DeviceNotSupport.EcrVbrHa The access device where the VBR is located does not support configuring a switching group. The access device where the VBR is located does not support configuring a switching group.
400 OperationFailed.VbrBgpGroupLocalAsnNotSupport The BGP group AS number of the VBR configuration in the switching group is not supported. The BGP group AS number of the VBR configuration in the switching group is not supported.
400 OperationFailed.VbrAccessDeviceSame The VBR on the same access device cannot be added to a switching group. The VBR on the same access device cannot be added to a switching group.
400 OperationFailed.VbrBgpGroupLocalAsnNotTheSameWithEcr The AS number of the BGP group of the VBR added to the switching group is different from the AS number of the ECR. The AS number of the BGP group of the VBR added to the switching group is different from the AS number of the ECR.
400 OperationFailed.VbrBgpGroupLocalAsnNotTheSameWithOther The BGP group AS number of the VBR configuration in the switching group is not exactly the same. The BGP group AS number of the VBR configuration in the switching group is not exactly the same.
400 OperationFailed.VbrEcrNotConsistent The VBR in the switching group is not bound to the same ECR. The VBR in the switching group is not bound to the same ECR.
404 ResourceNotFound.EcrId EcrId not found. ECR instance does not exist

See for a complete list.

Release notes

See Release Notes for a complete list.