调用CheckCanAllocateVpcPrivateIpAddress接口查询交换机下的私网IP地址是否可用。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：
- 操作：是指具体的权限点。
- 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
- 资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用
全部资源表示。
- 条件关键字：是指云产品自身定义的条件关键字。
- 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| vpc:CheckCanAllocateVpcPrivateIpAddress | none | *VSwitch acs:vpc:{#regionId}:{#accountId}:vswitch/{#VSwitchId} |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| RegionId | string | 是 | 要查询的私网 IP 地址所属交换机的地域 ID。 您可以通过调用 DescribeRegions 接口获取地域 ID。 | cn-qingdao |
| VSwitchId | string | 是 | 要查询的私网 IP 地址所属的交换机 ID。 | vsw-m5ew3t46z2drmifnt**** |
| PrivateIpAddress | string | 是 | 要查询是否可用的私网 IP 地址，该私网 IP 地址必须属于 VSwitchId 参数中输入的交换机。 | 10.0.0.7 |
| IpVersion | string | 否 | 要查询的私网 IP 地址的类型。取值：
| ipv4 |
返回参数
示例
正常返回示例
JSON格式
{
"CanAllocate": true,
"RequestId": "93360B0-2969-40BF-8542-EBB34FD358AB"
}错误码
| HTTP status code | 错误码 | 错误信息 | 描述 |
|---|---|---|---|
| 400 | PARAMETER_ILLEGAL | Parameter illegal.Parameter is ipVersion | - |
| 400 | ResourceNotFound.VSwitchId | The specified resource vswitch is not found. | - |
| 400 | Mismatch.VSwitchAndPrivateIpAddress | The vswitch and privateIpAddress are mismatched. | 当前指定的私网IP和交换机不匹配。 |
| 400 | IllegalParam.PrivateIpAddress | The specified PrivateIpAddress is illegal. | 指定的PrivateIpAddress无效。请检查参数约束，并在修改后重试。 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2024-12-16 | OpenAPI 错误码发生变更 | 查看变更详情 |