调用ListVSwitchCidrReservations接口查询交换机的预留网段。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String 是 ListVSwitchCidrReservations

系统规定参数。取值：ListVSwitchCidrReservations。
VSwitchId String 是 vsw-25navfgbue4g****

要查询的交换机预留网段所属的交换机ID。
VSwitchCidrReservationIds.N String 否 vcr-bp1m12saqteraw3rp****

交换机预留网段的实例ID。最多支持输入10个预留网段。
VSwitchCidrReservationType String 否 prefix

交换机预留网段的类型。取值：prefix，表示按段分配地址。

说明 用户及云服务自动为弹性网卡ENI（Elastic Network Interface）分配网段时，必须从预留地址段分配。如果预留地址段的地址已经分配完，则系统会报错。
IpVersion String 否 IPv4

交换机预留网段的IP版本。取值：

  • IPv4 （默认值）：IPv4版本。
  • IPv6：IPv6版本。
NextToken String 否 FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 第一次查询和没有下一次查询时，均无需填写。
  • 如果有下一次查询，取值为上一次API调用返回的NextToken值。
MaxResults Long 否 10

分批次查询时每次显示的条目数。取值范围：1~100，默认值为10。
RegionId String 是 cn-hangzhou

交换机所在的地域ID。

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

返回数据

名称 类型 示例值 描述
RequestId String 54B48E3D-DF70-471B-AA93-08E683A1B45

请求ID。
NextToken String FFmyTO70tTpLG6I3FmYAXGKPd****

是否拥有下一次查询的令牌（Token）。取值：

  • 如果NextToken为空表示没有下一次查询。
  • 如果NextToken有返回值，该取值表示下一次查询开始的令牌。
TotalCount Long 10

列表条目数。
MaxResults Long 10

分批次查询时每次显示的条目数。
VSwitchCidrReservations Array of VSwitchCidrReservation

交换机预留网段的列表。
VpcId String vpc-bp1wdz2pdhgurz1od****

交换机预留网段所属的VPC。
VSwitchId String vsw-25navfgbue4g****

交换机预留网段所属的交换机ID。
VSwitchCidrReservationId String vcr-bp1m12saqteraw3rp****

交换机预留网段的实例ID。
VSwitchCidrReservationCidr String 192.168.1.64/28

交换机预留网段。
VSwitchCidrReservationName String ReservationName

交换机预留网段的名称。
VSwitchCidrReservationDescription String ReservationDescription

交换机预留网段的描述信息。
IpVersion String IPv4

交换机预留网段的IP版本。取值：

  • IPv4 （默认值）：IPv4版本。
  • IPv6：IPv6版本。
CreationTime String 2023-03-14T10:02:37Z

预留网段的创建时间。
Type String prefix

交换机预留网段的类型。取值： prefix（默认值），表示按段分配地址。
AvailableCidrCount Integer 10

交换机预留网段中可用的前缀网段（prefix）数量。
AssignedCidrCount Integer 6

交换机预留网段中已使用的前缀网段（prefix）数量。
Status String Assigned

预留网段的状态。取值：

  • Assigning：分配中。
  • Assigned：已分配。
  • Releasing：释放中。
  • Released：已释放。

示例

请求示例

http(s)://[Endpoint]/?Action=ListVSwitchCidrReservations
&VSwitchId=vsw-25navfgbue4g****
&VSwitchCidrReservationIds=["vcr-bp1m12saqteraw3rp****"]
&VSwitchCidrReservationType=prefix
&IpVersion=IPv4
&NextToken=FFmyTO70tTpLG6I3FmYAXGKPd****
&MaxResults=10
&RegionId=cn-hangzhou
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<ListVSwitchCidrReservationsResponse>
    <RequestId>54B48E3D-DF70-471B-AA93-08E683A1B45</RequestId>
    <NextToken>FFmyTO70tTpLG6I3FmYAXGKPd****</NextToken>
    <TotalCount>10</TotalCount>
    <MaxResults>10</MaxResults>
    <VSwitchCidrReservations>
        <VpcId>vpc-bp1wdz2pdhgurz1od****</VpcId>
        <VSwitchId>vsw-25navfgbue4g****</VSwitchId>
        <VSwitchCidrReservationId>vcr-bp1m12saqteraw3rp****</VSwitchCidrReservationId>
        <VSwitchCidrReservationCidr>192.168.1.64/28</VSwitchCidrReservationCidr>
        <VSwitchCidrReservationName>ReservationName</VSwitchCidrReservationName>
        <VSwitchCidrReservationDescription>ReservationDescription</VSwitchCidrReservationDescription>
        <IpVersion>IPv4</IpVersion>
        <CreationTime>2023-03-14T10:02:37Z</CreationTime>
        <Type>prefix</Type>
        <AvailableCidrCount>10</AvailableCidrCount>
        <AssignedCidrCount>6</AssignedCidrCount>
        <Status>Assigned</Status>
    </VSwitchCidrReservations>
</ListVSwitchCidrReservationsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "54B48E3D-DF70-471B-AA93-08E683A1B45",
  "NextToken" : "FFmyTO70tTpLG6I3FmYAXGKPd****",
  "TotalCount" : 10,
  "MaxResults" : 10,
  "VSwitchCidrReservations" : [ {
    "VpcId" : "vpc-bp1wdz2pdhgurz1od****",
    "VSwitchId" : "vsw-25navfgbue4g****",
    "VSwitchCidrReservationId" : "vcr-bp1m12saqteraw3rp****",
    "VSwitchCidrReservationCidr" : "192.168.1.64/28",
    "VSwitchCidrReservationName" : "ReservationName",
    "VSwitchCidrReservationDescription" : "ReservationDescription",
    "IpVersion" : "IPv4",
    "CreationTime" : "2023-03-14T10:02:37Z",
    "Type" : "prefix",
    "AvailableCidrCount" : 10,
    "AssignedCidrCount" : 6,
    "Status" : "Assigned"
  } ]
}

错误码

HttpCode 错误码 错误信息 描述
400 IllegalParam.NextToken The specified NextToken is invalid. 指定的NextToken参数不合法，请检查该参数是否正确。

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