CheckCanAllocateVpcPrivateIpAddress - 查询交换机下的私网IP可用性

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

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
vpc:CheckCanAllocateVpcPrivateIpAddressnone
  • VSwitch
    acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId}

请求参数

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

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

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

cn-qingdao
VSwitchIdstring

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

vsw-m5ew3t46z2drmifnt****
PrivateIpAddressstring

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

10.0.0.7
IpVersionstring

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

  • ipv4:IPv4 类型。当查询的私网 IP 地址为 IPv4 类型时,该参数为选填。
  • ipv6:IPv6 类型。当查询的私网 IP 地址为 IPv6 类型时,该参数为必填。
ipv4

返回参数

名称类型描述示例值
object

Schema object

CanAllocateboolean

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

  • true:指定交换机下,该私网 IP 地址没有被占用,可以使用。
  • false:指定交换机下,该私网 IP 地址已被占用,无法使用。
true
RequestIdstring

请求 ID。

93360B0-2969-40BF-8542-EBB34FD358AB

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400PARAMETER_ILLEGALParameter illegal.Parameter is ipVersion-
400ResourceNotFound.VSwitchIdThe specified resource vswitch is not found.-
400Mismatch.VSwitchAndPrivateIpAddressThe vswitch and privateIpAddress are mismatched.当前指定的私网IP和交换机不匹配。

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

变更历史

变更时间变更内容概要操作
暂无变更历史