文档

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

更新时间:

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
EcrIdstring

专线网关实例 ID。

ecr-fu8rszhgv7623c****
Namestring

专线网关实例名称。

test
NextTokenstring

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

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
e0a2dbeb69a8beeeb8194e92b702df3fd3e7bfe6ce7bfc16e0b5e8707e68181f
MaxResultsinteger

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

20
TagModelsobject []

标签列表。

TagKeystring

专线网关的标签键。最多支持输入 20 个标签键。如果传入该值,则不能输入空字符串。

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

ecr-tag
TagValuestring

专线网关的标签值。最多支持输入 20 个标签值。如需传入该值,可以输入空字符串。

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

testTagValueKZqhJi
ResourceGroupIdstring

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

rg-aek2aq7f4va****
DryRunboolean

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

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

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

false
ClientTokenstring

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
02fb3da4-130e-11e9-8e44-00****

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

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

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

  • True:成功。
  • False:失败。
True
Codestring

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

200
Messagestring

操作返回信息。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
DynamicCodestring

动态错误码。

IllegalParamFormat.Name
DynamicMessagestring

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

说明 如果 ErrMessage 返回The Value of Input Parameter %s is not valid,且 DynamicMessage 返回 DtsJobId,则代表所传入的请求参数 DtsJobId 不合法。
The param format of Name **** is illegal.
AccessDeniedDetailstring

访问被拒绝详细信息。

Authentication is failed for ****
TotalCountinteger

专线网关实例总条数。

2
MaxResultsinteger

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

20
NextTokenstring

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
AAAAAdDWBF2w6Olxc+cMPjUtUMpttDGZkffvHCfhBKKNEyCVaq+WUEzuUWpp9+QOApNf6g==
EcrListobject []

专线网关实例列表。

EcrIdstring

专线网关实例 ID。

ecr-mezk2idmsd0vx2****
OwnerIdlong

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

170646818729****
GmtCreatestring

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

2023-02-16T01:44:50Z
GmtModifiedstring

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

2023-02-16T01:44:50Z
Statusstring

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

  • ACTIVE:已创建。

  • UPDATING:修改中。

  • ASSOCIATING:资源绑定中。

  • DISSOCIATING:资源解绑中。

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

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

  • RECLAIMING:等待释放资源。

  • DELETING:删除中。

Active
BizStatusstring

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

  • Normal:正常。

  • FinancialLocked:欠费锁定。

Normal
ResourceGroupIdstring

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

rg-aekzuscospt****
Tagsobject []

标签列表。

Idlong

标签的 ID。

000000100089****
ResourceIdstring

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

rg-aek2aq7f4va****
ResuorceTypestring

资源类型。

ECR
RegionNostring

专线网关实例所在的地域 ID。

cn-shanghai
AliUidlong

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

181614792955****
TagKeystring

专线网关实例的标签键。

test
TagValuestring

专线网关实例的标签值。

test
Scopeinteger

查看取值。

  • 0:不可见。

  • 1:可见。

0
Categoryinteger

用户类型。

  • 0:普通用户。

  • 1:系统用户。

0
Namestring

专线网关实例名称。

test
Descriptionstring

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

test
AlibabaSideAsnlong

专线网关实例的 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": [
        {
          "Id": 0,
          "ResourceId": "rg-aek2aq7f4va****\n",
          "ResuorceType": "ECR",
          "RegionNo": "cn-shanghai",
          "AliUid": 0,
          "TagKey": "test",
          "TagValue": "test",
          "Scope": 0,
          "Category": 0
        }
      ],
      "Name": "test",
      "Description": "test",
      "AlibabaSideAsn": 45104
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParamFormat.%sThe param format of %s is illegal.参数格式非法
400IllegalParam.%sThe param of %s is illegal.参数非法

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

  • 本页导读 (1)
文档反馈