ListVSwitchCidrReservations - 查询交换机预留网段 - 专有网络 VPC

查询交换机预留网段。

调试

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

授权信息

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

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

操作	访问级别	资源类型	条件关键字	关联操作
vpc:ListVSwitchCidrReservations	list	VSwitchCidrReservation acs:vpc:{#regionId}:{#accountId}:vswitchcidrreservation/*	无	无

请求参数

名称	类型	必填	描述	示例值
Tags	array<object>	否	标签信息。
	object	否	标签信息。
Key	string	否	资源的标签键。最多支持输入 20 个标签键。如需传入该值，则不能输入空字符串。一个标签键最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	FinanceDept
Value	string	否	资源的标签值。最多支持输入 20 个标签值。如需传入该值，可以输入空字符串。最多支持 128 个字符，不能以 aliyun 和 acs:开头，不能包含 http://或者 https://。	FinanceJoshua
VSwitchId	string	否	要查询的交换机预留网段所属的交换机 ID。	vsw-25navfgbue4g****
VSwitchCidrReservationIds	array	否	交换机预留网段的实例 ID。最多支持输入 10 个预留网段。
	string	否	交换机预留网段的实例 ID。最多支持输入 10 个预留网段。	vcr-bp1m12saqteraw3rp****
VSwitchCidrReservationType	string	否	交换机预留网段的类型。取值：prefix，表示按段分配地址。说明用户及云服务自动为弹性网卡 ENI（Elastic Network Interface）分配网段时，必须从预留地址段分配。如果预留地址段的地址已经分配完，则系统会报错。	prefix
IpVersion	string	否	交换机预留网段的 IP 版本。取值： IPv4 （默认值）：IPv4 版本。 IPv6：IPv6 版本。	IPv4
NextToken	string	否	是否拥有下一次查询的令牌（Token）。取值：第一次查询和没有下一次查询时，均无需填写。如果有下一次查询，取值为上一次 API 调用返回的 NextToken 值。	FFmyTO70tTpLG6I3FmYAXGKPd****
MaxResults	long	否	分批次查询时每次显示的条目数。取值范围：1~100，默认值为 10。	10
RegionId	string	是	交换机所在的地域 ID。您可以通过调用 DescribeRegions 接口获取地域 ID。	cn-hangzhou

返回参数

名称	类型	描述	示例值
	object	请求 ID。
RequestId	string	请求 ID。	54B48E3D-DF70-471B-AA93-08E683A1B45
NextToken	string	是否拥有下一次查询的令牌（Token）。取值：如果 NextToken 为空表示没有下一次查询。如果 NextToken 有返回值，该取值表示下一次查询开始的令牌。	FFmyTO70tTpLG6I3FmYAXGKPd****
TotalCount	long	列表条目数。	10
MaxResults	long	分批次查询时每次显示的条目数。	10
VSwitchCidrReservations	array<object>	交换机预留网段的列表。
VSwitchCidrReservation	object	交换机预留网段的列表。
VpcId	string	交换机预留网段所属的 VPC。	vpc-bp1wdz2pdhgurz1od****
VSwitchId	string	交换机预留网段所属的交换机 ID。	vsw-25navfgbue4g****
VSwitchCidrReservationId	string	交换机预留网段的实例 ID。	vcr-bp1m12saqteraw3rp****
VSwitchCidrReservationCidr	string	交换机预留网段。	192.168.1.64/28
VSwitchCidrReservationName	string	交换机预留网段的名称。	ReservationName
VSwitchCidrReservationDescription	string	交换机预留网段的描述信息。	ReservationDescription
IpVersion	string	交换机预留网段的 IP 版本。取值： IPv4 （默认值）：IPv4 版本。 IPv6：IPv6 版本。	IPv4
CreationTime	string	预留网段的创建时间。	2023-03-14T10:02:37Z
Type	string	交换机预留网段的类型。取值： prefix（默认值），表示按段分配地址。	prefix
AvailableCidrCount	integer	交换机预留网段中可用的前缀网段（prefix）数量。	10
AssignedCidrCount	integer	交换机预留网段中已使用的前缀网段（prefix）数量。	6
Status	string	预留网段的状态。取值： Assigning：分配中。 Assigned：已分配。 Releasing：释放中。 Released：已释放。	Assigned
Tags	array<object>	标签列表。
Tag	object	标签。
Key	string	标签键。	FinanceDept
Value	string	标签值。	FinanceJoshua

示例

正常返回示例

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",
      "Tags": [
        {
          "Key": "FinanceDept",
          "Value": "FinanceJoshua"
        }
      ]
    }
  ]
}

错误码

HTTP status code	错误码	错误信息	描述
400	IllegalParam.NextToken	The specified NextToken is invalid.	参数NextToken非法.

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