DescribeExpressConnectRouterInterRegionTransitMode - Express Connect

Queries the inter-region transit mode 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:DescribeExpressConnectRouterInterRegionTransitMode

get

*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****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: Sends a check request without modifying service resources. false (default): Sends a normal request.	true
ClientToken	string	No	The client token that is used to ensure the idempotence of the request. Generate a parameter value from your client to make sure that the value is unique among different requests. The ClientToken parameter supports only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the API request as the ClientToken. The RequestId may be different for each API request.	FF9nMec/RZ6H9oqFn1pvyir/SLRlxCCyHJonbGzqL01hiM6Jb3wJowdHvjCfog7ww1b9rSHMRFJnrUBfVba68TJg==

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	A value of 200 indicates that the call was successful. Other values indicate that the call failed. For more information, see the error codes.	200
Message	string	The message returned for the operation.	OK
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 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 ****
InterRegionTransitModeList	array<object>	The list of cross-region transit modes.
	object
RegionId	string	The ID of the region where the ECR instance is deployed.	cn-hangzhou
Mode	string	The cross-region transit mode of the ECR instance. Valid values: ECMP: The load balancing mode. NearBy: The nearby forwarding mode.	ECMP

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 ****",
  "InterRegionTransitModeList": [
    {
      "RegionId": "cn-hangzhou",
      "Mode": "ECMP"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
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.