公网IP

列举公网IP

功能介绍

‎列举符合条件的所有公网IP

URI

GET /v2.0/floatingips

请求消息

参数	参数类型	是否必选	Description
router_id	string	否	指定路由器的ID进行查询。
project_id	string	否	指定项目ID进行查询。
floating_network_id	string	否	公网IP地址申请自外部网络的ID。
port_id	string	否	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
status	string	否	公网IP的运行状态。
tags	string	否	公网IP的标签。

响应消息

参数	参数类型	描述
floatingips	array	公网IP列表。
id	string	公网IP的ID。
tenant_id	string	公网IP所属的用户ID。
floating_ip_address	string	公网IP的地址。
floating_network_id	string	公网IP地址申请自外部网络的ID。
router_id	string	绑定公网IP所属router的ID。
port_id	string	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
fixed_ip_address	string	绑定公网IP的port的IP地址。
status	string	公网IP的运行状态。
description	string	公网IP的描述。
qos_policy_id	string	公网IP绑定的qos策略。
port_details	string	绑定公网IP的port的相关信息，包括port的name、network_id、mac_address、admin_state_up、status、device_id、device_owner信息。
tags	array	公网IP的标签。
created_at	string	创建资源时的 UTC 日期和时间戳。
updated_at	string	最近一次更新资源时的 UTC 日期和时间戳。
revision_number	integer	公网IP的版本。
project_id	string	公网IP所属的项目ID。

请求示例

GET http://{endpoint}/v2.0/floatingips

正常响应示例

{
	"floatingips": [{
		"id": "7e1d4f82-b14e-43d3-b4ad-6d9751487293",
		"tenant_id": "bbd16f62d534430bbdffe8ca96bf02a3",
		"floating_ip_address": "172.16.10.227",
		"floating_network_id": "0d4df3da-de1e-4a5e-9606-9178efd4a42c",
		"router_id": null,
		"port_id": null,
		"fixed_ip_address": null,
		"status": "DOWN",
		"description": "",
		"qos_policy_id": null,
		"port_details": null,
		"tags": [],
		"created_at": "2022-03-30T03:42:04Z",
		"updated_at": "2022-03-30T03:42:04Z",
		"revision_number": 0,
		"project_id": "bbd16f62d534430bbdffe8ca96bf02a3"
	}]
}

正常响应代码

200

错误码

401

创建公网IP

功能介绍

‎创建一个公网IP

URI

POST /v2.0/floatingips

请求消息

参数	参数类型	是否必选	Description
floatingips	object	公网IP对象。
floating_network_id	boolean	是	公网IP地址申请自外部网络的ID。
qos_policy_id	string	否	公网IP绑定的qos策略。
description	string	否	公网IP的描述。
port_id	string	否	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
floating_ip_address	string	否	公网IP的地址。
fixed_ip_address	string	否	绑定公网IP的port的IP地址。
project_id	string	否	公网IP所属的项目ID。

响应消息

参数	参数类型	描述
floatingips	object	公网IP对象。
id	string	公网IP的ID。
tenant_id	string	公网IP所属的用户ID。
floating_ip_address	string	公网IP的地址。
floating_network_id	string	公网IP地址申请自外部网络的ID。
router_id	string	绑定公网IP所属router的ID。
port_id	string	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
fixed_ip_address	string	绑定公网IP的port的IP地址。
status	string	公网IP的运行状态。
description	string	公网IP的描述。
qos_policy_id	string	公网IP绑定的qos策略。
port_details	string	绑定公网IP的port的相关信息，包括port的name、network_id、mac_address、admin_state_up、status、device_id、device_owner信息。
tags	array	公网IP的标签。
created_at	string	创建资源时的 UTC 日期和时间戳。
updated_at	string	最近一次更新资源时的 UTC 日期和时间戳。
revision_number	integer	公网IP的版本。
project_id	string	公网IP所属的项目ID。

请求示例

POST http://{endpoint}/v2.0/floatingips

{
	"floatingip": {
		"floating_network_id": "0d4df3da-de1e-4a5e-9606-9178efd4a42c"
	}
}

正常响应示例

{
	"floatingip": {
		"id": "7e1d4f82-b14e-43d3-b4ad-6d9751487293",
		"tenant_id": "bbd16f62d534430bbdffe8ca96bf02a3",
		"floating_ip_address": "172.16.10.227",
		"floating_network_id": "0d4df3da-de1e-4a5e-9606-9178efd4a42c",
		"router_id": null,
		"port_id": null,
		"fixed_ip_address": null,
		"status": "DOWN",
		"project_id": "bbd16f62d534430bbdffe8ca96bf02a3",
		"description": "",
		"qos_policy_id": null,
		"port_details": null,
		"tags": [],
		"created_at": "2022-03-30T03:42:04Z",
		"updated_at": "2022-03-30T03:42:04Z",
		"revision_number": 0
	}
}

正常响应代码

201

错误码

400，401，404，409

获取公网IP

功能介绍

‎获取一个公网IP的详情

URI

GET /v2.0/floatingips/{floatingip_id}

参数	是否必选	描述
floatingip_id	是	待查询的公网IP的ID。

请求消息

响应消息

参数	参数类型	描述
floatingips	object	公网IP对象。
id	string	公网IP的ID。
tenant_id	string	公网IP所属的用户ID。
floating_ip_address	string	公网IP的地址。
floating_network_id	string	公网IP地址申请自外部网络的ID。
router_id	string	绑定公网IP所属router的ID。
port_id	string	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
fixed_ip_address	string	绑定公网IP的port的IP地址。
status	string	公网IP的运行状态。
description	string	公网IP的描述。
qos_policy_id	string	公网IP绑定的qos策略。
port_details	string	绑定公网IP的port的相关信息，包括port的name、network_id、mac_address、admin_state_up、status、device_id、device_owner信息。
tags	array	公网IP的标签。
created_at	string	创建资源时的 UTC 日期和时间戳。
updated_at	string	最近一次更新资源时的 UTC 日期和时间戳。
revision_number	integer	公网IP的版本。
project_id	string	公网IP所属的项目ID。

请求示例

GET http://{endpoint}/v2.0/floatingips/145c964a-1951-4a34-b62f-441e0d3e2675

正常响应示例

{
	"floatingip": {
		"id": "7e1d4f82-b14e-43d3-b4ad-6d9751487293",
		"tenant_id": "bbd16f62d534430bbdffe8ca96bf02a3",
		"floating_ip_address": "172.16.10.227",
		"floating_network_id": "0d4df3da-de1e-4a5e-9606-9178efd4a42c",
		"router_id": null,
		"port_id": null,
		"fixed_ip_address": null,
		"status": "DOWN",
		"description": "",
		"qos_policy_id": null,
		"port_details": null,
		"tags": [],
		"created_at": "2022-03-30T03:42:04Z",
		"updated_at": "2022-03-30T03:42:04Z",
		"revision_number": 0,
		"project_id": "bbd16f62d534430bbdffe8ca96bf02a3"
	}
}

正常响应代码

200

错误码

401，403，404

更新公网IP

功能介绍

‎更新一个公网IP

URI

PUT /v2.0/floatingips/{floatingip_id}

参数	是否必选	描述
floatingip_id	是	待查询的公网IP的ID

请求消息

参数	参数类型	是否必选	Description
floatingips	object	公网IP对象。
port_id	string	否	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
fixed_ip_address	string	否	绑定公网IP的port的IP地址。
qos_policy_id	string	否	公网IP绑定的qos策略。
description	string	否	公网IP的描述。

响应消息

参数	参数类型	描述
floatingips	object	公网IP对象。
id	string	公网IP的ID。
tenant_id	string	公网IP所属的用户ID。
floating_ip_address	string	公网IP的地址。
floating_network_id	string	公网IP地址申请自外部网络的ID。
router_id	string	绑定公网IP所属router的ID。
port_id	string	绑定公网IP的port的ID。注意：如果公网IP被NAT网关使用，port_id会被默认置为NAT网关关联的路由器网关的port的ID。
fixed_ip_address	string	绑定公网IP的port的IP地址。
status	string	公网IP的运行状态。
description	string	公网IP的描述。
qos_policy_id	string	公网IP绑定的qos策略。
port_details	string	绑定公网IP的port的相关信息，包括port的name、network_id、mac_address、admin_state_up、status、device_id、device_owner信息。
tags	array	公网IP的标签。
created_at	string	创建资源时的 UTC 日期和时间戳。
updated_at	string	最近一次更新资源时的 UTC 日期和时间戳。
revision_number	integer	公网IP的版本。
project_id	string	公网IP所属的项目ID。

请求示例

PUT http://{endpoint}/v2.0/floatingips/145c964a-1951-4a34-b62f-441e0d3e2675

{
	"floatingip": {
		"port_id": null
	}
}

正常响应示例

{
	"floatingip": {
		"id": "a3fdad57-8f24-41d3-95cf-1f94c7bc04b1",
		"tenant_id": "45d6353dc853402a8b8987feaccb7429",
		"floating_ip_address": "172.16.10.130",
		"floating_network_id": "0d4df3da-de1e-4a5e-9606-9178efd4a42c",
		"router_id": null,
		"port_id": null,
		"fixed_ip_address": null,
		"status": "ACTIVE",
		"description": "",
		"qos_policy_id": "87d450e9-72b9-4711-ac8f-6b0a111e2223",
		"port_details": null,
		"tags": [],
		"created_at": "2022-03-30T06:14:42Z",
		"updated_at": "2022-03-30T06:18:17Z",
		"revision_number": 4,
		"project_id": "45d6353dc853402a8b8987feaccb7429"
	}
}

正常响应代码

200

错误码

400, 401, 404, 409, 412

删除公网IP

功能介绍

‎删除一个公网IP

URI

DELETE /v2.0/floatingips/{floatingip_id}

参数	是否必选	描述
floatingip_id	是	待查询的公网IP的ID。

请求消息

请求示例

DELETE http://{endpoint}/v2.0/floatingips/145c964a-1951-4a34-b62f-441e0d3e2675

正常响应代码

204

错误码

401，404，412

获取公网IP池列表

功能介绍

‎获取公网IP池列表

URI

GET /v2.0/floatingip_pools

响应消息

参数	参数类型	描述
floatingip_pools	array	公网IP池列表。
subnet_id	string	子网的ID。
tenant_id	string	公网IP池所属的项目ID。
network_id	string	网络名称。
subnet_name	string	子网名称。
cidr	string	子网的CIDR。
project_id	string	公网IP池所属的项目ID。

请求示例

GET http://{endpoint}/v2.0/floatingip_pools

正常响应示例

{
    "floatingip_pools": [
        {
            "subnet_id": "cdec285c-b157-48aa-900c-e77f6bd958e5",
            "tenant_id": "26a7980765d0414dbc1fc1f88cdb7e6e",
            "network_id": "db193ab3-96e3-4cb3-8fc5-05f4296d0324",
            "subnet_name": "public-subnet",
            "cidr": "192.16.10.0/24",
            "project_id": "26a7980765d0414dbc1fc1f88cdb7e6e"
        }
    ]
}

正常响应代码

200

错误码

401