DescribeExpressConnectRouter - 查询专线网关(ECR)列表

查询专线网关ECR(Express Connect Router)列表。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

expressconnectrouter:DescribeExpressConnectRouter

list

*ExpressConnectRouter

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

请求参数

名称

类型

必填

描述

示例值

EcrId

string

专线网关实例 ID。

ecr-fu8rszhgv7623c****

Name

string

专线网关实例名称。长度为 0~128 个字符。

test

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 第一次查询和没有下一次查询时,均无需填写。

  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。

e0a2dbeb69a8beeeb8194e92b702df3fd3e7bfe6ce7bfc16e0b5e8707e68181f

MaxResults

integer

本次读取的最大数据量。取值范围:1~2147483647。默认值为 20。

20

Tag

array<object>

进行过滤的标签列表。最多支持 20 个标签。

object

标签信息。

Key

string

实例的标签键。一旦传入该值,则不允许为空字符串。

最多支持 64 个字符,不能以aliyunacs:开头,不能包含http://或者https://

TestKey

Value

string

标签值。最多支持 128 个字符,不能以aliyunacs:开头,不能包含http://或者https://。一旦输入该值,可以为空字符串。

TestValue

ResourceGroupId

string

专线网关实例所属资源组的 ID。

rg-aek2aq7f4va****

DryRun

boolean

是否只预检此次请求。取值:

  • true:发送检查请求,不会修改服务资源。

  • false(默认值):发送正常请求。

false

ClientToken

string

客户端 Token,用于保证请求的幂等性。

从您的客户端生成一个参数值,确保不同请求间该参数值唯一。ClientToken 只支持 ASCII 字符。

说明

若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。

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

返回参数

名称

类型

描述

示例值

object

RpcResponse

RequestId

string

请求 ID。

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

Success

boolean

查询已创建 ECR 实例是否成功。取值:

  • True:成功。

  • False:失败。

True

Code

string

判断调用是否成功。返回值为 200 表示加载成功,返回其他值表示加载失败,失败原因参见错误码。

200

Message

string

操作返回信息。

OK

HttpStatusCode

integer

HTTP 状态码。

200

DynamicCode

string

动态错误码。

IllegalParamFormat.Name

DynamicMessage

string

动态错误信息,用于替换返回参数 ErrMessage 错误信息中的%s

说明

如果 ErrMessage 返回The Value of Input Parameter %s is not valid,且 DynamicMessage 返回 DtsJobId,则代表所传入的请求参数 DtsJobId 不合法。

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

AccessDeniedDetail

string

访问被拒绝详细信息。

Authentication is failed for ****

TotalCount

integer

专线网关实例总条数。

2

MaxResults

integer

本次读取的最大数据量。取值范围:1~2147483647。默认值为 20。

20

NextToken

string

是否拥有下一次查询的令牌(Token)。取值:

  • 如果 NextToken 为空表示没有下一次查询。

  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。

AAAAAdDWBF2w6Olxc+cMPjUtUMpttDGZkffvHCfhBKKNEyCVaq+WUEzuUWpp9+QOApNf6g==

EcrList

array<object>

专线网关实例列表。

object

专线网关实例。

EcrId

string

专线网关实例 ID。

ecr-mezk2idmsd0vx2****

OwnerId

integer

专线网关实例所属的阿里云账号 ID。

170646818729****

GmtCreate

string

专线网关实例创建时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2023-02-16T01:44:50Z

GmtModified

string

专线网关实例修改时间。按照 ISO8601 标准表示,并需要使用 UTC 时间。格式为:YYYY-MM-DDThh:mm:ssZ。

2023-02-16T01:44:50Z

Status

string

服务实例的部署状态。可能值:

  • ACTIVE:已创建。

  • UPDATING:修改中。

  • ASSOCIATING:资源绑定中。

  • DISSOCIATING:资源解绑中。

  • LOCKED_ATTACHING:被外部系统绑定锁定。

  • LOCKED_DETACHING:被外部系统解绑锁定。

  • RECLAIMING:等待释放资源。

  • DELETING:删除中。

Active

BizStatus

string

服务实例的业务状态。可能的值:

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal

ResourceGroupId

string

专线网关实例所属资源组的 ID。

rg-aekzuscospt****

Tags

array<object>

标签列表。

object

标签。

TagKey

string

专线网关实例的标签键。

test

TagValue

string

专线网关实例的标签值。

test

Name

string

专线网关实例名称。

test

Description

string

专线网关实例的描述信息。

test

AlibabaSideAsn

integer

专线网关实例的 ASN 号。

45104

示例

正常返回示例

JSON格式

{
  "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
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述

400 IllegalParamFormat.%s The param format of %s is illegal. 参数格式非法
400 IllegalParam.%s The param of %s is illegal. 参数非法

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情