华为云用户手册

响应示例 { "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" } ]}

响应示例 { "network": { "id": "c360322d-5315-45d7-b7d2-481f98c56edb", "name": "network-test", "status": "ACTIVE", "shared": false, "subnets": [], "availability_zone_hints": [], "availability_zones": [ "az2.dc2", "az5.dc5" ], "admin_state_up": true, "tenant_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "project_id": "bbfe8c41dd034a07bebd592bf03b4b0c", "provider:network_type": "vxlan", "router:external": false, "port_security_enabled": true, "created_at": "2018-09-20T01:53:18", "updated_at": "2018-09-20T01:53:20" }}

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~2000条（limit默认值2000）资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。

请求参数 表1 请求参数 参数名称 类型 必选 说明 network network object 是 network对象，参见表2。 表2 network对象 属性 是否必选 类型 说明 name 否 String 网络名称。 【使用说明】name不能为admin_external_net（预置网络名称，不可占用）。 admin_state_up 否 Boolean 管理状态。 【使用说明】只支持true。 shared 否 Boolean 是否支持跨租户共享。 provider:network_type 否 String 扩展属性：网络类型。 取值范围：支持租户创建geneve、vxlan类型的网络 租户只能指定此参数为geneve，不指定时网络类型自动分配，一般分配为vxlan类型。预置网络admin_external_net的情况下，此参数为vlan，用户不可配置。 【使用说明】 创建geneve类型的网络，请指定此参数为geneve。 创建vxlan类型的网络，请求时请不要指定此参数。 port_security_enabled 否 Boolean 端口安全使能标记，如果不使能，则network下所有虚机的安全组和dhcp防欺骗不生效

响应参数 表3 响应参数 参数名称 类型 说明 network network object network对象，参见表4。 表4 network对象 属性 类型 说明 status String 网络状态，可以为ACTIVE，BUILD，DOWN或ERROR。 subnets Array of strings 网络关联的子网ID列表。 一个network仅支持关联一个subnet。 name String 网络名称。 name不能为admin_external_net（预置网络名称，不可占用）。 router:external Boolean 扩展属性：是否外部网络，默认值false。 admin_state_up Boolean 管理状态。 只支持true。 tenant_id String 项目ID shared Boolean 是否支持跨租户共享。 id String 网络的id 【使用说明】在查询网络列表时候非必选 provider:network_type String 扩展属性：网络类型。 取值范围：支持租户创建geneve、vxlan类型的网络 租户只能指定此参数为geneve，不指定时网络类型自动分配，一般分配为vxlan类型。预置网络admin_external_net的情况下，此参数为vlan，用户不可配置。 【使用说明】 创建geneve类型的网络，请指定此参数为geneve。 创建vxlan类型的网络，请求时请不要指定此参数。 availability_zone_hints Array of strings 本网络的候选可用域，当前版本不支持可用域调度。 availability_zones Array of strings 本网络的可用域。 port_security_enabled Boolean 端口安全使能标记，如果不使能，则network下所有虚机的安全组和dhcp防欺骗不生效 dns_domain String 默认内网DNS域地址，系统自动生成维护，不支持设置和更新 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss

响应参数 表2 响应参数 参数名称 类型 说明 firewall_groups Array of Firewall Group objects firewall group对象列表。请参见表3。 firewall_groups_links Array of firewall_groups_link objects firewall_groups_link对象列表。请参见表4。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 表3 Firewall Group对象 属性 类型 说明 id String 网络ACL组的uuid标识。 name String 网络ACL组名称。 description String 网络ACL组描述。 tenant_id String 项目ID ingress_firewall_policy_id String 入方向网络ACL策略。 egress_firewall_policy_id String 出方向网络ACL策略。 ports Array of strings 网络ACL组绑定的端口列表。 public Boolean 是否支持跨租户共享。 status String 网络ACL组的状态。 取值范围： ACTIVE：正常 INACTIVE：未激活 ERROR：错误 PENDING_CREATE：创建中 PENDING_UPDATE：更新中 PENDING_DELETE：删除中 admin_state_up Boolean 网络ACL的管理状态。 project_id String 项目ID，请参见获取项目ID。 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表4 firewall_groups_link对象 名称 参数类型 说明 href String API链接 rel String API链接与该API版本的关系

响应示例 { "firewall_groups": [ { "status": "INACTIVE", "public": false, "egress_firewall_policy_id": null, "name": "", "admin_state_up": true, "ports": [ ], "tenant_id": "23c8a121505047b6869edf39f3062712", "id": "cd600d47-0045-483f-87a1-5041ae2f513b", "ingress_firewall_policy_id": null, "description": "", "project_id": "23c8a121505047b6869edf39f3062712", "created_at": "2018-09-12T08:24:14", "updated_at": "2018-09-12T08:24:14" }, { "status": "INACTIVE", "public": false, "egress_firewall_policy_id": "d939df29-fe76-4089-90c3-3778e4d53141", "name": "fwg-1475475043", "admin_state_up": true, "ports": [ ], "tenant_id": "0af57070695044ea9a70f04779e6aa1f", "id": "ca971b45-70ce-4879-9734-b6cac1d00845", "ingress_firewall_policy_id": "d939df29-fe76-4089-90c3-3778e4d53141", "description": "", "project_id": "0af57070695044ea9a70f04779e6aa1f", "created_at": "2018-09-12T08:24:14", "updated_at": "2018-09-12T08:24:14" } ], "firewall_groups_links": [ { "rel": "previous", "href": "https://{Endpoint}/v2.0/fwaas/firewall_groups?marker=cd600d47-0045-483f-87a1-5041ae2f513b&page_reverse=True" } ]}

响应示例 { "peering": { "name": "test", "description": "test", "id": "22b76469-08e3-4937-8c1d-7aad34892be1", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "status": "ACTIVE" }}

响应参数 表2 响应参数 参数名称 类型 说明 peering peering object peering对象列表，参见表3。 表3 peering对象 属性 类型 说明 id String 对等连接id name String 对等连接的名称 status String 状态位： PENDING_ACCEPTANCE：等待接受 REJECTED：已拒绝。 EXPIRED：已过期。 DELETED：已删除。 ACTIVE：活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息，请参见表4。 accept_vpc_info vpc_info object 对等连接接受端vpc信息，请参见表4。 description String 对等连接描述 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表4 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id tenant_id String 对等连接其中一端vpc所属的项目id

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~2000条（limit默认值2000）资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。

响应示例 { "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版本的关系

请求示例 创建两个私有IP，指定在id为531dec0f-3116-411b-a21b-e612e42349fd的子网中创建，一个ip地址自动分配，一个指定ip地址为192.168.1.17。 POST https://{Endpoint}/v1/{project_id}/privateips{ "privateips": [ { "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd" }, { "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "ip_address": "192.168.1.17" } ]}

响应参数 表4 响应参数 名称 参数类型 说明 privateips Array of privateip objects 私有IP列表对象，请参见表5。 表5 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地址 network:nat_gateway NAT网关使用的IP地址 约束：此处的取值范围只是本服务支持的类型，其他类型未做标注 ip_address String 申请到的私有IP

响应示例 { "privateips": [ { "status": "DOWN", "id": "c60c2ce1-1e73-44bd-bf48-fd688448ff7b", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.10" }, { "status": "DOWN", "id": "4b123c18-ae92-4dfa-92cd-d44002359aa1", "subnet_id": "531dec0f-3116-411b-a21b-e612e42349fd", "tenant_id": "8b7e35ad379141fc9df3e178bd64f55c", "device_owner": "", "ip_address": "192.168.1.17" } ]}

请求示例 在id为afc52ce9-5305-4ec9-9feb-44feb8330341的ACL策略中移除ACL规则0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1。 PUT https://{Endpoint}/v2.0/fwaas/firewall_policies/afc52ce9-5305-4ec9-9feb-44feb8330341/remove_rule { "firewall_rule_id": "0f82b221-8cd6-44bd-9dfc-0e118fa7b6b1"}

请求参数 表2 请求参数 名称 是否必选 参数类型 说明 privateips 是 Array of privateip objects 私有IP列表对象，请参见表3。 表3 privateip字段说明 名称 是否必选 参数类型 说明 subnet_id 是 String 分配IP的子网标识 如果您使用管理控制台，此值即为子网详情中的“网络ID”参数值。 ip_address 否 String 功能说明：指定IP地址申请 取值范围：子网网段中的可以使用且未分配的IP地址，不指定时由系统自动分配

响应示例 { "description": "", "firewall_rules": [ "b8243448-cb3c-496e-851c-dadade4c161b" ], "tenant_id": "23c8a121505047b6869edf39f3062712", "public": false, "id": "afc52ce9-5305-4ec9-9feb-44feb8330341", "audited": false, "name": "test-policy", "project_id": "23c8a121505047b6869edf39f3062712"}

响应参数 表2 响应参数 参数名称 类型 说明 description String 对policy的描述信息 audited Boolean 每次policy或者它相关的rule有变动，该参数将会被置为False firewall_rules Array of strings 与当前policy相关联的rule的ID列表 id String policy ID name String Policy名称 public Boolean 如果为True，该policy对于其他项目网络ACL策略可见， 默认不可见 tenant_id String 项目ID project_id String 项目ID

响应参数 表2 响应参数 参数名称 类型 说明 peerings Array of peering objects peering对象列表，参见表3。 peerings_links Array of peerings_link objects peerings_link对象列表，参见表5。 只有在使用limit过滤，并且资源个数超过limit或者资源个数超过2000时（limit默认值），该参数的rel和href取值才会显示为next和其对应的link。 表3 peering对象 属性 类型 说明 id String 对等连接id。 name String 对等连接的名称。 status String 状态位： PENDING_ACCEPTANCE：等待接受 REJECTED：已拒绝。 EXPIRED：已过期。 DELETED：已删除。 ACTIVE：活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息，请参见表4。 accept_vpc_info vpc_info object 对等连接接受端vpc信息，请参见表4。 description String 对等连接描述。 created_at String 功能说明：资源创建时间，UTC时间。 格式：yyyy-MM-ddTHH:mm:ss updated_at String 功能说明：资源更新时间，UTC时间。 格式：yyyy-MM-ddTHH:mm:ss 表4 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id。 tenant_id String 对等连接其中一端vpc所属的项目id。 表5 peerings_link对象 名称 参数类型 说明 href String API链接。 rel String API链接与该API版本的关系。

响应示例 { "peerings": [ { "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "name": "test", "description": "test", "id": "b147a74b-39bb-4c7a-aed5-19cac4c2df13", "status": "ACTIVE" } ]}

URI GET /v2.0/vpc/peerings 样例： GET https://{Endpoint}/v2.0/vpc/peerings?id={id}&name={name}&status={status}&tenant_id={tenant_id}&vpc_id={vpc_id}&limit={limit}&marker={marker} 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 id 否 String 按照peering_id过滤查询。 name 否 String 功能说明：按照peering_name过查询。 取值范围：最大长度不超过64。 status 否 String 按照status进行过滤。 tenant_id 否 String 按照tenant_id过滤查询。 vpc_id 否 String 按照vpc_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~2000条（limit默认值2000）资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 默认值为2000。

请求示例 创建一个对等连接，请求方vpc id为9daeac7c-a98f-430f-8e38-67f9c044e299，接收方vpc id为f583c072-0bb8-4e19-afb2-afb7c1693be5，命名为test。 POST https://{Endpoint}/v2.0/vpc/peerings { "peering": { "name": "test", "description": "test", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5" } } }

响应参数 表4 响应参数 参数名称 类型 说明 peering peering object peering对象，请参见表5。 表5 peering对象 属性 类型 说明 id String 对等连接id name String 对等连接的名称 status String 状态位： PENDING_ACCEPTANCE：等待接受 REJECTED：已拒绝。 EXPIRED：已过期。 DELETED：已删除。 ACTIVE：活动的。 request_vpc_info vpc_info object 对等连接发起端vpc信息，请参见表6。 accept_vpc_info vpc_info object 对等连接接受端vpc信息，请参见表6。 description String 对等连接描述 created_at String 资源创建时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss updated_at String 资源更新时间，UTC时间 格式：yyyy-MM-ddTHH:mm:ss 表6 vpc_info对象 属性 类型 说明 vpc_id String 对等连接其中一端vpc id tenant_id String 对等连接其中一端vpc所属的项目id

响应示例 { "peering": { "name": "test", "id": "22b76469-08e3-4937-8c1d-7aad34892be1", "request_vpc_info": { "vpc_id": "9daeac7c-a98f-430f-8e38-67f9c044e299", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "accept_vpc_info": { "vpc_id": "f583c072-0bb8-4e19-afb2-afb7c1693be5", "tenant_id": "f65e9ebc-ed5d-418b-a931-9a723718ba4e" }, "status": "ACTIVE" }}

响应消息 响应参数 表2 响应参数 名称 参数类型 说明 ports Array of port objects 端口列表对象，请参见表3。 表3 port字段说明 名称 参数类型 说明 id String 端口唯一标识 name String 功能说明：端口名称 取值：默认为空，最大长度不超过255 network_id String 功能说明：端口所属网络的ID 约束：必须是存在的网络ID admin_state_up Boolean 功能说明：管理状态 约束：只支持true，默认为true mac_address String 功能说明：端口MAC地址 约束：由系统分配，不支持指定 fixed_ips Array of fixed_ip objects 功能说明：端口IP。例如："fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]，请参见表4 约束：一个端口只支持一个fixed_ip，且不支持更新。 device_id String 功能说明：端口所属设备ID 约束：不支持设置和更新，由系统自动维护 device_owner String 功能说明：设备所属（DHCP/Router/ lb/Nova） 约束：不支持设置和更新，由系统自动维护 tenant_id String 项目ID。 status String 功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN 取值范围：ACTIVE、BUILD、DOWN security_groups Array of strings 安全组的UUID(扩展属性) allowed_address_pairs Array of allow_address_pair objects 功能说明：IP/Mac对列表，allow_address_pair参见表5（扩展属性） 约束：IP地址不允许为 “0.0.0.0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组 如果allowed_address_pairs为“1.1.1.1/0”，表示关闭源目的地址检查开关 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表6 binding:vif_details Object vif的详细信息， "ovs_hybrid_plug": 是否为ovs/bridge混合模式 binding:profile Object 扩展属性：提供用户设置自定义信息 【使用说明】 internal_elb字段，布尔类型，普通租户可见。只有在创建内网ELB的虚拟IP的网卡时设置为true。普通租户没有权限更改该字段，由系统维护。 举例： {"internal_elb": true} disable_security_groups字段，布尔类型，普通租户可见。默认为false高性能通信场景下，允许指定为true普通租户可见。仅支持创建port和读取时指定。当前仅支持指定为true，不支持指定为false 举例： {"disable_security_groups"：true }， 当前仅支持指定为true，不支持指定为false，指定为true时，FWaaS功能不生效。 binding:vnic_type String 功能说明：绑定的vNIC类型 取值范围：normal或者direct。normal: 软交换，direct: SRIOV硬直通（不支持） port_security_enabled Boolean 端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效，默认为true dns_assignment Array of dns_assignment objects 扩展属性：主网卡默认内网 域名 信息 【使用说明】不支持设置和更新，由系统自动维护 hostname：与端口dns_name一致 ip_address：端口ipv4私有地址 fqdn：为端口创建默认内网fqdn dns_name String 扩展属性：主网卡默认内网DNS名称 【使用说明】不支持设置和更新，由系统自动维护，访问该默认内网域名前，请确保子网使用当前系统提供的DNS 表4 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明：所属子网ID 约束：不支持更新 ip_address String 端口IP地址 表5 allow_address_pair对象 名称 参数类型 说明 ip_address String 功能说明：IP地址 约束：不支持0.0.0.0 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 mac_address String MAC地址 表6 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String Option名称 opt_value String Option值 表7 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。 响应样例 { "ports": [ { "id": "d00f9c13-412f-4855-8af3-de5d8c24cd60", "name": "test", "status": "DOWN", "admin_state_up": "true", "fixed_ips": [ { "subnet_id": "70f2e74b-e660-410a-b754-0ca46744348a", "ip_address": "10.128.1.10" } ], "dns_assignment": [ { "hostname": "ip-10-128-1-10", "ip_address": "10-128-1-10", "fqdn": "ip-10-128-1-10.xxx.compute.internal." } ], "dns_name": "ip-10-128-1-10", "mac_address": "fa:16:3e:d7:f2:6c", "network_id": "5b808927-13c9-4e60-a4f4-ed6ffe225167", "tenant_id": "43f2d1cca56a40729dcb17212482f34d", "device_id": "", "device_owner": "", "security_groups": [ "02b4e8ee-74fa-4a31-802e-5490df11245e" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled":true }, { "id": "28ba8f45-7636-45e4-8c0a-675d7663717c", "name": "test1", "status": "DOWN", "admin_state_up": "true", "fixed_ips": [ { "subnet_id": "061d3ca2-bd1f-4bd1-a01d-7a5155328c0e", "ip_address": "192.168.10.10" } ], "dns_assignment": [ { "hostname": "ip-192-168-10-10", "ip_address": "192-168-10-10", "fqdn": "ip-192-168-10-10.xxx.compute.internal." } ], "dns_name": "ip-192-168-10-10", "mac_address": "fa:16:3e:3d:91:cd", "network_id": "be2fe79a-3ee2-4d87-bd71-5afa78a5670d", "tenant_id": "43f2d1cca56a40729dcb17212482f34d", "device_id": "", "device_owner": "", "security_groups": [ "0bfc8687-ca18-4c37-ac84-d2198baba585" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "binding:vif_details": {}, "binding:profile": {}, "port_security_enabled":true } ]}

URI GET /v1/ports 样例： GET https://{Endpoint}/v1/ports?id={port_id}&name={port_name}&admin_state_up={is_admin_status_up}&network_id={network_id}&mac_address={port_mac}&device_id={port_device_id}&device_owner={device_owner}&status={port_status}&fixed_ips=ip_address={ip_address}&fixed_ips=subnet_id={subnet_id} 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 id 否 String 按照port_id过滤查询 name 否 String 功能说明：按照name过滤查询 取值范围：最大长度不超过255 admin_state_up 否 Boolean 按照admin_state_up进行过滤 network_id 否 String 按照network_id过滤查询 mac_address 否 String 按照mac_address过滤查询 device_id 否 String 按照device_id过滤查询 device_owner 否 String 按照device_owner过滤查询 status 否 String 功能说明：按照status过滤查询 取值范围：ACTIVE、BUILD、DOWN marker 否 String 分页查询的起始资源ID，表示从指定资源的下一条记录开始查询。 marker需要和limit配合使用： 若不传入marker和limit参数，查询结果返回第一页全部资源记录。 若不传入marker参数，limit为10，查询结果返回第1~10条资源记录。 若marker为第10条记录的资源ID，limit为10，查询结果返回第11~20条资源记录。 若marker为第10条记录的资源ID，不传入limit参数，查询结果返回第11~2000条（limit默认值2000）资源记录。 limit 否 Integer 分页查询每页返回的记录个数，取值范围为0~intmax（2^31-1），默认值2000。 limit需要和marker配合使用，详细规则请见marker的参数说明。 fixed_ips 否 String 按照fixed_ips=ip_address或者fixed_ips=subnet_id过滤查询

响应示例 { "route": { "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" }}

请求参数 表1 请求参数 参数名称 类型 必选 说明 route route object 是 route对象，参见表2。 表2 route对象 属性 类型 是否必选 说明 destination String 是 路由目的地址CIDR，如192.168.200.0/24。支持IPv4和IPv6。 nexthop String 是 路由下一跳，如果路由是“peering”类型，填写vpc peering id。 vpc peering id即对等连接id，获取方法请参见查询对等连接列表。 type String 是 路由类型。 目前只支持“peering”类型，即下一跳为对等连接。 如果下一跳为ECS，该API不支持，请您使用更新路由表。 vpc_id String 是 请求创建路由的VPC ID。

请求示例 创建peering类型的VPC路由，所在vpc id为ab78be2d-782f-42a5-aa72-35879f6890ff，下一跳peering id为60c809cb-6731-45d0-ace8-3bf5626421a9，目的地址192.168.200.0/24。 POST https://{Endpoint}/v2.0/vpc/routes { "route": { "type": "peering", "nexthop": "60c809cb-6731-45d0-ace8-3bf5626421a9", "destination": "192.168.200.0/24", "vpc_id": "ab78be2d-782f-42a5-aa72-35879f6890ff" }}