All Products
Search
Document Center

Express Connect:CheckAddRegionToExpressConnectRouter

Last Updated:Nov 28, 2025

Checks the Cloud Data Transfer (CDT) service, which is required to add a region to 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:CheckAddRegionToExpressConnectRouter

none

*ExpressConnectRouter

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

None None

Request parameters

Parameter

Type

Required

Description

Example

EcrId

string

Yes

The ID of ECR.

ecr-fu8rszhgv7623c****

FreshRegionId

string

Yes

The ID of the region that you want to add to ECR.

cn-hangzhou

DryRun

boolean

No

Specifies whether to perform a dry run. Valid values:

  • true: performs a dry run to check the request. No service resources are modified.

  • 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 token on your client. The 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 API request may be different.

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

Response elements

Element

Type

Description

Example

object

RpcResponse

RequestId

string

The request ID.

6FABF516-FED3-5697-BDA2-B18C5D9A****

Success

boolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.

  • false: The call failed.

True

Code

string

The status code. A value of 200 indicates that the call was successful. For 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.EcrId

DynamicMessage

string

The dynamic error message. This message is used to replace the %s placeholder in the error message.

Note

If the ErrMessage parameter returns The Value of Input Parameter %s is not valid and this parameter returns DtsInstanceId, it means that the DtsInstanceId parameter is invalid.

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

AccessDeniedDetail

string

The details about the access denial.

Authentication is failed for ****

IsCdtInterRegionEnabled

boolean

Indicates whether the CDT service is enabled for the account to which the ECR instance belongs. Valid values:

  • true: Yes.

  • false: No.

true

IsCdtCrossBorderEnabled

boolean

Indicates whether the cross-border CDT service is enabled for the account to which the ECR instance belongs. Valid values:

  • true: Yes.

  • false: No.

true

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.",
  "AccessDeniedDetail": "Authentication is failed for ****",
  "AnyInterRegionLink": true,
  "AnyCrossBorderLink": true,
  "IsCdtInterRegionEnabled": true,
  "IsCdtCrossBorderEnabled": true,
  "IsUserAllowedToCreateCrossBorderLink": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 UnsupportedRegion Feature not supported in specified region. The specified region does not support the leased line gateway function.
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 InternalErrorTemp The request processing has failed due to some unknown error. The request processing has failed due to some unknown error.
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.