华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 部署计划列表的总和。 deployments Array of Deployment objects 部署计划列表。 表4 Deployment 参数 参数类型 描述 id String 部署计划ID。 distribution Array of Distribution objects 部署位置信息列表 edgecloud DeploymentEdgecloud object 待部署的边缘业务。 表5 Distribution 参数 参数类型 描述 area String 所在大区名称。 city String 所在城市名称。 operator String 所属运营商名称。 province String 所属省份名称。 site_id String 站点ID。 pool_id String 线路ID。多线路场景下，将在该线路下创建弹性公网IP。 stack_count Integer 资源组配置模板数目 city_short_name String 城市简称。 ipv6_enable Boolean 创建边缘实例是否开启IPv6。 ipv6_bandwidth_enable Boolean 创建IPv6边缘实例是否支持公网访问。 pool_id_v6 String IPv6线路ID。IPv6场景下，使用该线路下的子网分配IPv6端口。 表6 DeploymentEdgecloud 参数 参数类型 描述 id String 边缘业务ID。 name String 边缘业务名称。 stacks Stack object 边缘业务资源组。 description String 边缘业务描述，最大支持255字节。 coverage Coverage object 边缘业务覆盖策略。 表7 Stack 参数 参数类型 描述 name String 边缘资源组名称。 取值范围：只能由中文字符、大小写英文字母、数字及中划线、下划线组成，且长度为[1-48]个字符。 最小长度：1 最大长度：48 resources Array of Resource objects 边缘业务的堆栈，即为资源组。 表8 Resource 参数 参数类型 描述 name String 边缘实例名称。 取值范围： 只能由中文字符、英文字母 (大小写)、数字及“_”、“-”、“.” 组成。 创建的边缘实例数量（count字段对应的值）大于1时，为区分不同边缘实例，创建过程中系统会自动在名称后加“-000x”的类似标记。 说明： 华为云边缘实例内部主机名 （hostname）命名规则遵循RFC 952和RFC 1123命名规范，建议使用a-zA-z或0-9以及中划线'-'组成的名称命名，' _' 将在边缘实例内部默认转化为'-'。 最小长度：1 最大长度：48 with_prefix Boolean 是否自动添加名称前缀。 with_prefix为false时不拼接IEC前缀 with_prefix不传或者传true时拼自动IEC前缀 以name为iec为例： 不添加前缀时实例名称为：iec-0001 自动添加前缀实例名称为：IEC-ZS01-iec-0001 0001为创建边缘业务时根据实例个数自动添加的编号 缺省值：true image_ref String 待发放边缘实例的系统镜像，需要指定已创建镜像的ID。 说明： 镜像的ID可以从控制台或者参考本文档的“查询边镜像列表”的章节获取。 flavor_ref String 边缘实例的系统规格的ID。 admin_pass String 如果需要使用密码方式登录边缘实例，可使用admin_pass字段指定边缘实例管理员帐户初始登录密码。其中，Linux管理员帐户为root，Windows管理员帐户为Administrator。 密码复杂度要求： 长度为8-26位。 密码至少必须包含大写字母、小写字母、数字和特殊字符（!@$%^-_=+[{}]:,./?）中的三种。 密码不能包含用户名或用户名的逆序。 Windows系统密码不能包含用户名或用户名的逆序，不能包含用户名中超过两个连续字符的部分。 说明： 目前边缘实例不支持创建后设置密码，不设置此参数会导致实例无法登录。 最小长度：8 最大长度：26 key_name String 密钥对名称。 net_config NetConfig object 实例的边缘网络配置。 包含了边缘网络的网段信息和子网数目信息。 bandwidth BandwidthConfig object 实例的带宽参数。 IEC服务现在提供共享带宽服务，暂不支持其他类型带宽。 说明： 创建边缘业务时指定实例同步创建EIP则需通过此参数指定。 root_volume RootVolume object 边缘实例对应系统盘相关配置。 data_volumes Array of DataVolume objects 边缘实例对应数据盘相关配置。每一个数据结构代表一块待创建的数据盘。 约束：目前边缘实例最多可挂载2块数据盘 count Integer 边缘实例数量。 不传该字段时默认取值为1。 security_groups Array of SecurityGroupOption objects 边缘业务对应安全组信息。 user_data String 创建边缘实例过程中注入用户数据。支持注入文本、文本文件或gzip文件。 更多关于待注入用户数据的信息，请参见《弹性云服务器用户指南 》的“用户数据注入”章节。 表9 NetConfig 参数 参数类型 描述 vpc_id String 边缘网络ID。 约束： 创建边缘业务仅支持使用系统规划的虚拟私有云。 nic_num Integer 边缘实例绑定的网卡数量。 约束：一台边缘实例最少绑定一张网卡，最多绑定8张网卡。 最小值：1 最大值：8 allowed_address_pairs Array of AllowedAddressPair objects 功能说明：IP/Mac对列表 约束： IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs为“1.1.1.1/0”，表示关闭源目地址检查开关 表10 AllowedAddressPair 参数 参数类型 描述 ip_address String 功能说明：IP地址 约束： 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地址 表11 BandwidthConfig 参数 参数类型 描述 sharetype String 带宽类型，现支持WHOLE类型，即共享带宽，其他类型不支持。 size Integer 带宽（Mbit/s）。 表12 RootVolume 参数 参数类型 描述 size Integer 系统盘大小，容量单位为GB，输入大小范围为[40,100]。 最小值：40 最大值：100 volume_type String 边缘实例系统盘对应的磁盘类型，需要与站点所提供的磁盘类型相匹配。 表13 DataVolume 参数 参数类型 描述 size Integer 数据盘大小，容量单位为GB，输入大小范围为[1,500]。 最小值：1 最大值：500 volume_type String 边缘实例数据盘对应的磁盘类型，需要与站点所提供的磁盘类型相匹配。 表14 SecurityGroupOption 参数 参数类型 描述 id String 边缘实例的安全组，会对边缘实例中配置的网卡生效。需要指定已有安全组的ID。不填写时选择默认安全组 表15 Coverage 参数 参数类型 描述 coverage_policy String 区域调度策略，只支持centralize/discrete。 centralize：代表城市集中策略，指定该策略，边缘业务创建时会保证将所有实例都发放在同一个站点。 discrete：代表城市分散，指定该策略，边缘业务创建时，尽量保证所有实例都分散发放在不同站点。 coverage_level String 区域分布层级，只支持area/prov/city/site。 area:大区，用户的资源会在指定大区下发放。 prov:省份，用户的资源会在指定省份下发放。 city:城市，用户的资源会在指定城市下发放。 site:站点级别。 约束： 站点层级，coverage_policy上仅支持'centralize'，coverage_sites中'site'字段仅支持使用ID(站点ID，通过“查询边缘站点列表”获取)，不支持name。 coverage_sites Array of CoverageSite objects 区域及购买数量列表。 表16 CoverageSite 参数 参数类型 描述 site String 站点名称。 具体信息可通过调用“查询边缘站点列表”来查询(注意：本字段区分大小写)。 demands Array of Demand objects 租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。 表17 Demand 参数 参数类型 描述 operator String 所属运营商。 demand_count Integer 站点需要发放的资源(组)总数。 说明： 实际发放实例数量为count*demand_count。 最小值：1 最大值：10 pool_id String 弹性公网IP池。 多线路场景下，将在该弹性公网IP池下创建弹性公网IP。 说明： 覆盖规则为省级/大区时不支持指定线路ID创建边缘业务。 bandwidth_type String 带宽类型。 如果当前带宽类型下没有带宽，自动在该带宽类型下创建带宽 pool_id_v6 String 指定IPv6线路，使用该线路下的子网分配IPv6端口。 如果该线路下没有关联启用IPv6的子网，则创建新的子网。 ipv6_bandwidth_enable Boolean 使用IPv6带宽。 边缘实例是否开启IPv6公网访问能力。如果该IPv6线路没有可用的带宽，则创建新的带宽。 ipv6_bandwidth_type String 带宽类型。 边缘实例开启IPv6访问公网能力后，如果当前带宽类型下没有带宽，自动在该带宽类型下创建带宽

URI GET /v1/deployments 表1 Query参数 参数 是否必选 参数类型 描述 edgecloud_id 否 String 查询条件，边缘业务ID。 id 否 String 查询条件，部署计划ID。 limit 否 Integer 查询返回部署计划列表当前页面的数量。 最小值：0 最大值：1000 offset 否 Integer 偏移量。 当前偏移量，默认为0。 status 否 String 查询条件，部署计划状态，现只包含如下值： open:部署计划处于未执行状态，可执行部署计划进行部署 closed:部署计划已关闭，不可部署。

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 subnets Array of Subnet objects 子网数组。 count Integer 子网数目。 表4 Subnet 参数 参数类型 描述 id String 子网的ID。 name String 子网名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） cidr String 子网的网段 取值范围：必须在vpc对应cidr范围内 约束：必须是cidr格式。掩码长度不能大于28 dnsList Array of strings 子网dns服务器地址列表 gateway_ip String 子网的网关 取值范围：子网网段中的IP地址 约束：必须是ip格式 dhcp_enable Boolean 子网是否开启dhcp功能 primary_dns String 子网dns服务器地址1 secondary_dns String 子网dns服务器地址2 status String 子网的状态 取值范围： ACTIVE：表示子网已挂载到ROUTER上 UNKNOWN：表示子网还未挂载到ROUTER上 ERROR：表示子网状态故障 vpc_id String 虚拟私有云ID。 site_id String 子网所属的站点ID。 site_info String 子网所属的站点信息。 neutron_network_id String 对应网络（OpenStack Neutron接口） id。 neutron_subnet_id String 对应子网（OpenStack Neutron接口） id。 cidr_v6 String IPv6子网的网段，如果子网为IPv4子网，则不返回此参数 ipv6_enable Boolean 是否是IPv6子网 取值范围：true，false pool_id String IPv6线路ID，如果子网为IPv4子网，则不返回此参数。 neutron_subnet_id_v6 String 对应IPv6子网（OpenStack Neutron接口）id，如果子网为IPv4子网，则不返回此参数。 gateway_ip_v6 String IPv6子网的网关，如果子网为IPv4子网，则不返回此参数。

响应示例 状态码： 200 OK { "subnets" : [ { "id" : "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name" : "dc1_subnet_001", "cidr" : "172.168.1.0/24", "dnsList" : [ "10.2.3.21", "10.32.54.2" ], "gateway_ip" : "172.168.1.1", "dhcp_enable" : true, "primary_dns" : null, "secondary_dns" : null, "status" : "ACTIVE", "vpc_id" : "4a532e51-0649-41b1-b120-49c60c6b0638", "site_id" : "e3b52316-05be-11ea-bc35-286ed488d287", "site_info" : "中国/华中地区/湖北/武汉市", "neutron_network_id" : "e3b52316-05be-11ea-bc35-286ed488d287", "neutron_subnet_id" : "e3b52316-05be-11ea-bc35-286ed488d287" } ], "count" : 1 }

请求示例 在vpc id为af5b7439-5969-11eb-acfa-fa16408859a1的vpc下创建名为test1的自定义路由表 POST https://{{endpoint}}/v1/routetables { "routetable" : { "vpc_id" : "af5b7439-5969-11eb-acfa-fa16408859a1", "name" : "test1" } }

响应示例 状态码： 200 OK { "routetable" : { "id" : "b96df94c-7d3b-4e5f-8852-16646a27ef95", "name" : "test1", "vpc_id" : "af5b7439-5969-11eb-acfa-fa16408859a1", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "default" : false } }

请求示例 批量关闭边缘实例，请求参数必须以"os-stop"字段下发 POST https://{endpoint}/v1/cloudservers/action { "os-stop" : { "type" : "HARD", "servers" : [ { "id" : "cedd5deb-9386-4605-b2e3-2de387c39a80" }, { "id" : "28fddce3-3797-4a26-8145-abeb335c0abb" } ] } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 os-stop 否 BatchStop object 标记为关闭边缘实例操作。 表3 BatchStop 参数 是否必选 参数类型 描述 servers 是 Array of BaseId objects 待停止的边缘实例列表。 type 否 String 关机类型，默认为SOFT。 取值范围： SOFT：普通关机。 HARD：强制关机。 表4 BaseId 参数 是否必选 参数类型 描述 id 是 String 对象ID，uuid。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 vpc 否 UpdateVpcOption object 更新Vpc参数 表4 UpdateVpcOption 参数 是否必选 参数类型 描述 name 否 String 虚拟私有云名称 取值范围：0-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 约束：同一个帐号下的VPC不允许重名 cidr 否 String 虚拟私有云下可用子网的范围。 约束条件： SYSTEM模式，cidr取值范围：10.0.0.0/8~10.255.0.0/16或者172.16.0.0/12 ~ 172.31.0.0/16或者192.168.0.0/16 。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 vpc Vpc object 虚拟私有云。 表6 Vpc 参数 参数类型 描述 id String 虚拟私有云的ID。 name String 虚拟私有云名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 约束：同一个帐号下的名称不能重复 cidr String 虚拟私有云下可用子网的范围 取值范围： 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 约束：必须是cidr格式，例如:192.168.0.0/16 mode String 虚拟私有云的模式。 subnet_num Integer 子网的数目。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 firewall 是 UpdateFirewallOption object 更新网络ACL的参数。 表4 UpdateFirewallOption 参数 是否必选 参数类型 描述 name 是 String 网络ACL名称。更新时name不能为空。 中文字符、字母、数字、中划线和下划线组成，长度为1~64个字符 最小长度：1 最大长度：64 admin_state_up 否 Boolean 网络ACL的使能开关。 取值范围：true（开启），false（关闭） 缺省值：true description 否 String 网络ACL描述。 最小长度：0 最大长度：64 subnets 否 Array of FirewallSubnetOption objects 关联子网列表。 表5 FirewallSubnetOption 参数 是否必选 参数类型 描述 id 是 String 子网ID。 vpc_id 否 String 虚拟私有云ID。

请求示例 网路ACL关联子网2747a93b-192f-4397-9fd5-eb1af315eb69 PUT https://{endpoint}/v1/firewalls/c2c5234b-67ff-11ea-a41a-00e04c9bd2a3 { "firewall" : { "admin_state_up" : true, "description" : "test", "name" : "test", "subnets" : [ { "id" : "2747a93b-192f-4397-9fd5-eb1af315eb69", "vpc_id" : "872b0af3-6826-11ea-b42b-286ed488d287" } ] } }

响应示例 状态码： 200 OK { "id" : "633724a7-4a4e-11eb-8f73-fa1640aee23e", "name" : "ces", "status" : "active", "disk_format" : "zvhd2", "min_disk" : 40, "min_ram" : 0, "owner" : "2b76febbe5d34eac85d26435c1f15809", "protected" : false, "visibility" : "private", "created_at" : "2020-12-30T03:23:29Z", "updated_at" : "2020-12-30T03:30:36Z", "self" : "/v1/self/633724a7-4a4e-11eb-8f73-fa1640aee23e", "deleted" : false, "virtual_env_type" : "FusionCompute", "deleted_at" : "", "__imagetype" : "private", "__platform" : "CentOS", "__os_type" : "Linux", "__os_version" : "CentOS 7.4 64bit", "__isregistered" : true, "__support_arm" : "true", "hw_firmware_type" : "uefi", "data_source" : "instance:a7c6deda-99eb-4f58-b7b4-04a36b75401b", "__support_gpu_t4" : "true", "origin_region_info" : { "region_id" : "edgecloud1", "image_id" : "ea882319-3c1f-4296-9488-8c2e3a5c3056" }, "edge_region_info" : [ { "region_id" : "region.edgecloud", "image_id" : "8c056af4-738e-46c0-8474-6c4758fe038d" } ] }

请求示例 使用边缘实例96bd0630-337c-4894-90d5-a49c37c2d245创建名为test_image_name的私有镜像 POST https://{endpoint}/v1/images/create { "name" : "test_image_name", "instance_id" : "96bd0630-337c-4894-90d5-a49c37c2d245" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 servers 是 Array of BaseId objects 边缘实例ID列表。 说明： IEC默认同步删除边缘实例的弹性公网IP和磁盘。 表3 BaseId 参数 是否必选 参数类型 描述 id 是 String 对象ID，uuid。

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 publicip PublicIp object 弹性公网ip数据。 表6 PublicIp 参数 参数类型 描述 id String 弹性公网IP唯一标识。 status String 弹性公网IP的状态。 port_id String 端口的ID。 public_ip_address String 弹性公网IP的地址。 private_ip_address String 绑定弹性公网IP的私有IP地址。 create_time String 创建时间。 bandwidth_id String 带宽的ID。 bandwidth_name String 带宽的名称。 最小长度：1 最大长度：64 bandwidth_share_type String 带宽的类型。 bandwidth_size Integer 带宽的大小。 最小值：300 最大值：2000 ip_version Integer IP版本的信息。 site_id String 子网所属的站点ID。 site_info String 子网所属的站点信息。 operator Operator object 运营商信息。 type String 弹性公网IP的类型。 表7 Operator 参数 参数类型 描述 id String 运营商ID。 name String 运营商名称。 取值范围： chinamobile：中国移动； chinaunicom：中国联通； chinatelecom：中国电信。 i18n_name String 运营商国际化名称。 sa String 运营商的简写。

响应示例 状态码： 200 OK { "publicip" : { "id" : "2291e404-021e-4af0-a8a0-e1a8c1ae6f3e", "status" : "ACTIVE", "site_id" : "6813be76-7322-11ea-9ce0-286ed488d287", "site_info" : "中国/华南地区/广东/中山市", "port_id" : "bd2bc212-7369-4a7f-9c14-4dcccbf0f523", "public_ip_address" : "188.181.56.232", "private_ip_address" : "172.16.0.117", "create_time" : "2021-02-25 12:31:18", "bandwidth_id" : "6ef08c84-9260-4834-b5aa-c355b6cc2901", "bandwidth_name" : "bandwidth-测试-勿操作", "bandwidth_share_type" : "WHOLE", "bandwidth_size" : 500, "ip_version" : 4, "operator" : { "id" : "2", "i18n_name" : "中国联通", "sa" : "CUCC" } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 publicip 是 UpdatePublicIpOption object 更新弹性公网IP请求参数 表4 UpdatePublicIpOption 参数 是否必选 参数类型 描述 port_id 是 String vip对应的port的ID可为空。当为空的时候，代表解绑原有eip的关系。不为空时，代表绑定eip和vip。

响应示例 状态码： 200 OK { "port" : { "id" : "dcbd71e9-c325-4e10-b1c2-57136daf413f", "name" : "", "status" : "DOWN", "admin_state_up" : true, "fixed_ips" : [ { "subnet_id" : "3e361542-55aa-470c-a8a7-a438fa154f7d", "ip_address" : "172.16.0.188" } ], "mac_address" : "fa:16:3e:2d:3f:61", "network_id" : "56071e5f-3e97-44d1-822d-bcb76906e9a7", "device_id" : "", "device_owner" : "neutron:VIP_PORT", "security_groups" : [ ], "extra_dhcp_opts" : [ ], "allowed_address_pairs" : [ ], "site_id" : "", "dns_assignment" : [ ], "dns_name" : "" } }

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 port Port object 端口对象。 表6 Port 参数 参数类型 描述 id String 端口唯一标识 name String 端口名称 取值：默认为空，最大长度不超过255 status String 端口状态，Hana硬直通虚拟机端口状态总为DOWN 取值范围：ACTIVE、BUILD、DOWN admin_state_up Boolean 管理状态 约束：只支持true，默认为true fixed_ips Array of FixedIp objects 端口IP。 约束：一个端口只支持一个fixed_ip，且不支持更新。 mac_address String 端口MAC地址 约束：由系统分配，不支持指定 network_id String 端口所属网络的ID 约束：必须是存在的网络ID device_id String 端口所属设备ID 约束：不支持设置和更新，由系统自动维护 device_owner String 设备所属（DHCP/Router/ lb/Nova） 约束：不支持设置和更新，由系统自动维护 security_groups Array of strings 安全组的UUID(扩展属性) extra_dhcp_opts Array of ExtraDhcpOption objects DHCP的扩展属性。 allowed_address_pairs Array of AllowedAddressPair objects 功能说明：IP/Mac对列表。 约束： IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关。 site_id String 站点ID dns_assignment Array of DnsAssignment objects 主网卡默认内网域名信息 约束：不支持设置和更新，由系统自动维护 dns_name String 主网卡默认内网DNS名称 约束：不支持设置和更新，由系统自动维护 ipv6_bandwidth_id String IPv6带宽ID binding:profile Object 功能说明：提供用户设置自定义信息(扩展属性) 表7 FixedIp 参数 参数类型 描述 subnet_id String 所属子网ID ip_address String 端口IP地址 表8 ExtraDhcpOption 参数 参数类型 描述 opt_name String Option名称 opt_value String Option值 表9 AllowedAddressPair 参数 参数类型 描述 ip_address String 功能说明：IP地址 约束： 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地址 表10 DnsAssignment 参数 参数类型 描述 fqdn String 端口内网fqdn hostname String 端口hostname ip_address String 端口IP地址

请求示例 创建一个端口，所在network id为56071e5f-3e97-44d1-822d-bcb76906e9a7，指定子网id为3e361542-55aa-470c-a8a7-a438fa154f7d，指定IP地址为172.16.0.188。 POST https://{endpoint}/v1/ports { "port" : { "fixed_ips" : [ { "ip_address" : "172.16.0.188", "subnet_id" : "3e361542-55aa-470c-a8a7-a438fa154f7d" } ], "network_id" : "56071e5f-3e97-44d1-822d-bcb76906e9a7", "device_owner" : "neutron:VIP_PORT" } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 port 是 CreatePortOption object 创建端口参数。 表3 CreatePortOption 参数 是否必选 参数类型 描述 device_owner 是 String 端口设备所属。 取值范围：目前只支持指定"neutron:VIP_PORT"，neutron:VIP_PORT表示创建的是VIP network_id 是 String 端口所属网络的ID。 约束：必须是存在的网络ID。 最小长度：1 最大长度：36 fixed_ips 否 Array of FixedIp objects 端口IP 约束：一个端口只支持一个fixed_ip，且不支持更新。 表4 FixedIp 参数 是否必选 参数类型 描述 subnet_id 否 String 所属子网ID ip_address 否 String 端口IP地址

响应示例 状态码： 200 OK { "security_group" : { "id" : "99d9d709-8478-4b46-9f3f-2206b1023fd3", "name" : "sg002", "description" : "用于test", "security_group_rules" : [ { "description" : "for test", "direction" : "egress", "ethertype" : "IPv4", "id" : "99d9d709-8478-4b46-9f3f-2206b1023fd3", "protocol" : "TCP", "port_range_max" : 300, "port_range_min" : 30, "remote_group_id" : null, "remote_ip_prefix" : null, "security_group_id" : null } ] } }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 security_group 是 CreateSecurityGroupOption object 创建安全组参数。 表3 CreateSecurityGroupOption 参数 是否必选 参数类型 描述 name 是 String 安全组的名称。 最小长度：1 最大长度：64 description 否 String 安全组的描述。非必填项，默认值为空。 最小长度：0 最大长度：64

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 security_group SecurityGroup object 安全组对象。 表5 SecurityGroup 参数 参数类型 描述 id String 安全组的ID。UUID name String 安全组的名称。 最小长度：1 最大长度：64 description String 安全组的描述。 最小长度：0 最大长度：64 security_group_rules Array of SecurityGroupRule objects 安全组规则列表。 表6 SecurityGroupRule 参数 参数类型 描述 id String 安全组规则的ID。 description String 安全组规则描述信息。 最小长度：0 最大长度：64 security_group_id String 安全组ID。 direction String 出入控制方向。 取值范围： egress：出方向 ingress：入方向 ethertype String IP协议类型。 取值范围：IPv4，IPv6 约束：不填默认值为IPv4 protocol String 协议类型。 取值范围：icmp、tcp、udp、icmpv6等 约束：为空表示支持所有协议 port_range_min String 起始端口值。 取值范围：1~65535 约束：取值不能大于port_range_max的值，为空表示所有端口 port_range_max String 结束端口值。 取值范围：1~65535 约束：取值不能小于port_range_min的值，为空表示所有端口。 remote_group_id String 对端安全组ID。 约束：和remote_ip_prefix互斥 ，remote_group_id与remote_ip_prefix必须存在一个 remote_ip_prefix String 远端IP地址，当direction是egress时为虚拟机访问端的地址，当direction是ingress时为访问虚拟机的地址。 取值范围：IP地址，或者cidr格式 约束：和remote_group_id互斥 action String 安全组规则生效策略 取值范围：allow 允许，deny 拒绝 约束：默认值为allow 缺省值：allow priority Integer 规则在安全组中的优先级 取值范围：1~100，1代表最高优先级 约束：默认值为1

请求示例 创建下一跳类型为ecs的路由，下一跳地址为实例562203c6-e475-46de-81cb-ce8579459b18，路由目的网段为10.10.10.0/24 POST https://{{endpoint}}/v1/routetables/97d08984-d346-410e-bc0e-f466dfbd1f24/add-routes { "routes" : [ { "type" : "ecs", "destination" : "10.10.10.0/24", "nexthop" : "562203c6-e475-46de-81cb-ce8579459b18", "description" : "abc" } ] }

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 vpc Vpc object 虚拟私有云。 表5 Vpc 参数 参数类型 描述 id String 虚拟私有云的ID。 name String 虚拟私有云名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 约束：同一个帐号下的名称不能重复 cidr String 虚拟私有云下可用子网的范围 取值范围： 10.0.0.0/8~24 172.16.0.0/12~24 192.168.0.0/16~24 约束：必须是cidr格式，例如:192.168.0.0/16 mode String 虚拟私有云的模式。 subnet_num Integer 子网的数目。

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 vpc 是 CreateVpcOption object 创建虚拟私有云的请求体。 表3 CreateVpcOption 参数 是否必选 参数类型 描述 name 是 String 虚拟私有云名称 取值范围：1-64个字符，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） 约束：同一个帐号下的名称不能重复 cidr 是 String 虚拟私有云下可用子网的范围。 约束： SYSTEM模式，cidr取值范围：10.0.0.0/8~10.255.0.0/16或者172.16.0.0/12 ~ 172.31.0.0/16或者192.168.0.0/16 。 mode 是 String 虚拟私有云的模式，支持的取值范围如下： SYSTEM：该类型网络，系统会自动按照实际需要创建足够的子网。 CUSTOMER：该类型网络，用户需要完全按照自己站点的需要，去申请足够的子网。

响应参数 状态码： 200 表6 响应Body参数 参数 参数类型 描述 port Port object 端口的字典对象。 表7 Port 参数 参数类型 描述 id String 端口唯一标识 name String 端口名称 取值：默认为空，最大长度不超过255 status String 端口状态，Hana硬直通虚拟机端口状态总为DOWN 取值范围：ACTIVE、BUILD、DOWN admin_state_up Boolean 管理状态 约束：只支持true，默认为true fixed_ips Array of FixedIp objects 端口IP。 约束：一个端口只支持一个fixed_ip，且不支持更新。 mac_address String 端口MAC地址 约束：由系统分配，不支持指定 network_id String 端口所属网络的ID 约束：必须是存在的网络ID device_id String 端口所属设备ID 约束：不支持设置和更新，由系统自动维护 device_owner String 设备所属（DHCP/Router/ lb/Nova） 约束：不支持设置和更新，由系统自动维护 security_groups Array of strings 安全组的UUID(扩展属性) extra_dhcp_opts Array of ExtraDhcpOption objects DHCP的扩展属性。 allowed_address_pairs Array of AllowedAddressPair objects 功能说明：IP/Mac对列表。 约束： IP地址不允许为 “0.0.0.0/0” 如果allowed_address_pairs配置地址池较大的CIDR（掩码小于24位），建议为该port配置一个单独的安全组。 如果allowed_address_pairs的IP地址为“1.1.1.1/0”，表示关闭源目地址检查开关。 site_id String 站点ID dns_assignment Array of DnsAssignment objects 主网卡默认内网域名信息 约束：不支持设置和更新，由系统自动维护 dns_name String 主网卡默认内网DNS名称 约束：不支持设置和更新，由系统自动维护 ipv6_bandwidth_id String IPv6带宽ID binding:profile Object 功能说明：提供用户设置自定义信息(扩展属性) 表8 FixedIp 参数 参数类型 描述 subnet_id String 所属子网ID ip_address String 端口IP地址 表9 ExtraDhcpOption 参数 参数类型 描述 opt_name String Option名称 opt_value String Option值 表10 AllowedAddressPair 参数 参数类型 描述 ip_address String 功能说明：IP地址 约束： 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地址 表11 DnsAssignment 参数 参数类型 描述 fqdn String 端口内网fqdn hostname String 端口hostname ip_address String 端口IP地址

响应示例 状态码： 200 OK { "port" : { "id" : "e7715037-0352-430c-9ad5-c0d58fa7cb2c", "name" : " ", "status" : "DOWN", "admin_state_up" : true, "fixed_ips" : [ { "subnet_id" : "bf4a4f26-346c-444e-be42-c5a2722a43c1", "ip_address" : "192.168.1.125" } ], "mac_address" : "fa:16:3e:f8:00:3e", "network_id" : "cec75dbe-8a78-4e38-9b11-1b7dc5b59e18", "device_id" : "", "device_owner" : "neutron:VIP_PORT", "security_groups" : [ ], "extra_dhcp_opts" : [ ], "allowed_address_pairs" : [ { "ip_address" : "1.0.0.0", "mac_address" : "fa:16:3e:f8:00:3e" } ], "site_id" : "", "dns_assignment" : [ ], "dns_name" : "" } }