文档

DescribeExpressConnectRouterChildInstance - 查询专线网关(ECR)绑定的子实例信息

更新时间:

查询专线网关ECR(Express Connect Router)加载的边界路由器(VBR)。

调试

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

授权信息

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

请求参数

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

专线网关实例 ID。

ecr-mezk2idmsd0vx2****
AssociationIdstring

专线网关与 VPC 或 TR 的关联 ID。

ecr-assoc-9p2qxx5phpca2m****
ChildInstanceIdstring

待卸载的网络实例 ID。

vbr-j6cwxhgg0s5nuephp****
ChildInstanceTypestring

网络实例的类型。取值:VBR:边界路由器实例。

VBR
ChildInstanceRegionIdstring

网络实例所在的地域。

cn-hangzhou
NextTokenstring

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

  • 第一次查询和没有下一次查询时,均无需填写。
  • 如果有下一次查询,取值为上一次 API 调用返回的 NextToken 值。
AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
MaxResultsinteger

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

20
DryRunboolean

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

  • true:发送检查请求,不会修改服务资源。
  • false(默认值):发送正常请求。
false
ClientTokenstring

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

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

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

返回参数

名称类型描述示例值
object

RpcResponse

RequestIdstring

请求 ID。

05130E79-588D-5C40-A718-C4863A59****
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

关联的资源总数。

1
MaxResultsinteger

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

20
NextTokenstring

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

  • 如果 NextToken 为空表示没有下一次查询。
  • 如果 NextToken 有返回值,该取值表示下一次查询开始的令牌。
AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****
ChildInstanceListobject []

子实例列表。

EcrIdstring

专线网关实例 ID。

ecr-mezk2idmsd0vx2****
AssociationIdstring

专线网关与 VPC 或 TR 的关联 ID。

ecr-assoc-9p2qxx5phpca2m****
RegionIdstring

边界路由器所属地域。

cn-hangzhou
OwnerIdlong

边界路由器所属的阿里云账号 ID。

167509154715****
GmtCreatestring

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

2024-01-09T12:18:23Z
GmtModifiedstring

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

2024-01-09T12:18:23Z
Statusstring

关联资源的部署状态。可能值:

  • CREATING:创建中。

  • ACTIVE:已创建。

  • ASSOCIATING:资源绑定中。

  • DISSOCIATING:资源解绑中。

  • UPDATING:修改中。

  • DELETING:删除中。

ACTIVE
ChildInstanceIdstring

边界路由器实例 ID。

vbr-gw8vjq2zjux3ifsc9****
ChildInstanceTypestring

子实例类型。取值:VBR 边界路由器。

VBR
ChildInstanceRegionIdstring

子实例所属地域。

cn-hangzhou
ChildInstanceOwnerIdlong

子实例所属的阿里云账号 ID。

112101171212****

示例

正常返回示例

JSON格式

{
  "RequestId": "05130E79-588D-5C40-A718-C4863A59****",
  "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": 1,
  "MaxResults": 20,
  "NextToken": "AAAAAYws9fJ0Ur4MGm/5OkDoW/Zn0J0/sCjivzwX9oBcwFnWaaas/kSG+J/WzLOxJHS4****",
  "ChildInstanceList": [
    {
      "EcrId": "ecr-mezk2idmsd0vx2****",
      "AssociationId": "ecr-assoc-9p2qxx5phpca2m****",
      "RegionId": "cn-hangzhou",
      "OwnerId": 0,
      "GmtCreate": "2024-01-09T12:18:23Z",
      "GmtModified": "2024-01-09T12:18:23Z",
      "Status": "ACTIVE",
      "ChildInstanceId": "vbr-gw8vjq2zjux3ifsc9****",
      "ChildInstanceType": "VBR",
      "ChildInstanceRegionId": "cn-hangzhou",
      "ChildInstanceOwnerId": 0
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
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-03-26OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:404
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈