全部产品
Search
文档中心

云企业网:ListTransitRouterCidrAllocation - 查询CIDR地址段的分配信息

更新时间:Oct 22, 2024

调用ListTransitRouterCidrAllocation接口查询CIDR地址段的分配信息。

调试

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

授权信息

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

请求参数

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

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

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

说明 若您未指定,则系统自动使用 API 请求的 RequestId 作为 ClientToken 标识。每次 API 请求的 RequestId 不一样。
123e4567-e89b-12d3-a456-426****
TransitRouterIdstring

转发路由器实例 ID。

tr-p0w3x8c9em72a40nw****
RegionIdstring

转发路由器实例所属的地域 ID。

您可以通过调用 DescribeChildInstanceRegions 接口获取地域 ID。

cn-hangzhou
TransitRouterCidrIdstring

转发路由器地址段 ID。

您可以通过调用 ListTransitRouterCidr 接口查询转发路由器地址段 ID。

cidr-0zv0q9crqpntzz****
CidrBlockstring

转发路由器地址段下已分配地址的网段。

192.168.10.0/28
Cidrstring

转发路由器地址段。

192.168.10.0/24
DedicatedOwnerIdstring

专用网段。

仅取值:VPN,表示您要查询系统保留的用于系统后台创建 VPN 连接的网段。

VPN
AttachmentIdstring

网络实例连接 ID。

tr-attach-2nalp6yksc805w****
AttachmentNamestring

网络实例连接的名称。

nametest
DryRunboolean

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

  • true:发送检查请求,不会开始查询转发路由器地址段分配详情。检查项包括是否填写了必需参数、请求格式、业务限制等。如果检查不通过,则返回对应错误。如果检查通过,则返回错误码DryRunOperation
  • false(默认值):发送正常请求,通过检查后直接查询转发路由器地址段分配详情。
false
MaxResultsinteger

分批次查询时每次显示的条目数。

  • 如果您不指定 MaxResults 参数的值,则表示您不需要分批次查询。调用该接口后返回参数 MaxResults 的值表示列表条目总数。

  • 如果您指定 MaxResults 参数的值,则表示您需要分批次查询。取值范围:1~100。建议指定 MaxResults 参数的值为 20

    调用该接口后返回参数 MaxResults 的值表示当前查询批次下列表条目的数量。

20
NextTokenstring

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

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

返回参数

名称类型描述示例值
object

返回结果。

NextTokenstring

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

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

请求 ID。

0876E54E-3E36-5C31-89F0-9EE8A9266F9A
TotalCountinteger

列表条目数。

1
MaxResultsinteger

分批次查询时每次显示的条目数。

  • 如果您未指定请求参数 MaxResults 的值,则表示您不需要分批次查询。返回参数 MaxResults 的值表示列表条目总数。
  • 如果您指定了请求参数 MaxResults 的值,则表示您需要分批次查询。返回参数 MaxResults 的值表示当前查询批次下列表条目的数量。
1
TransitRouterCidrAllocationsarray<object>

转发路由器地址段分配详情。

TransitRouterCidrAllocationobject

转发路由器地址段分配详情。

TransitRouterCidrIdstring

转发路由器地址段 ID。

cidr-0zv0q9crqpntzz****
AllocatedCidrBlockstring

转发路由器地址段下已分配地址的网段。

192.168.10.0/28
AttachmentIdstring

网络实例连接 ID。

tr-attach-2nalp6yksc805w****
Cidrstring

转发路由器地址段。

192.168.10.0/24
AttachmentNamestring

网络实例连接的名称。

nametest

示例

正常返回示例

JSON格式

{
  "NextToken": "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "RequestId": "0876E54E-3E36-5C31-89F0-9EE8A9266F9A",
  "TotalCount": 1,
  "MaxResults": 1,
  "TransitRouterCidrAllocations": [
    {
      "TransitRouterCidrId": "cidr-0zv0q9crqpntzz****",
      "AllocatedCidrBlock": "192.168.10.0/28",
      "AttachmentId": "tr-attach-2nalp6yksc805w****",
      "Cidr": "192.168.10.0/24",
      "AttachmentName": "nametest"
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400IllegalParam.NextTokenThe parameter NextToken is invalid.指定的NextToken无效。请检查参数约束,并在修改后重试。
400IllegalParam.TransitRouterIdThe parameter TransitRouterId or RegionId is invalid.参数TransitRouterId或RegionId无效。
400InvalidParameterInvalid parameter.参数不合法。
400UnauthorizedThe AccessKeyId is unauthorized.账号无权限操作。

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

变更历史

变更时间变更内容概要操作
2023-08-04OpenAPI 错误码发生变更查看变更详情