调用CheckCanAllocateVpcPrivateIpAddress接口查询交换机下的私网IP地址是否可用。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
RegionId String 是 cn-qingdao

要查询的私网IP地址所属交换机的地域ID。

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

VSwitchId String 是 vsw-m5ew3t46z2drmifnt****

要查询的私网IP地址所属的交换机ID。
PrivateIpAddress String 是 10.0.0.7

要查询是否可用的私网IP地址，该私网IP地址必须属于VSwitchId参数中输入的交换机。

IpVersion String 否 ipv4

要查询的私网IP地址的类型。取值：

  • ipv4：IPv4类型。当查询的私网IP地址为IPv4类型时，该参数为选填。
  • ipv6：IPv6类型。当查询的私网IP地址为IPv6类型时，该参数为必填。
Action String 是 CheckCanAllocateVpcPrivateIpAddress

系统规定参数。取值：CheckCanAllocateVpcPrivateIpAddress。

返回数据

名称 类型 示例值 描述
CanAllocate Boolean true

查询的私网IP地址是否可用。取值：

  • true：指定交换机下，该私网IP地址没有被占用，可以使用。
  • false：指定交换机下，该私网IP地址已被占用，无法使用。
RequestId String 93360B0-2969-40BF-8542-EBB34FD358AB

请求ID。

示例

请求示例

http(s)://[Endpoint]/?RegionId=cn-qingdao
&VSwitchId=vsw-m5ew3t46z2drmifnt****
&PrivateIpAddress=10.0.0.7
&IpVersion=ipv4
&Action=CheckCanAllocateVpcPrivateIpAddress
&公共请求参数

正常返回示例

XML格式 

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

<CheckCanAllocateVpcPrivateIpAddressResponse>
    <CanAllocate>true</CanAllocate>
    <RequestId>93360B0-2969-40BF-8542-EBB34FD358AB</RequestId>
</CheckCanAllocateVpcPrivateIpAddressResponse>

JSON格式 

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

{
  "CanAllocate" : true,
  "RequestId" : "93360B0-2969-40BF-8542-EBB34FD358AB"
}

错误码

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