华为云用户手册

响应参数 表2 响应参数 参数名称 类型 说明 tags Array of tag objects tag对象列表，请参见表3。 表3 tag字段数据结构说明 名称 参数类型 说明 key String 键。 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成。 values Array of strings 值列表。 长度不超过43个字符。 由英文字母、数字、下划线、点、中划线、中文字符组成。

示例 举例描述创建网络ACL资源的过程，理解三者之间的关系。 创建网络ACL规则 POST /v2.0/fwaas/firewall_rules 请求体 { "firewall_rule": { "name": "fw-rule-ingress-1", "description": "create a ingress firewall rule ", "protocol": "TCP", "action": "ALLOW", "ip_version": 4, "destination_ip_address": "192.168.22.0/24", "source_ip_address": "0.0.0.0/0", "enabled": true }} 响应体，获取到firewall_rule_id：84d10f4a-9f8b-41b8-bdfa-5a0f18736f12 { "firewall_rule": { "protocol": "tcp", "description": "create a ingress firewall rule ", "source_ip_address": "0.0.0.0/0", "destination_ip_address": "192.168.22.0/24", "source_port": null, "destination_port": null, "id": "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12", "name": "fw-rule-ingress-1", "tenant_id": "5f6387106c2048b589b369d96c2f23a2", "project_id": "5f6387106c2048b589b369d96c2f23a2", "enabled": true, "action": "allow", "ip_version": 4, "public": false }} 创建网络ACL策略 POST /v2.0/fwaas/firewall_policies 请求体，绑定网络ACL规则 { "firewall_policy": { "description": "create a ingress firewall policy", "firewall_rules": [ "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12" ], "name": "fw-policy-ingress" }} 响应体，获取到firewall_policy_id：da037721-b895-4e07-bbcc-f5f6ac2759fb { "firewall_policy": { "id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", "name": "fw-policy-ingress", "project_id": "5f6387106c2048b589b369d96c2f23a2", "tenant_id": "5f6387106c2048b589b369d96c2f23a2", "description": "create a ingress firewall policy", "firewall_rules": [ "84d10f4a-9f8b-41b8-bdfa-5a0f18736f12" ], "audited": false, "public": false }} 创建网络ACL组 POST /v2.0/fwaas/firewall_groups 请求体，绑定入方向网络ACL策略 { "firewall_group": { "name": "fw-group-example", "description": "create a firewall group", "ingress_firewall_policy_id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", "admin_state_up": true }} 响应体，获取到firewall_group_id：102493e8-fc6d-4f0d-b57f-55c5be86f5c0 { "firewall_group": { "id": "102493e8-fc6d-4f0d-b57f-55c5be86f5c0", "name": "fw-group-example", "project_id": "5f6387106c2048b589b369d96c2f23a2", "tenant_id": "5f6387106c2048b589b369d96c2f23a2", "admin_state_up": true, "egress_firewall_policy_id": null, "ingress_firewall_policy_id": "da037721-b895-4e07-bbcc-f5f6ac2759fb", "description": "create a firewall group", "created_at": "2023-03-09T08:54:40", "updated_at": "2023-03-09T08:54:40", "status": "INACTIVE", "ports": [], "public": false }} 登录网络控制台，可以查看到创建的网络ACL资源。

操作步骤 通过子网ID或IP地址过滤查询端口。 发送“GET https://VPC的Endpoint/v1/{project_id}/ports?fixed_ips=ip_address={ip_address}&fixed_ips=subnet_id={subnet_id}”， project_id为项目ID，ip_address为端口资源的IP地址，subnet_id为端口资源所在子网的ID（IPV4/IPV6子网ID，不是网络ID）。 过滤信息格式举例 fixed_ips=ip_address=192.168.27.75，fixed_ips=subnet_id=f60f887b-60e1-4647-a762-b5c6925909cd 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，响应参数如下，id就是port_id，可以看到端口的详细信息。 { "ports": [ { "id": "6026a064-eacc-4c40-a0fd-9dcc456ad495", "name": "", "status": "DOWN", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "f60f887b-60e1-4647-a762-b5c6925909cd", "ip_address": "192.168.27.75" } ], "mac_address": "fa:16:3e:ab:1e:4e", "network_id": "b033c3b8-59ea-4a15-9f86-648119cdc50a", "tenant_id": "5f6387106c2048b589b369d96c2f23a2", "device_id": "", "device_owner": "neutron:VIP_PORT", "security_groups": [], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled": true, "instance_type": "", "instance_id": "", "zone_id": "cn-north-4a" } ]} 请求异常时，错误码请参见错误码。 查询端口详情。 如果已知端口ID，可以通过下面的接口查询端口详情。 发送“GET https://VPC的Endpoint/v1/{project_id}/ports/{port_id}”，project_id为项目ID，port_id为端口ID。 在Request Header中增加“X-Auth-Token”。 查看请求响应结果。 请求成功时，响应参数如下。 { "port": { "id": "6026a064-eacc-4c40-a0fd-9dcc456ad495", "name": "", "status": "DOWN", "admin_state_up": true, "fixed_ips": [ { "subnet_id": "f60f887b-60e1-4647-a762-b5c6925909cd", "ip_address": "192.168.27.75" } ], "mac_address": "fa:16:3e:ab:1e:4e", "network_id": "b033c3b8-59ea-4a15-9f86-648119cdc50a", "tenant_id": "5f6387106c2048b589b369d96c2f23a2", "device_id": "", "device_owner": "neutron:VIP_PORT", "security_groups": [], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled": true, "instance_type": "", "instance_id": "", "zone_id": "cn-north-4a" }} 请求异常时，错误码请参见错误码。

概述 欢迎使用虚拟私有云服务（Virtual Private Cloud，以下简称VPC）。VPC为弹性云服务器构建隔离的、用户自主配置和管理的虚拟网络环境，提升用户云上资源的安全性，简化用户的网络部署。 您可以使用本文档提供的API对VPC进行相关操作，如创建、查询、删除、更新等。支持的全部操作请参见API概览。 在调用VPC服务的API之前，请确保已经充分了解VPC服务相关概念，详细信息请参见《虚拟私有云用户指南》的“产品介绍”。 父主题： 使用前必读

响应示例 { "tags": [ { "key": "key1", "values": [ "value1", "value2" ] }, { "key": "key2", "values": [ "value1", "value2" ] } ]}

响应参数 表2 响应参数 参数名称 类型 说明 tags Array of tag objects 标签列表 表3 tag字段数据结构说明 名称 参数类型 说明 key String 键。 不能为空。 长度不超过36个字符。 由英文字母、数字、下划线、中划线、中文字符组成。 values Array of strings 值列表。 长度不超过43个字符。 由英文字母、数字、下划线、点、中划线、中文字符组成。

响应示例 { "firewall_policies": [ { "description": "", "firewall_rules": [ "6c6803e0-ca8c-4aa9-afb3-4f89275b6c32" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "6b70e321-0c21-4b83-bb8a-a886d1414a5f", "audited": false, "name": "fwp1", "project_id": "23c8a121505047b6869edf39f3062712" }, { "description": "", "firewall_rules": [ "6c6803e0-ca8c-4aa9-afb3-4f89275b6c32" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "fce92002-5a15-465d-aaca-9b44453bb738", "audited": false, "name": "fwp2", "project_id": "23c8a121505047b6869edf39f3062712" } ], "firewall_policies_links": [ { "rel": "previous", "href": "https://{Endpoint}/v2.0/fwaas/firewall_policies?marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=True" } ]}

响应参数 表2 响应参数 参数名称 类型 说明 firewall_policies Array of firewall Policy object firewall policy对象列表。请参见表3。 firewall_policies_links Array of firewall_policies_link object firewall_policies_link对象。请参见表4。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 表3 firewall_Policy对象 属性 类型 说明 id String 网络ACL策略uuid标识。 name String 网络ACL策略名称。 description String 网络ACL策略描述。 tenant_id String 项目ID firewall_rules Array of strings 策略引用的网络ACL规则链。 audited Boolean 审计标记。 public Boolean 是否支持跨租户共享。 project_id String 项目ID，请参见获取项目ID。 表4 firewall_policies_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系

URI GET /v2.0/fwaas/firewall_policies 分页查询样例： GET https://{Endpoint}/v2.0/fwaas/firewall_policies?limit=2&marker=6b70e321-0c21-4b83-bb8a-a886d1414a5f&page_reverse=False 参数说明请参见表1 表1 参数说明 名称 是否必选 参数类型 说明 id 否 String 按照网络ACL策略对应的ID过滤查询 name 否 String 按照网络ACL策略的名称过滤查询 description 否 String 按照网络ACL策略的描述过滤查询 tenant_id 否 String 按照网络ACL策略所属的项目ID过滤查询 marker 否 String 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用： 若不传入marker和limit参数，查询结果返回第一页全部资源记录。 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的所有资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。

请求示例 路由器删除接口，路由器id为b625c58c-0cfe-49e0-acc8-f2374f8187ff，子网id为4b910a10-0860-428b-b463-d84dbc5e288e。 PUT https://{Endpoint}/v2.0/routers/b625c58c-0cfe-49e0-acc8-f2374f8187ff/remove_router_interface{"subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e"}

响应示例 { "subnet_id": "4b910a10-0860-428b-b463-d84dbc5e288e", "tenant_id": "3d72597871904daeb6887f75f848b531", "project_id": "3d72597871904daeb6887f75f848b531", "port_id": "34d7d063-8f40-4958-b420-096db40d4067", "id": "b625c58c-0cfe-49e0-acc8-f2374f8187ff"}

响应示例 { "router": { "id": "f5dbdfe0-86f9-4b0a-9a32-6be143f0a076", "name": "router-220", "status": "ACTIVE", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "admin_state_up": true, "external_gateway_info": { "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "enable_snat": false }, "routes": [], "created_at": "2018-09-20T02:06:07", "updated_at": "2018-09-20T02:06:09" }}

响应参数 表5 响应参数 参数名称 类型 说明 router router object router对象，参见表6。 表6 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态，可以为ACTIVE， DOWN，ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性：外部网关信息，参见external_gateway_info对象 routes Array of route objects 扩展属性：路由信息列表，参见routes对象 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表7 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表8 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址，nexthop仅支持是router所关联的子网范围内IP地址

请求参数 表1 请求参数 参数名称 是否必选 类型 说明 router 是 router object router对象，参见表2。 更新操作时至少指定一项属性 表2 router对象 属性 是否必选 类型 说明 name 否 String 路由器的名称。 【使用说明】 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 admin_state_up 否 Boolean 管理状态。 【取值范围】 只支持true。 external_gateway_info 否 external_gateway_info object 扩展属性：外部网关信息，参见external_gateway_info对象 routes 否 Array of route objects 扩展属性：路由信息列表，参见routes对象 表3 external_gateway_info对象 属性 是否必选 类型 说明 network_id 否 String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 表4 route对象 属性 是否必选 类型 说明 destination 否 String IP地址段 【使用说明】 前缀不能和直连路由重复 nexthop 否 String 下一跳IP地址，nexthop仅支持是router所关联的子网范围内IP地址

响应示例 { "routers": [ { "id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe", "name": "xiaoleizi-tag", "status": "ACTIVE", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "admin_state_up": true, "external_gateway_info": { "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "enable_snat": false }, "routes": [ { "destination": "0.0.0.0/0", "nexthop": "172.16.0.124" } ], "created_at": "2018-03-23T09:26:08", "updated_at": "2018-08-24T08:49:53" } ], "routers_links": [ { "rel": "next", "href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe" }, { "rel": "previous", "href": "https://{Endpoint}/v2.0/routers?limit=1&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=True" } ]}

URI GET /v2.0/routers 样例： GET https://{Endpoint}/v2.0/routers?id={id}&name={name}&admin_state_up={admin_state_up}&tenant_id={tenant_id}&status={status} 分页查询样例： GET https://{Endpoint}/v2.0/routers?limit=2&marker=01ab4be1-4447-45fb-94be-3ee787ed4ebe&page_reverse=False

响应参数 表2 响应参数 参数名称 类型 说明 routers Array of router objects router对象列表，参见表3。 routers_links Array of routers_link objects 分页信息，参见表6。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 表3 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态，可以为ACTIVE， DOWN，ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性：外部网关信息，参见external_gateway_info对象 routes Array of route objects 扩展属性：路由信息列表，参见routes对象 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表4 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表5 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址，nexthop仅支持是router所关联的子网范围内IP地址 表6 routers_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系

响应示例 { "subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "project_id": "6fbe9263116a4b68818cf1edce16bc4f", "port_id": "40e86635-b2a3-45de-a7c8-3cced5b7e755", "id": "5b8e885c-1347-4ac2-baf9-2249c8ed1270"}

请求示例 路由器添加接口，路由器id为5b8e885c-1347-4ac2-baf9-2249c8ed1270，子网id为ab78be2d-782f-42a5-aa72-35879f6890ff。 PUT https://{Endpoint}/v2.0/routers/5b8e885c-1347-4ac2-baf9-2249c8ed1270/add_router_interface{"subnet_id": "ab78be2d-782f-42a5-aa72-35879f6890ff"}

响应示例 { "router": { "id": "01ab4be1-4447-45fb-94be-3ee787ed4ebe", "name": "xiaoleizi-tag", "status": "ACTIVE", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "admin_state_up": true, "external_gateway_info": { "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "enable_snat": false }, "routes": [ { "destination": "0.0.0.0/0", "nexthop": "172.16.0.124" } ], "created_at": "2018-03-23T09:26:08", "updated_at": "2018-08-24T08:49:53" }}

响应参数 表1 响应参数 参数名称 类型 说明 router router object router对象，参见表2。 表2 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态，可以为ACTIVE， DOWN，ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性：外部网关信息，参见external_gateway_info对象 routes Array of route objects 扩展属性：路由信息列表，参见表4 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表3 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表4 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址，nexthop仅支持是router所关联的子网范围内IP地址

响应示例 { "router": { "id": "f5dbdfe0-86f9-4b0a-9a32-6be143f0a076", "name": "router-test2", "status": "ACTIVE", "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "admin_state_up": true, "external_gateway_info": { "network_id": "0a2228f2-7f8a-45f1-8e09-9039e1d09975", "enable_snat": false }, "routes": [], "created_at": "2018-09-20T02:06:07", "updated_at": "2018-09-20T02:06:09" }}

请求参数 表1 请求参数 参数名称 类型 是否必选 说明 router router object 是 router对象，参见表2。 表2 router对象 属性 是否必选 类型 说明 name 否 String 路由器的名称。 【使用说明】 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 admin_state_up 否 Boolean 管理状态。 【取值范围】 只支持true。 external_gateway_info 否 external_gateway_info object 扩展属性：外部网关信息，参见external_gateway_info对象 表3 external_gateway_info对象 属性 是否必选 类型 说明 network_id 否 String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。

响应参数 表4 响应参数 参数名称 类型 说明 router router object router对象，参见表5 表5 router对象 属性 类型 说明 id String 路由器的id 【使用说明】在查询路由器列表时非必选 name String 路由器的名称。 仅支持数字、字母、_(下划线)、-（中划线）、.（点）。 admin_state_up Boolean 管理状态。 只支持true。 status String 状态，可以为ACTIVE， DOWN，ERROR。 tenant_id String 项目ID external_gateway_info external_gateway_info object 扩展属性：外部网关信息，参见external_gateway_info对象 routes Array of route objects 扩展属性：路由信息列表，参见routes对象 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表6 external_gateway_info对象 属性 类型 说明 network_id String 外部网络的UUID。 外部网络的信息请通过GET /v2.0/networks?router:external=True或neutron net-external-list方式查询。 enable_snat Boolean 是否启用SNAT。 默认为false。 表7 route对象 属性 类型 说明 destination String IP地址段 nexthop String 下一跳IP地址，nexthop仅支持是router所关联的子网范围内IP地址

响应示例 { "routes": [ { "type": "peering", "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", "destination": "192.168.200.0/24", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff", "tenant_id": "6fbe9263116a4b68818cf1edce16bc4f", "id": "3d42a0d4-a980-4613-ae76-a2cddecff054" } ] }

URI GET /v2.0/vpc/routes 样例： 样例：GET https://{Endpoint}/v2.0/vpc/routes?id={id}&vpc_id={vpc_id}&tenant_id={tenant_id}&destination={destination}&type={type}&limit={limit}&marker={marker} 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 id 否 String 按照routes_id过滤查询 tenant_id 否 String 按照tenant_id过滤查询 vpc_id 否 String 按照vpc_id过滤查询 destination 否 String 按照路由目的地址CIDR过滤查询 type 否 String 按照type进行过滤查询，目前只支持peering marker 否 String 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用： 若不传入marker和limit参数，查询结果返回第一页全部资源记录。 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的所有资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 默认值为2000。

响应参数 表2 响应参数 参数名称 类型 说明 routes Array of route objects route对象列表，参见表3。 routes_links Array of routes_link objects routes_link对象列表，参见表4。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 表3 route对象 属性 类型 说明 id String 路由id destination String 路由目的地址CIDR，如192.168.200.0/24。 nexthop String 路由下一跳，如果路由是“peering”类型，填写vpc peering id。 type String 路由类型。目前只支持“peering”。 vpc_id String 路由的vpc，需要填写存在的vpc_id。 tenant_id String 项目ID 表4 routes_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系

URI GET /v1/{project_id}/subnets/{subnet_id}/privateips 样例： GET https://{Endpoint}/v1/{project_id}/subnets/{subnet_id}/privateips?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID，获取项目ID请参见获取项目ID。 subnet_id 是 String 私有IP所在子网的唯一标识 如果您使用管理控制台，此值即为子网详情中的“网络ID”参数值。 marker 否 String 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用： 若不传入marker和limit参数，查询结果返回第一页全部资源记录。 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11条及之后的所有资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。

响应参数 表2 请求参数 名称 参数类型 说明 privateips Array of privateip objects 私有IP列表对象，请参见表3。 表3 privateip字段说明 名称 参数类型 说明 status String 功能说明：私有IP的状态 取值范围： ACTIVE：活动的 DOWN：不可用 id String 私有IP标识 subnet_id String 分配IP的子网标识 如果您使用管理控制台，此值即为子网详情中的“网络ID”参数值。 tenant_id String 项目ID device_owner String 功能说明：私有IP的使用者，空表示未使用 取值范围： network:dhcp DHCP服务IP地址 network:router_interface_distributed 网关IP地址 compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的E CS 使用) 虚拟机网卡IP地址 neutron:VIP_PORT 虚拟IP地址 compute:subeni 辅助弹性网卡IP地址 neutron:LOADBALANCERV2 共享ELB使用的IP地址 neutron:LOADBALANCERV3 独享ELB使用的IP地址 network:endpoint_interface VPC终端节点 使用的IP地址 约束：此处的取值范围只是本服务支持的类型，其他类型未做标注 ip_address String 申请到的私有IP

响应示例 { "privateips": [ { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f78", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.11" }, { "status": "DOWN", "id": "d600542a-b231-45ed-af05-e9930cb14f79", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.12" } ]}