DescribeExpressConnectRouterRouteEntries - 查询专线网关(ECR)的路由条目

查询专线网关ECR(Express Connect Router)路由条目。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
expressconnectrouter:DescribeExpressConnectRouterRouteEntrieslist
  • ExpressConnectRouter
    acs:expressconnectrouter::{#accountId}:expressconnectrouter/{#EcrId}

请求参数

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

专线网关实例 ID。

ecr-mezk2idmsd0vx2****
QueryRegionIdstring

专线网关实例所属地域。

cn-hangzhou
DestinationCidrBlockstring

要查询的路由条目的目标网段。

172.20.47.**/**
NexthopInstanceIdstring

下一跳实例 ID

vbr-hp3u4u5f03tfuljis****
AsPathstring

路由条目经过的 AS 路径。

[64993,64512]
Communitystring

BGP 路由条目携带的 Community 值。

9001:9263
NextTokenstring

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

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

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

10
DryRunboolean

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

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

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

true
ClientTokenstring

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

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

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

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

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

是否调用成功。取值:

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

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

200
Messagestring

实例操作返回信息。

OK
HttpStatusCodeinteger

HTTP 状态码。

200
DynamicCodestring

动态错误码。

IllegalParamFormat.EcrId
DynamicMessagestring

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

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

访问被拒绝详细信息。

Authentication is failed for ****
TotalCountinteger

列表总条目数。

2
MaxResultsinteger

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

10
NextTokenstring

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
gAAAAABkWwFTUMNCdWC0VMYOIylA56Hx6JUfCZlk5hQ5g_fnKmetN6303tqq5UJ2ouJzyT2fDOdzb-NqyEB5jcY8Z2euX7qHDA==
RouteEntriesListarray<object>

路由条目列表。

RouteEntriesListobject
DestinationCidrBlockstring

路由条目的目标网段。

192.168.0.**/**
Statusstring

专线网关实例的状态

ACTIVE
NexthopInstanceIdstring

下一跳实例 ID。

vbr-hp3u4u5f03tfuljis****
NexthopInstanceRegionIdstring

下一跳实例所属的地域。

cn-hangzhou
AsPathstring

路由条目经过的 AS 路径。

[64993,64512]
Communitystring

BGP 路由条目携带的 Community 值。

9001:9263

示例

正常返回示例

JSON格式

{
  "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.\n",
  "AccessDeniedDetail": "Authentication is failed for ****\n",
  "TotalCount": 2,
  "MaxResults": 10,
  "NextToken": "gAAAAABkWwFTUMNCdWC0VMYOIylA56Hx6JUfCZlk5hQ5g_fnKmetN6303tqq5UJ2ouJzyT2fDOdzb-NqyEB5jcY8Z2euX7qHDA==",
  "RouteEntriesList": [
    {
      "DestinationCidrBlock": "192.168.0.**/**",
      "Status": "ACTIVE",
      "NexthopInstanceId": "vbr-hp3u4u5f03tfuljis****",
      "NexthopInstanceRegionId": "cn-hangzhou",
      "AsPath": "[64993,64512]",
      "Community": "9001:9263",
      "Med": 0
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParamFormat.DestinationCidrBlockThe format of the specified destination Cidr route parameter is incorrect.您当前指定的目的Cidr路由参数格式错误,请核对后重新输入。
400MissingParam.%sThe param of %s is missing.请求参数未填写,请核对对应的参数后重试。
400IllegalParamFormat.%sThe param format of %s is illegal.参数格式非法
400IllegalParam.%sThe param of %s is illegal.参数非法
404ResourceNotFound.EcrIdEcrId not found.ECR实例不存在

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

变更历史

变更时间变更内容概要操作
2024-06-28OpenAPI 描述信息更新、OpenAPI 错误码发生变更查看变更详情