查询网络可用的IP - ShowNetworkAvailableIp
功能介绍
查询网络可用的IP接口用于查找指定网络中未被占用的IP地址。该接口适用于以下场景：在网络规划、资源分配或故障排查时，用户需要快速获取可用的IP地址信息。使用该接口的前提条件是用户具有访问目标网络的权限，并且需要提供有效的网络范围（如子网掩码或IP段）。查询完成后，接口将返回指定网络中未被占用的IP地址列表，用户可以根据结果进行IP地址的分配或进一步操作。若网络不可达、权限不足或网络范围有误，接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
GET /v1/{project_id}/networks/{network_name}/network-ip-availabilities?network_id={network_id}
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释：用户项目ID。获取方法请参见获取项目ID和名称。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
| network_name | 是 | String | 参数解释：网络ID。取值自网络详情的metadata.name字段。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
| network_id | 是 | String | 参数解释：子网ID。取值自网络详情status.subnets字段中的networkId字段。 约束限制：1 - 64字符，字母、数字和中划线。 取值范围：不涉及。 默认取值：不涉及。 |
请求参数
无
响应参数
状态码：200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| name | String | 参数解释：子网的名称。 取值范围：不涉及。 |
| networkId | String | 参数解释：子网的ID。 取值范围：不涉及。 |
| subnetIpAvailability | Array of SubnetIpAvailability objects | 参数解释：子网可用的网络IP数量。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| cidr | String | 参数解释：子网的cidr。 取值范围：不涉及。 |
| ipVersion | Integer | 参数解释：网络版本。 取值范围：可选值如下： |
| usedIps | Integer | 参数解释：已使用的IP数量。 取值范围：不涉及。 |
| totalIps | Integer | 参数解释：子网中总的IP数量。 取值范围：不涉及。 |
状态码：404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释：ModelArts错误码。 取值范围：不涉及。 |
| error_msg | String | 参数解释：具体错误信息。 取值范围：不涉及。 |
请求示例
查询网络可用IP数量。
GET https://{endpoint}/v1/{project_id}/networks/{network_name}/network-ip-availabilities?network_id={network_id} 响应示例
状态码：200
OK。
{
"name" : "default-subnet",
"networkId" : "2526defb-8b30-4fa9-82ab-e7dde66ef16a",
"subnetIpAvailability" : [ {
"cidr" : "172.18.0.0/16",
"ipVersion" : 4,
"usedIps" : 13,
"totalIps" : 65531
} ]
} 状态码：404
Not Found。
{
"error_code" : "ModelArts.50025001",
"error_msg" : "Network not exist."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 404 | Not Found。 |
错误码
请参见错误码。
