华为云用户手册

网络配置流程 创建DRS实例，并获取DRS实例私有IP地址。 DRS迁移实例创建成功后，界面会显示DRS迁移实例的私有IP地址。 图3 DRS实例私有IP 配置源库所在安全组和源库所在子网的网络ACL。 安全组：增加云数据库安全组入方向规则，放通DRS私网IP作为源地址可以访问云数据库监听端口。 网络ACL：VPC默认没有网络ACL，如果您设置过网络ACL，需要增加入方向规则，允许放通DRS私网IP作为源地址、随机端口作为源端口范围，RDS源数据库的IP作为目的地址、监听端口作为目的端口范围。 华为云E CS 自建数据库添加白名单。 华为云ECS自建数据库需要添加迁移账号使用DRS私有 IP访问数据库的权限。各种数据库添加白名单的方法不同，请参考各数据库官方文档进行操作。 配置DRS迁移实例所在安全组和DRS所在子网的网络ACL。 VPC默认没有网络ACL，默认安全组的规则在出方向数据全部放行，DRS迁移实例和目标RDS数据库在相同安全组默认互通，所以在默认场景下无需配置。 如果您设置过网络ACL或安全组，请登录VPC管理控制台进行检查和配置。 安全组：确保DRS私网IP出方向到源数据库的IP、监听端口放通。 网络ACL：确保DRS私网IP、随机端口出方向和源数据库的IP、监听端口放通。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入源数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 源库绑定弹性公网IP。 参考华为云各数据库官方文档进行绑定弹性公网IP。 以源库为华为云RDS for MySQL为例，可参考《绑定和解绑弹性公网IP》。 创建DRS公网网络任务，为DRS实例绑定弹性公网IP。 在创建公网网络的DRS任务时，可在实例信息页面为DRS实例绑定弹性公网IP。 配置源库所在安全组和源库所在子网的网络ACL。 安全组：增加云数据库安全组入方向规则，放通DRS弹性公网IP作为源地址可以访问云数据库监听端口。 网络ACL：VPC默认没有网络ACL，如果您设置过网络ACL，需要增加入方向规则，允许放通DRS弹性公网IP作为源地址、随机端口作为源端口范围，RDS源数据库的IP作为目的地址、监听端口作为目的端口范围。 配置DRS迁移实例所在安全组和DRS所在子网的网络ACL。 VPC默认没有网络ACL，默认安全组的规则在出方向数据全部放行，DRS迁移实例和目标RDS数据库在相同安全组默认互通，所以在默认场景下无需配置。 如果您设置过网络ACL或安全组，请登录VPC管理控制台进行检查和配置。 安全组：确保DRS迁移实例所在安全组出方向到源数据库的IP、监听端口放通。 网络ACL：确保DRS所在子网、随机端口出方向和源数据库的IP、监听端口放通。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入源数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 创建VPC对等连接。 同账号建立VPC对等连接的方法，可参考《创建相同账户下的对等连接》。 不同账号建立VPC对等连接的方法，可参考《创建不同账户下的对等连接》。 对等连接建立后，需要在本端VPC、对端VPC分别添加对方子网的路由才能通信，详细操作可参考添加VPC对等连接路由。 在添加对等路由时，建议添加网段路由信息。如果添加点对点路由，DRS任务重建后实例IP会发生改变，此时需要重新添加路由，否则会导致网络不通。 创建DRS实例，并获取DRS实例私有IP地址。 DRS迁移实例创建成功后，界面会显示DRS迁移实例的私有IP地址。 图3 DRS实例私有IP 配置源库所在安全组和源库所在子网的网络ACL。 安全组：增加云数据库安全组入方向规则，放通DRS私网IP作为源地址可以访问云数据库监听端口。 网络ACL：VPC默认没有网络ACL，如果您设置过网络ACL，需要增加入方向规则，允许放通DRS私网IP作为源地址、随机端口作为源端口范围，RDS源数据库的IP作为目的地址、监听端口作为目的端口范围。 配置DRS迁移实例所在安全组和DRS所在子网的网络ACL。 VPC默认没有网络ACL，默认安全组的规则在出方向数据全部放行，DRS迁移实例和目标RDS数据库在相同安全组默认互通，所以在默认场景下无需配置。 如果您设置过网络ACL或安全组，请登录VPC管理控制台进行检查和配置。 安全组：确保DRS私网IP出方向到源数据库的IP、监听端口放通。 网络ACL：确保DRS私网IP、随机端口出方向和源数据库的IP、监听端口放通。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入源数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 创建DRS实例，并获取DRS实例私有IP地址。 DRS迁移实例创建成功后，界面会显示DRS迁移实例的私有IP地址。 图3 DRS实例私有IP 配置源库所在安全组和源库所在子网的网络ACL。 安全组：增加云数据库安全组入方向规则，放通DRS私网IP作为源地址可以访问云数据库监听端口。 网络ACL：VPC默认没有网络ACL，如果您设置过网络ACL，需要增加入方向规则，允许放通DRS私网IP作为源地址、随机端口作为源端口范围，RDS源数据库的IP作为目的地址、监听端口作为目的端口范围。 配置DRS迁移实例所在安全组和DRS所在子网的网络ACL。 VPC默认没有网络ACL，默认安全组的规则在出方向数据全部放行，DRS迁移实例和目标RDS数据库在相同安全组默认互通，所以在默认场景下无需配置。 如果您设置过网络ACL或安全组，请登录VPC管理控制台进行检查和配置。 安全组：确保DRS私网IP出方向到源数据库的IP、监听端口放通。 网络ACL：确保DRS私网IP、随机端口出方向和源数据库的IP、监听端口放通。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入源数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 创建DRS实例，并获取DRS实例所在子网和私有IP地址。 DRS实例所在子网默认选择与目标库在同一个子网。 图3 迁移实例信息 DRS迁移实例创建成功后，界面会显示DRS迁移实例的私有IP地址。 图4 DRS实例私有IP 查询DRS实例所在VPC信息。 DRS迁移实例默认和目标RDS数据库创建在相同VPC，因此可以登录目标RDS查看“基本信息”获取迁移实例所在VPC信息。 图5 目标库信息 购买VPN，并配置VPN网关和连接。 购买VPN和配置VPN相关操作，可参考《 虚拟专用网络 快速入门》。 其中创建VPN网关时的虚拟私有云参数为步骤2中DRS迁移实例所在VPC名称。创建VPN连接时填写的本端子网参数，填写步骤1中DRS迁移实例所在子网。 在其他云购买VPN，并根据华为云VPN配置进行对接。 具体操作请参考其他云对应官网资料进行VPN购买和对接。 其他云数据库添加白名单 其他云数据库需要添加DRS迁移实例私有IP访问数据库的权限。各厂商云数据库添加白名单的方法不同，请参考各数据库官方文档进行操作。 配置安全组和网络ACL。 VPC默认没有网络ACL，默认安全组的规则在出方向数据全部放行，DRS迁移实例和目标RDS数据库在相同安全组默认互通，所以在默认场景下无需配置。 如果您设置过网络ACL或安全组，请登录VPC管理控制台进行配置。 安全组：确保DRS私网IP出方向到源数据库的IP、监听端口放通。 网络ACL：确保DRS私网IP、随机端口出方向和源数据库的IP、监听端口放通。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入其他云的数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 创建DRS公网网络任务，为DRS实例绑定弹性公网IP。 在创建公网网络的DRS任务时，可在实例信息页面为DRS实例绑定弹性公网IP。 其他云申请弹性公网IP并绑定到数据库。 不同数据库对应方法不同，具体操作步骤可参考其他云官网资料进行设置。 其他云数据库添加白名单。 其他云数据库需要添加DRS弹性公网IP远程访问数据库的权限。 各厂商云数据库添加白名单的方法不同，请参考各厂商云数据库官方文档进行操作。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入其他云的数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 创建DRS实例，并获取DRS实例所在子网和私有IP地址。 DRS实例所在子网默认选择与目标库在同一个子网。 图3 迁移实例信息 DRS迁移实例创建成功后，界面会显示DRS迁移实例的私有IP地址。 图4 DRS实例私有IP 查询DRS实例所在VPC信息。 DRS迁移实例默认和目标RDS数据库创建在相同VPC，因此可以登录目标RDS查看“基本信息”获取迁移实例所在VPC信息。 图5 目标库信息 购买VPN，并配置VPN网关和连接。 购买VPN和配置VPN相关操作，可参考《虚拟专用网络快速入门》。 其中创建VPN网关时的虚拟私有云参数为步骤2中DRS迁移实例所在VPC名称。创建VPN连接时填写的本端子网参数，填写步骤1中DRS迁移实例所在子网。 本地数据中心配置VPN对端设备。 本地数据中心网络采用不同类型的防火墙或主机，可参考《虚拟专用网络快速入门》中的“配置对端设备”章节实现本地数据中心数据库所在网络和华为云DRS所在VPC子网的互通。 本地数据中心自建数据库添加白名单。 本地数据中心自建数据库需要添加DRS私有IP远程访问数据库的权限。 各类型数据库添加白名单的方法不同，具体方法请参考各数据库官方文档进行操作。 配置安全组和网络ACL。 VPC默认没有网络ACL，默认安全组的规则在出方向数据全部放行，DRS迁移实例和目标RDS数据库在相同安全组默认互通，所以在默认场景下无需配置。 如果您设置过网络ACL或安全组，请登录VPC管理控制台进行配置。 安全组：确保DRS私网IP出方向到本地数据中心自建数据库的IP、监听端口放通。 网络ACL：确保DRS私网IP、随机端口出方向和本地数据中心自建数据库的IP、监听端口放通。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入本地数据中心的数据库IP、端口、用户名、密码进行测试连接。

网络配置流程 创建DRS公网网络任务，为DRS实例绑定弹性公网IP。 在创建公网网络的DRS任务时，可在实例信息页面为DRS实例绑定弹性公网IP。 本地数据中心的防火墙设置。 本地数据中心防火墙需要放通DRS实例弹性公网IP的访问，使得DRS可以正常访问本地数据中心自建数据库。 入方向放行：放通DRS实例弹性公网IP到数据库监听端口的访问。 出方向放行：放通数据库监听端口到实例弹性公网IP的数据传输。 本地数据中心自建数据库添加白名单。 本地数据中心自建数据库需要添加DRS弹性公网IP远程访问数据库的权限。 各类型数据库添加白名单的方法不同，具体方法请参考各数据库官方文档进行操作。 测试连接。 登录DRS控制台，单击已经创建的DRS任务操作列的“编辑”，重新进入“源库及目标库”界面，输入本地数据中心的数据库IP、端口、用户名、密码进行测试连接。

准备工作概览 当您在使用DRS创建任务时，需要提前做一些准备工作，以满足DRS任务的环境要求。 表1 准备工作概览 准备项 说明 需要执行的准备工作 账号准备 准备华为账号，创建用户并赋权使用DRS。 参考 注册华为账号 并开通华为云。 参考权限管理创建用户并授权使用DRS。 数据库准备 源和目标数据库以及对应连接账号权限准备。 说明： 建议创建单独用于DRS任务连接的数据库账号，避免因为账号修改，导致的任务连接失败。 连接源和目标数据库的账号密码修改后，请尽快修改DRS任务中的连接信息，避免任务连接失败后自动重试，导致数据库账号被锁定影响使用。 不同链路，数据库和权限的要求也不同，可参考以下链接，选择对应链路查看使用须知： 支持的数据库版本 实时迁移方案概览 备份迁移方案概览 实时同步方案概览 数据订阅使用须知 实时灾备方案概览 网络准备 源数据库部署在本地 参考本地数据库到华为云进行网络准备。 源数据库为其他云数据库 参考其他云数据库到华为云进行网络准备。 源数据库为华为云上数据库 参考华为云数据库到华为云进行网络准备。 源数据库库为华为云ECS自建库 参考华为云ECS自建数据库到华为云进行网络准备。

DEW权限 默认情况下，KMS管理员创建的 IAM 用户没有任何权限，需要将其加入用户组，并给用户组授予策略或角色，才能使得用户组中的用户获得对应的权限，这一过程称为授权。授权后，用户就可以基于被授予的权限对云服务进行操作。 DEW部署时通过物理区域划分，为项目级服务。授权时，“作用范围”需要选择“区域级项目”，然后在指定区域（如华北-北京1）对应的项目（cn-north-1）中设置相关权限，并且该权限仅对此项目生效；如果在“所有项目”中设置权限，则该权限在所有区域项目中都生效。访问DEW时，需要先切换至授权区域。 根据授权精细程度分为角色和策略。 角色：IAM最初提供的一种根据用户的工作职能定义权限的粗粒度授权机制。该机制以服务为粒度，提供有限的服务相关角色用于授权。由于华为云各服务之间存在业务依赖关系，因此给用户授予角色时，可能需要一并授予依赖的其他角色，才能正确完成业务。角色并不能满足用户对精细化授权的要求，无法完全达到企业对权限最小化的安全管控要求。 策略：IAM最新提供的一种细粒度授权的能力，可以精确到具体服务的操作、资源以及请求条件等。基于策略的授权是一种更加灵活的授权方式，能够满足企业对权限最小化的安全管控要求。例如：针对DEW服务，KMS管理员能够控制IAM用户仅能对某一类云服务器资源进行指定的管理操作。多数细粒度策略以API接口为粒度进行权限拆分，权限的最小粒度为API授权项（action）。DEW支持的API授权项请参见DEW权限及授权项。 如表 KMS系统策略、表 KPS系统策略、表 C SMS 系统策略所示，包括了DEW的所有系统权限。 表1 KMS系统策略 系统角色/策略名称 描述 类别 依赖关系 KMS Administrator 密钥管理服务(KMS)管理员，拥有该服务下的所有权限。 系统角色 无 KMS CMKFullAccess 密钥管理服务(KMS)的加密密钥所有权限。拥有该权限的用户可以完成基于策略授权的所有操作。 系统策略 无 KMS CMKReadOnlyAccess 密钥管理服务(KMS)的加密密钥只读权限。拥有该权限的用户可以完成基于策略授权的所有操作。 系统策略 无 表2 KPS系统策略 系统角色/策略名称 描述 类别 依赖关系 DEW KeypairFullAccess 数据加密 服务中密钥对管理服务(KPS)的所有权限。拥有该权限的用户可以完成基于策略授权的所有操作。 系统策略 无 DEW KeypairReadOnlyAccess 数据加密服务中密钥对管理服务(KPS)的查看权限。拥有该权限的用户仅能查看密钥对管理服务(KPS)数据。 系统策略 无 表3 CSMS系统策略 系统角色/策略名称 描述 类别 依赖关系 CSMS FullAccess 数据加密服务中凭据管理服务(CSMS)的所有权限。拥有该权限的用户可以完成基于策略授权的所有操作。 系统策略 无 CSMS ReadOnlyAccess 数据加密服务中凭据管理服务(CSMS)的只读权限。拥有该权限的用户可以完成基于策略授权的所有操作。 系统策略 无 密钥对不支持企业项目授权，DEW KeypairFullAccess、DEW KeypairReadOnlyAccess策略不能用于企业项目授权。 表4列出了DEW常用操作与系统权限的授权关系，您可以参照该表选择合适的系统权限。 表4 常用操作与KMS系统权限的关系 操作 KMS Administrator KMS CMKFullAccess 创建密钥 √ √ 启用密钥 √ √ 禁用密钥 √ √ 计划删除密钥 √ √ 取消计划删除密钥 √ √ 修改密钥别名 √ √ 修改密钥描述 √ √ 创建随机数 √ √ 创建数据密钥 √ √ 创建不含明文数据密钥 √ √ 加密数据密钥 √ √ 解密数据密钥 √ √ 获取密钥导入参数 √ √ 导入密钥材料 √ √ 删除密钥材料 √ √ 创建授权 √ √ 撤销授权 √ √ 退役授权 √ √ 查询授权列表 √ √ 查询可退役授权列表 √ √ 加密数据 √ √ 解密数据 √ √ 签名消息 √ √ 验证签名 √ √ 开启密钥轮换 √ √ 修改密钥轮换周期 √ √ 关闭密钥轮换 √ √ 查询密钥轮换状态 √ √ 查询密钥实例 √ √ 查询密钥标签 √ √ 查询项目标签 √ √ 批量添加删除密钥标签 √ √ 添加密钥标签 √ √ 删除密钥标签 √ √ 查询密钥列表 √ √ 查询密钥信息 √ √ 查询公钥信息 √ √ 查询实例数 √ √ 查询配额 √ √ 查询密钥对列表 x x 创建或导入密钥对 x x 查询密钥对 x x 删除密钥对 x x 更新密钥对描述 x x 绑定密钥对 x x 解绑密钥对 x x 查询绑定任务信息 x x 查询失败的任务 x x 删除所有失败的任务 x x 删除失败的任务 x x 查询正在处理的任务 x x

监控指标 表1 弹性公网IP和带宽支持的监控指标 指标ID 指标名称 指标含义 取值范围 单位 进制 测量对象（维度） 监控周期（原始指标） upstream_bandwidth 出网带宽 该指标用于统计测试对象出云平台的网络速度（原指标为上行带宽）。 ≥ 0 bit/s 1000(SI) 带宽或弹性公网IP 1分钟 downstream_bandwidth 入网带宽 该指标用于统计测试对象入云平台的网络速度（原指标为下行带宽）。 ≥ 0 bit/s 1000(SI) 带宽或弹性公网IP 1分钟 upstream_bandwidth_usage 出网带宽使用率 该指标用于统计测量对象出云平台的带宽使用率，以百分比为单位。 出网带宽使用率=出网带宽指标/购买的带宽大小 0-100 % 不涉及 带宽或弹性公网IP 1分钟 downstream_bandwidth_usage 入网带宽使用率 该指标用于统计测量对象入云平台的带宽使用率，以百分比为单位。 入网带宽使用率=入网带宽指标/购买的带宽大小 0-100 % 不涉及 带宽或弹性公网IP 1分钟 up_stream 出网流量 该指标用于统计测试对象出云平台一分钟内的网络流量累加值（原指标为上行流量）。 ≥ 0 Byte 1000(SI) 带宽或弹性公网IP 1分钟 down_stream 入网流量 该指标用于统计测试对象入云平台一分钟内的网络流量累加值（原指标为下行流量）。 ≥ 0 Byte 1000(SI) 带宽或弹性公网IP 1分钟

响应示例 { "subnet": { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" } }

响应示例 { "port": { "id": "7204e0da-40de-4207-a536-6f59b84f6f0e", "name": "abc", "status": "DOWN", "admin_state_up": "true", "fixed_ips": [ { "subnet_id": "689156ca-038f-4478-b265-fd26aa8bbe31", "ip_address": "192.168.0.9" } ], "mac_address": "fa:16:3e:d7:f2:6c", "network_id": "b4152e98-e3af-4e49-bb7f-7766e2b5ec63", "tenant_id": "caa6cf4337ea47fb823b15709ebe8591", "device_id": "", "device_owner": "", "security_groups": [ "59b39002-e79b-4bac-8e27-aa884ab1beb6" ], "extra_dhcp_opts": [], "allowed_address_pairs": [], "binding:vnic_type": "normal", "enable_efi": false } }

响应参数 表5 响应参数 名称 参数类型 说明 port port object 端口对象，请参见表6。 表6 port字段说明 名称 参数类型 说明 id String 端口唯一标识。 name String 功能说明：端口名称。 取值：默认为空，最大长度不超过255。 network_id String 功能说明：端口所属网络的ID。 约束：必须是存在的网络ID。 说明： 网络ID的获取方式： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表 admin_state_up Boolean 功能说明：管理状态。 约束：默认为true。 mac_address String 功能说明：端口MAC地址。 约束：由系统分配，不支持指定。 fixed_ips Array of fixed_ip objects 功能说明：端口IP，请参见表7。例如："fixed_ips": [{"subnet_id": "4dc70db6-cb7f-4200-9790-a6a910776bba", "ip_address": "192.169.25.79"}]。 约束：ipv4场景下，一个端口只支持一个fixed_ip，且不支持更新。ipv6场景下，一个端口最多可以支持两个fixed_ip，且不支持更新。 device_id String 功能说明：端口所属设备ID。 约束：不支持设置和更新，由系统自动维护。 device_owner String 功能说明：设备所属（DHCP/Router/ lb/Nova）。 取值范围：network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway，network:ucmp。 使用说明：不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。 tenant_id String 项目ID。 status String 功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN。 取值范围：ACTIVE、BUILD、DOWN。 security_groups Array of strings 安全组的UUID(扩展属性)。 allowed_address_pairs Array of allowed_address_pairs objects 功能说明：IP/Mac对列表，请参见表8。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 如果allowed_address_pairs回显值为云服务器网卡IP地址，表示虚拟IP的端口处于绑定状态。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表9。 binding:vif_details binding:vif_details object vif的详细信息，参见表10。 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功能不生效。 仅对于“华北-北京二”区域：udp_srvports和tcp_srvports，字段，字符串类型，默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号，表示这些端口的tcp报文和udp报文可支持高并发连接，但是此类报文不受ACL和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。 格式： {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} 端口号之间以空格间隔，最多允许指定的端口号总共为15个，端口号范围是1到65535。 示例： {"tcp_srvports": "80 443", "udp_srvports": "53"} 示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受ACL和安全组规则的限制。 binding:vnic_type String 功能说明：绑定的vNIC类型。 取值范围：normal，软交换；direct，SRIOV硬直通（不支持）。 dns_assignment Array of dns_assignment objects 功能说明：主网卡默认内网 域名 信息。 约束：不支持设置和更新，由系统自动维护。 dns_name String 功能说明：主网卡默认内网DNS名称。 约束：不支持设置和更新，由系统自动维护。 instance_id String 功能说明：端口所属实例ID，例如RDS实例ID。 约束：不支持设置和更新，由系统自动维护。 instance_type String 功能说明：端口所属实例类型，例如“RDS”。 约束：不支持设置和更新，由系统自动维护。 port_security_enabled Boolean 功能说明：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效。 zone_id String 端口所属的可用分区。 enable_efi Boolean 功能说明：是否使能efi，使能则表示端口支持vRoCE能力，默认为false。 ipv6_bandwidth_id String 功能说明：IPv6网卡绑定的共享带宽ID。 约束：只有IPv6网卡绑定了共享带宽，才会显示此参数。 表7 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明：所属子网ID。 如果您使用管理控制台，此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。 约束：不支持更新。 ip_address String 端口IP地址。 表8 allowed_address_pairs对象 名称 参数类型 说明 ip_address String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 mac_address String MAC地址。默认使用本端口的MAC地址。 表9 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String DHCP选项名称，目前仅支持填写“51”，表示IPv4网卡DHCP租约时间；填写“651”，表示IPv6网卡DHCP租约时间。 opt_value String 功能说明：DHCP选项的值。 当“opt_name”为“51”或“651”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~175200或“-1”，“-1”表示DHCP租约时间无限长。 表10 binding:vif_details对象 名称 参数类型 说明 primary_interface Boolean 取值为true，表示是虚拟机的主网卡。 port_filter Boolean 表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。 ovs_hybrid_plug Boolean 用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。 表11 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。

请求参数 名称 是否必选 参数类型 说明 port 是 port object 端口对象，请参见表2。 更新操作时至少指定一项属性。 表2 port字段说明 名称 是否必选 参数类型 说明 name 否 String 功能说明：端口名称。 取值范围：默认为空，最大长度不超过255。 security_groups 否 Array of strings 扩展属性：安全组的UUID。 约束：不支持更新为空。 allowed_address_pairs 否 Array of allowed_address_pairs objects 功能说明：IP/Mac对列表，allow_address_pair参见表3。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 为虚拟IP配置后端ECS场景，allowed_address_pairs中配置的IP地址，必须为ECS网卡已有的IP地址，否则可能会导致虚拟IP通信异常。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 extra_dhcp_opts 否 Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表4。 表3 allowed_address_pairs对象 名称 是否必选 参数类型 说明 ip_address 是 String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 如果填写allowed_address_pairs参数，则ip_address是必选参数。 mac_address 否 String MAC地址。默认使用当前端口的MAC地址。 表4 extra_dhcp_opt对象 名称 是否必选 参数类型 说明 opt_name 否 String DHCP选项名称，目前仅支持填写“51”，表示IPv4网卡DHCP租约时间；填写“651”，表示IPv6网卡DHCP租约时间。 opt_value 否 String 功能说明：DHCP选项的值。 当“opt_name”为“51”或“651”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~175200或“-1”，“-1”表示DHCP租约时间无限长。

响应示例 { "subnets": [ { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" }, { "opt_value": "2h", "opt_name": "ipv6_addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" }, { "id": "531dec0f-3116-411b-a21b-e612e42349fd", "name": "Subnet1", "description": "", "cidr": "192.168.1.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "ACTIVE", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.1.1", "ipv6_enable": false, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "531dec0f-3116-411b-a21b-e612e42349fd", "neutron_subnet_id": "1aac193-a2ad-f153-d122-12d64c2c1d78", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T03:41:22", "updated_at": "2022-12-15T03:41:22" } ] }

URI GET /v1/{project_id}/subnets 样例： GET https://{Endpoint}/v1/{project_id}/subnets?limit=10&marker=4779ab1c-7c1a-44b1-a02e-93dfc361b32d&vpc_id=3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID，获取项目ID请参见获取项目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的参数说明。 vpc_id 否 String 按照子网所在VPC ID过滤查询。 企业项目细粒度授权场景下，该字段必传。

响应示例 { "port": { "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_name": "", "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", "instance_type": "RDS", "instance_id": "03a4e9ee-64eb-4a31-802e-5490df22146c", "enable_efi": false } }

响应参数 表2 响应参数 名称 参数类型 说明 port port object 端口对象，请参见表3。 表3 port字段说明 名称 参数类型 说明 id String 端口唯一标识。 name String 功能说明：端口名称。 取值：默认为空，最大长度不超过255。 network_id String 功能说明：端口所属网络的ID。 约束：必须是存在的网络ID。 说明： 网络ID的获取方式： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 admin_state_up Boolean 功能说明：管理状态。 约束：默认为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对象。 约束：ipv4场景下，一个端口只支持一个fixed_ip，且不支持更新。ipv6场景下，一个端口最多可以支持两个fixed_ip，且不支持更新。 device_id String 功能说明：端口所属设备ID。 约束：不支持设置和更新，由系统自动维护。 device_owner String 功能说明：设备所属（DHCP/Router/ lb/Nova）。 取值范围：network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway，network:ucmp。 使用说明：不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。 tenant_id String 项目ID。 status String 功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN。 取值范围：ACTIVE、BUILD、DOWN。 如果allowed_address_pairs回显值为云服务器网卡IP地址，表示虚拟IP的端口处于绑定状态。 security_groups Array of strings 安全组的UUID(扩展属性)。 allowed_address_pairs Array of allowed_address_pairs objects 功能说明：IP/Mac对列表。请参见表5 allow_address_pair对象。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表6 extra_dhcp_opt对象。 binding:vif_details binding:vif_details object vif的详细信息，参见表7。 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功能不生效。 仅对于“华北-北京二”区域：udp_srvports和tcp_srvports，字段，字符串类型，默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号，表示这些端口的tcp报文和udp报文可支持高并发连接，但是此类报文不受ACL和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。 格式： {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} 端口号之间以空格间隔，最多允许指定的端口号总共为15个，端口号范围是1到65535。 示例： {"tcp_srvports": "80 443", "udp_srvports": "53"} 示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受ACL和安全组规则的限制。 binding:vnic_type String 功能说明：绑定的vNIC类型。 取值范围：normal或者direct。 normal: 软交换direct: SRIOV硬直通（不支持）。 dns_assignment Array of dns_assignment objects 功能说明：主网卡默认内网域名信息。 约束：不支持设置和更新，由系统自动维护。 dns_name String 功能说明：主网卡默认内网DNS名称。 约束：不支持设置和更新，由系统自动维护。 instance_id String 功能说明：端口所属实例ID，例如RDS实例ID。 约束：不支持设置和更新，由系统自动维护。 instance_type String 功能说明：端口所属实例类型，例如“RDS”。 约束：不支持设置和更新，由系统自动维护。 port_security_enabled Boolean 功能说明：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效。 zone_id String 端口所属的可用分区。 enable_efi Boolean 功能说明：是否使能efi，使能则表示端口支持vRoCE能力，默认为false。 ipv6_bandwidth_id String 功能说明：IPv6网卡绑定的共享带宽ID。 约束：只有IPv6网卡绑定了共享带宽，才会显示此参数。 表4 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明：所属子网ID。 如果您使用管理控制台，此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。 约束：不支持更新。 ip_address String 端口IP地址。 表5 allowed_address_pairs对象 名称 参数类型 说明 ip_address String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 mac_address String MAC地址。默认使用本端口的MAC地址。 表6 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String DHCP选项名称，目前仅支持填写“51”，表示IPv4网卡DHCP租约时间；填写“651”，表示IPv6网卡DHCP租约时间。 opt_value String 功能说明：DHCP选项的值。 当“opt_name”为“51”或“651”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~175200或“-1”，“-1”表示DHCP租约时间无限长。 表7 binding:vif_details对象 名称 参数类型 说明 primary_interface Boolean 取值为true，表示是虚拟机的主网卡。 port_filter Boolean 表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。 ovs_hybrid_plug Boolean 用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。 表8 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。

响应示例 { "port": { "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_name": "", "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", "enable_efi": false } }

响应参数 表7 响应参数 名称 参数类型 说明 port port object 端口对象，请参见表8。 表8 port字段说明 名称 参数类型 说明 id String 端口唯一标识。 name String 功能说明：端口名称。 取值范围：默认为空，最大长度不超过255。 network_id String 功能说明：端口所属网络的ID。 约束：必须是存在的网络ID。 说明： 网络ID的获取方式： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表 admin_state_up Boolean 功能说明：管理状态。 约束：默认为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"}]，请参见表9。 约束：ipv4场景下，一个端口只支持一个fixed_ip，且不支持更新。ipv6场景下，一个端口最多可以支持两个fixed_ip，且不支持更新。 device_id String 功能说明：端口所属设备ID。 约束：不支持设置和更新，由系统自动维护。 device_owner String 功能说明：设备所属（DHCP/Router/ lb/Nova）。 取值范围：network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway，network:ucmp。 使用说明：不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。 tenant_id String 项目ID。 status String 功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN。 取值范围：ACTIVE、BUILD、DOWN。 security_groups Array of strings 安全组的UUID(扩展属性)。 allowed_address_pairs Array of allowed_address_pairs objects 功能说明：IP/Mac对列表。请参见表10。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 如果allowed_address_pairs回显值为云服务器网卡IP地址，表示虚拟IP的端口处于绑定状态。 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表11。 binding:vif_details binding:vif_details object vif的详细信息，参见表12。 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功能不生效。 仅对于“华北-北京二”区域：udp_srvports和tcp_srvports，字段，字符串类型，默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号，表示这些端口的tcp报文和udp报文可支持高并发连接，但是此类报文不受ACL和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。 格式： {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} 端口号之间以空格间隔，最多允许指定的端口号总共为15个，端口号范围是1到65535。 示例： {"tcp_srvports": "80 443", "udp_srvports": "53"} 示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受ACL和安全组规则的限制。 binding:vnic_type String 功能说明：绑定的vNIC类型。 取值范围：normal，软交换；direct，SRIOV硬直通（不支持）。 dns_assignment Array of dns_assignment objects 功能说明：主网卡默认内网域名信息。 约束：不支持设置和更新，由系统自动维护。 dns_name String 功能说明：主网卡默认内网DNS名称。 约束：不支持设置和更新，由系统自动维护。 instance_id String 功能说明：端口所属实例ID，例如RDS实例ID。 约束：不支持设置和更新，由系统自动维护。 instance_type String 功能说明：端口所属实例类型，例如“RDS”。 约束：不支持设置和更新，由系统自动维护。 port_security_enabled Boolean 功能说明：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效。 zone_id String 端口所属的可用分区。 enable_efi Boolean 功能说明：是否使能efi，使能则表示端口支持vRoCE能力，默认为false。 ipv6_bandwidth_id String 功能说明：IPv6网卡绑定的共享带宽ID。 约束：只有IPv6网卡绑定了共享带宽，才会显示此参数。 表9 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明：所属子网ID。 如果您使用管理控制台，此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。 约束：不支持更新。 ip_address String 端口IP地址。 表10 allowed_address_pairs对象 名称 参数类型 说明 ip_address String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 mac_address String MAC地址。默认使用本端口的MAC地址。 表11 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String DHCP选项名称，目前仅支持填写“51”，表示IPv4网卡DHCP租约时间；填写“651”，表示IPv6网卡DHCP租约时间。 opt_value String 功能说明：DHCP选项的值。 当“opt_name”为“51”或“651”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~175200或“-1”，“-1”表示DHCP租约时间无限长。 表12 binding:vif_details对象 名称 参数类型 说明 primary_interface Boolean 取值为true，表示是虚拟机的主网卡。 port_filter Boolean 表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。 ovs_hybrid_plug Boolean 用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。 表13 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。

请求示例 创建一个端口，所在network id为28a1c93c-9a5e-4a9f-813b-e495bdef7d34，指定子网id为06bc2359-d75e-4f96-82f4-313e39c7148c，指定IP地址为192.168.0.38，关联安全组f2c5b3fc-b971-4a86-87b9-032586260e3e。 POST https://{Endpoint}/v1/{project_id}/ports { "port": { "fixed_ips": [ { "ip_address": "192.168.0.38", "subnet_id": "06bc2359-d75e-4f96-82f4-313e39c7148c" } ], "network_id": "28a1c93c-9a5e-4a9f-813b-e495bdef7d34", "security_groups": [ "f2c5b3fc-b971-4a86-87b9-032586260e3e" ] } }

请求参数 表2 请求参数 名称 是否必选 参数类型 说明 port 是 port object 端口对象，请参见表3。 表3 port字段说明 名称 是否必选 参数类型 说明 name 否 String 功能说明：端口名称。 取值范围：默认为空，最大长度不超过255。 network_id 是 String 功能说明：端口所属网络的ID。 约束：必须是存在的网络ID。 说明： 网络ID的获取方式： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表 admin_state_up 否 Boolean 功能说明：管理状态。 约束：默认为true。 device_owner 否 String 功能说明：端口设备所属。 取值范围：目前只支持指定""和"neutron:VIP_PORT"，neutron:VIP_PORT表示创建的是VIP。 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，且不支持更新。 tenant_id 否 String 项目ID。 security_groups 否 Array of strings 安全组的UUID，例如："security_groups": ["a0608cbf-d047-4f54-8b28-cd7b59853fff"](扩展属性)。 allowed_address_pairs 否 Array of allowed_address_pairs objects 功能说明：IP/Mac对列表，allowed_address_pair参见表5(扩展属性)。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 如果虚拟IP绑定云服务器资源， 则mac_address可为空或者填写被绑定云服务器网卡的Mac地址。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 extra_dhcp_opts 否 Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表6。 表4 fixed_ip对象 名称 是否必选 参数类型 说明 subnet_id 否 String 功能说明：所属子网ID。 如果您使用管理控制台，此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。 约束：不支持更新。 ip_address 否 String 功能说明：端口IP地址。 约束：不支持更新。 表5 allowed_address_pairs对象 名称 是否必选 参数类型 说明 ip_address 是 String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 如果填写allowed_address_pairs参数，则ip_address是必选参数。 mac_address 否 String MAC地址。默认使用当前端口的MAC地址。 表6 extra_dhcp_opt对象 名称 是否必选 参数类型 说明 opt_name 否 String DHCP选项名称，目前仅支持填写“51”，表示IPv4网卡DHCP租约时间；填写“651”，表示IPv6网卡DHCP租约时间。 opt_value 否 String 功能说明：DHCP选项的值。 当“opt_name”为“51”或“651”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~175200或“-1”，“-1”表示DHCP租约时间无限长。

响应参数 表5 响应参数 名称 参数类型 说明 subnet subnet object subnet对象 表6 subnet对象 名称 参数类型 说明 id String uuid形式的一个资源标识。 status String 功能说明：子网的状态。 取值范围：ACTIVE,UNKNOWN,ERROR ACTIVE表示子网已挂载到VPC上 UNKNOWN表示子网还未挂载到VPC上 ERROR表示子网状态故障

请求示例 更新id为4779ab1c-7c1a-44b1-a02e-93dfc361b32d的子网，名称更新为subnet02，更新dns和dhcp。 PUT https://{Endpoint}/v1/{project_id}/vpcs/{vpc_id}/subnets/4779ab1c-7c1a-44b1-a02e-93dfc361b32d { "subnet": { "name": "subnet02", "ipv6_enable": true, "dhcp_enable": false, "primary_dns": "114.xx.xx.115", "secondary_dns": "114.xx.xx.116", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" }, { "opt_value": "2h", "opt_name": "ipv6_addresstime" } ] } }

响应示例 { "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_name": "", "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", "instance_type": "RDS", "instance_id": "03a4e9ee-64eb-4a31-802e-5490df22146c", "enable_efi": false }, { "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_name": "", "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", "enable_efi": false } ] }

响应参数 表2 响应参数 名称 参数类型 说明 ports Array of port objects 端口列表对象，请参见表3。 表3 port字段说明 名称 参数类型 说明 id String 端口唯一标识。 name String 功能说明：端口名称。 取值：默认为空，最大长度不超过255。 network_id String 功能说明：端口所属网络的ID。 约束：必须是存在的网络ID。 说明： 网络ID的获取方式： 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考查询子网列表。 admin_state_up Boolean 功能说明：管理状态。 约束：默认为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。 约束：ipv4场景下，一个端口只支持一个fixed_ip，且不支持更新。ipv6场景下，一个端口最多可以支持两个fixed_ip，且不支持更新。 device_id String 功能说明：端口所属设备ID。 约束：不支持设置和更新，由系统自动维护。 device_owner String 功能说明：设备所属（DHCP/Router/ lb/Nova）。 取值范围：network:dhcp，network:router_interface_distributed，compute:xxx(xxx对应具体的可用区名称，例如compute:aa-bb-cc表示是被可用区aa-bb-cc上的ECS使用)，neutron:VIP_PORT，neutron:LOADBALANCERV2，neutron:LOADBALANCERV3，network:endpoint_interface，network:nat_gateway，network:ucmp。 使用说明：不支持更新，只允许用户在创建虚拟IP端口时，为虚拟IP端口设置device_owner为neutron:VIP_PORT，当端口的该字段不为空时，仅支持该字段为neutron:VIP_PORT时的端口删除。 tenant_id String 项目ID。 status String 功能说明：端口状态，Hana硬直通虚拟机端口状态总为DOWN。 取值范围：ACTIVE、BUILD、DOWN。 security_groups Array of strings 安全组的UUID(扩展属性)。 allowed_address_pairs Array of allowed_address_pairs objects 功能说明：IP/Mac对列表。请参见表5。 约束：IP地址不允许为 “0.0.0.0/0”。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 如果allowed_address_pairs回显值为云服务器网卡IP地址，表示虚拟IP的端口处于绑定状态。 extra_dhcp_opts Array of extra_dhcp_opt objects DHCP的扩展Option(扩展属性)，请参见表6。 binding:vif_details binding:vif_details object vif的详细信息，参见表7。 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功能不生效。 仅对于“华北-北京二”区域：udp_srvports和tcp_srvports，字段，字符串类型，默认不设置udp_srvports和tcp_srvports字段。允许指定udp_srvports和tcp_srvports字段为端口号，表示这些端口的tcp报文和udp报文可支持高并发连接，但是此类报文不受ACL和安全组规则的限制。udp_srvports和tcp_srvports字段同时支持更新操作。 格式： {"tcp_srvports": "port1 port2 port3", "udp_srvports": "port1 port2 port3"} 端口号之间以空格间隔，最多允许指定的端口号总共为15个，端口号范围是1到65535。 示例： {"tcp_srvports": "80 443", "udp_srvports": "53"} 示例表示入方向目的端口为80或者443的tcp报文可支持高并发连接。入方向目的端口为53的udp报文可支持高并发连接。但是此类报文不受ACL和安全组规则的限制。 binding:vnic_type String 功能说明：绑定的vNIC类型。 取值范围：normal，软交换；direct，SRIOV硬直通（不支持）。 dns_assignment Array of dns_assignment objects 功能说明：主网卡默认内网域名信息。 约束：不支持设置和更新，由系统自动维护。 dns_name String 功能说明：主网卡默认内网DNS名称。 约束：不支持设置和更新，由系统自动维护。 instance_id String 功能说明：端口所属实例ID，例如RDS实例ID。 约束：不支持设置和更新，由系统自动维护。 instance_type String 功能说明：端口所属实例类型，例如“RDS”。 约束：不支持设置和更新，由系统自动维护。 port_security_enabled Boolean 功能说明：端口安全使能标记，如果不使能则安全组和dhcp防欺骗不生效。 zone_id String 端口所属的可用分区。 enable_efi Boolean 功能说明：是否使能efi，使能则表示端口支持vRoCE能力，默认为false。 ipv6_bandwidth_id String 功能说明：IPv6网卡绑定的共享带宽ID。 约束：只有IPv6网卡绑定了共享带宽，才会显示此参数。 表4 fixed_ip对象 名称 参数类型 说明 subnet_id String 功能说明：所属子网ID。 如果您使用管理控制台，此值即为子网详情中的“IPv4子网ID”或“IPv6子网ID”参数值。 约束：不支持更新。 ip_address String 端口IP地址。 表5 allowed_address_pairs对象 名称 参数类型 说明 ip_address String 功能说明：IP地址。 约束：不支持0.0.0.0/0。 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目的地址检查开关。 被绑定的云服务器网卡allowed_address_pairs的IP地址填“1.1.1.1/0”。 mac_address String MAC地址。默认使用本端口的MAC地址。 表6 extra_dhcp_opt对象 名称 参数类型 说明 opt_name String DHCP选项名称，目前仅支持填写“51”，表示IPv4网卡DHCP租约时间；填写“651”，表示IPv6网卡DHCP租约时间。 opt_value String 功能说明：DHCP选项的值。 当“opt_name”为“51”或“651”时，参数格式为“Xh”，表示DHCP租约时间为X小时。 “X”的取值范围为1~175200或“-1”，“-1”表示DHCP租约时间无限长。 表7 binding:vif_details对象 名称 参数类型 说明 primary_interface Boolean 取值为true，表示是虚拟机的主网卡。 port_filter Boolean 表示该网络服务提供端口过滤特性，如安全组和反MAC/IP欺骗。 ovs_hybrid_plug Boolean 用于通知像nova这样的API消费者，应该使用OVS的混合插入策略。 表8 dns_assignment对象 名称 参数类型 说明 hostname String 端口hostname。 ip_address String 端口IP地址。 fqdn String 端口内网fqdn。

URI GET /v1/{project_id}/ports 样例 GET https://{Endpoint}/v1/{project_id}/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}&limit=10&marker={marker} 参数说明请参见表1。 表1 参数说明 名称 是否必选 参数类型 说明 project_id 是 String 项目ID，请参见获取项目ID。 id 否 String 功能说明：按照端口ID过滤查询。 name 否 String 功能说明：按照端口名称过滤查询。 取值范围：最大长度不超过255。 admin_state_up 否 Boolean 功能说明：按照管理状态过滤查询。 取值范围：true、false network_id 否 String 功能说明：按照端口所属网络的ID过滤查询。 mac_address 否 String 功能说明：按照端口MAC地址过滤查询。 device_id 否 String 功能说明：按照端口所属设备ID过滤查询。 device_owner 否 String 功能说明：按照端口所属设备过滤查询。 取值范围：请参见表3中的device_owner参数。 status 否 String 功能说明：按照端口状态过滤查询。 取值范围：ACTIVE、BUILD、DOWN。 security_groups 否 Array of strings 功能说明：按照安全组UUID列表过滤查询。 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 否 Array of strings 功能说明：按照端口IP地址或者端口所属子网ID过滤查询。 取值范围：fixed_ips=ip_address={ip_address}，fixed_ips=subnet_id={subnet_id}，其中{ip_address}填ip地址，如192.168.21.22；{subnet_id}填IPv4子网或IPv6子网的ID，如011fc878-5521-4654-a1ad-f5b0b5820302。 enterprise_project_id 否 String 功能说明：按照企业项目ID过滤查询。 取值范围：最大长度36字节，带“-”连字符的UUID格式，或者是字符串“0”。“0”表示默认企业项目。若需要查询当前用户所有企业项目绑定的端口，请传参all_granted_eps。 说明： 关于企业项目ID的获取及企业项目特性的详细信息，请参见《企业管理用户指南》。 enable_efi 否 Boolean 功能说明：按照端口是否使能efi过滤查询。 取值范围：true、false。

响应示例 { "subnet": { "id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "status": "UNKNOWN", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "cidr_v6": "2001:db8:a583::/64", "gateway_ip_v6": "2001:db8:a583::1", "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "availability_zone": "aa-bb-cc", "neutron_network_id": "4779ab1c-7c1a-44b1-a02e-93dfc361b32d", "neutron_subnet_id": "213cb9d-3122-2ac1-1a29-91ffc1231a12", "neutron_subnet_id_v6": "e0fa7de1-a6e2-44c9-b052-b9d8cebe93c4", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" }, { "opt_value": "2h", "opt_name": "ipv6_addresstime" } ], "tenant_id": "087679f0aa80d32a2f4ec0172f5e902b", "created_at": "2022-12-15T02:42:07", "updated_at": "2022-12-15T02:42:07" } }

请求示例 创建一个子网，所在vpc的id为3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85，命名为subent，设置cidr为192.168.20.0/24，网关IP为192.168.20.1。 POST https://{Endpoint}/v1/{project_id}/subnets { "subnet": { "name": "subnet", "description": "", "cidr": "192.168.20.0/24", "gateway_ip": "192.168.20.1", "ipv6_enable": true, "dhcp_enable": true, "primary_dns": "114.xx.xx.114", "secondary_dns": "114.xx.xx.115", "dnsList": [ "114.xx.xx.114", "114.xx.xx.115" ], "availability_zone": "aa-bb-cc", "vpc_id": "3ec3b33f-ac1c-4630-ad1c-7dba1ed79d85", "extra_dhcp_opts": [ { "opt_value": "10.100.0.33,10.100.0.34", "opt_name": "ntp" }, { "opt_value": "24h", "opt_name": "addresstime" }, { "opt_value": "2h", "opt_name": "ipv6_addresstime" } ] } }