检查私有网络IP是否可用
最近更新时间: 2024-10-18 10:38:29
1. 接口描述
接口请求域名： dcdb.api3.fincloud.tencent.cn。
本接口(CheckIpStatus)用于查询指定的私有网络中的虚拟IP是否可用。
默认接口请求频率限制：20次/秒。
接口更新时间：2020-07-01 14:06:13。
接口只验签名不鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CheckIpStatus |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-04-11 |
| Region | 是 | 否 | String | 公共参数，详见产品支持的地域列表(TODO) |
| InstanceId | 是 | 否 | String | 实例Id，形如：dcdbt-ow728lmc |
| VpcId | 是 | 否 | String | 目标私有网络ID |
| SubnetId | 是 | 否 | String | 目标子网ID |
| Vip | 是 | 否 | String | 目标虚拟IP |
| Ipv6Flag | 否 | 否 | Int64 | 此参数对外不可见。 是否IPv6，默认0 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Vip | String | 透传入参 |
| Status | Int64 | Vip可用状态：0 - 可用，300 - 此ip已被子网内其他用户占用， 301 - 此ip不在子网内， 302 - ip格式错误， 303 - 该IP为实例当前IP。 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError.DbOperationFailed | |
| InternalError.GetSubnetFailed | |
| InvalidParameter.InstanceNotFound | |
| UnauthorizedOperation.PermissionDenied |