DescribeExpressConnectRouter - Express Connect - Alibaba Cloud Documentation Center

Queries a list of Express Connect Router (ECR) instances.

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

list

*ExpressConnectRouter

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

None

Request parameters

Parameter	Type	Required	Description	Example
EcrId	string	No	The ID of ECR.	ecr-fu8rszhgv7623c****
Name	string	No	The name of ECR. The name must be 0 to 128 characters in length.	test
NextToken	string	No	The token that is used for the next query. Valid values: You do not need to specify this parameter for the first query. For a subsequent query, set this parameter to the NextToken value returned from the last API call.	e0a2dbeb69a8beeeb8194e92b702df3fd3e7bfe6ce7bfc16e0b5e8707e68181f
MaxResults	integer	No	The maximum number of entries to return. Valid values: 1 to 2147483647. Default value: 20.	20
Tag	array<object>	No	The list of tags to filter results. You can specify up to 20 tags.
	object	No	The tag information.
Key	string	No	The tag key of the instance. The tag key cannot be an empty string. The tag key can be up to 64 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`.	TestKey
Value	string	No	The tag value. The tag value can be up to 128 characters in length and cannot start with `aliyun` or `acs:`. It cannot contain `http://` or `https://`. The tag value can be an empty string.	TestValue
ResourceGroupId	string	No	The ID of the resource group to which the ECR belongs.	rg-aek2aq7f4va****
DryRun	boolean	No	Specifies whether to perform a dry run. Valid values: true: sends a check request. The service resource is not modified. false (default): sends a normal request.	false
ClientToken	string	No	A client token that is used to ensure the idempotence of the request. You can use the client to generate the token, but you must make sure that the token is unique among different requests. The token can contain only ASCII characters. Note If you do not specify this parameter, the system automatically uses the RequestId of the request as the ClientToken. The RequestId of each request is different.	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 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 more information, 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` variable 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 DtsJobId parameter is invalid.	The param format of Name **** is illegal.
AccessDeniedDetail	string	The details of the access denial.	Authentication is failed for ****
TotalCount	integer	The total number of ECR instances.	2
MaxResults	integer	The maximum number of entries returned. Valid values: 1 to 2147483647. Default value: 20.	20
NextToken	string	The token that is used for the next query. Valid values: If this parameter is empty, it indicates that no more results are to be returned. If a value is returned, the value is the token that is used for the next query.	AAAAAdDWBF2w6Olxc+cMPjUtUMpttDGZkffvHCfhBKKNEyCVaq+WUEzuUWpp9+QOApNf6g==
EcrList	array<object>	The list of ECR instances.
	object	The ECR instance.
EcrId	string	The ID of ECR.	ecr-mezk2idmsd0vx2****
OwnerId	integer	The ID of the Alibaba Cloud account to which the ECR belongs.	170646818729****
GmtCreate	string	The time when the ECR was created. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2023-02-16T01:44:50Z
GmtModified	string	The time when the ECR was last modified. The time is displayed in the ISO 8601 standard in the YYYY-MM-DDThh:mm:ssZ format. The time is displayed in UTC.	2023-02-16T01:44:50Z
Status	string	The deployment status of the service instance. Valid values: ACTIVE: created. UPDATING: being modified. ASSOCIATING: being attached. DISSOCIATING: being detached. LOCKED_ATTACHING: locked by an external system for attachment. LOCKED_DETACHING: locked by an external system for detachment. RECLAIMING: waiting for resource release. DELETING: being deleted.	Active
BizStatus	string	The business status of the service instance. Valid values: Normal: The instance is running as expected. FinancialLocked: The instance is locked due to an overdue payment.	Normal
ResourceGroupId	string	The ID of the resource group to which the ECR instance belongs.	rg-aekzuscospt****
Tags	array<object>	The list of tags.
	object	The tag.
TagKey	string	The tag key of the ECR instance.	test
TagValue	string	The tag value of the ECR instance.	test
Name	string	The name of the ECR instance.	test
Description	string	The description of the ECR instance.	test
AlibabaSideAsn	integer	The ASN of the ECR instance.	45104

Examples

Success response

JSON format

{
  "RequestId": "6FABF516-FED3-5697-BDA2-B18C5D9A****",
  "Success": true,
  "Code": "200",
  "Message": "OK",
  "HttpStatusCode": 200,
  "DynamicCode": "IllegalParamFormat.Name",
  "DynamicMessage": "The param format of Name **** is illegal.",
  "AccessDeniedDetail": "Authentication is failed for ****",
  "TotalCount": 2,
  "MaxResults": 20,
  "NextToken": "AAAAAdDWBF2w6Olxc+cMPjUtUMpttDGZkffvHCfhBKKNEyCVaq+WUEzuUWpp9+QOApNf6g==",
  "EcrList": [
    {
      "EcrId": "ecr-mezk2idmsd0vx2****",
      "OwnerId": 0,
      "GmtCreate": "2023-02-16T01:44:50Z\n",
      "GmtModified": "2023-02-16T01:44:50Z",
      "Status": "Active",
      "BizStatus": "Normal",
      "ResourceGroupId": "rg-aekzuscospt****",
      "Tags": [
        {
          "TagKey": "test",
          "TagValue": "test"
        }
      ],
      "Name": "test",
      "Description": "test",
      "AlibabaSideAsn": 45104
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	IllegalParamFormat.%s	The param format of %s is illegal.	Illegal parameter format
400	IllegalParam.%s	The param of %s is illegal.	Illegal parameter

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.