华为云用户手册

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 [数组元素] Array of SimpleKeypair objects 密钥对列表。 表4 SimpleKeypair 参数 参数类型 描述 name String 密钥对名称。 public_key String 密钥对应publicKey信息。 user_id String 用户ID。 fingerprint String 密钥对应指纹信息。

响应示例 状态码： 200 OK [ { "name" : "KeyPair-3c5d", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCmXY7YzR4A8PFU6xHn2EHyqQOClpX6E1RU+eWNXZ2MJzQz8g/uH0C5JCozraM3WzISAnYGO7dgGRs+6jB+m8fA4gZi4SDobII2FrOUmf48UDYyqgFPUlCEHLbbEDp//DtR/d9hrjW7YRn0ppUhlbmYGuO6oWdGRXwXBbW1ieZaVIZA+pem/Hl4AmhrQVVBNqYL419ZNW235t7JDcgLa6ie6A0JKdYhsuKg7KyCEZt+5oc6LmS+aeDQP/zW3HUhE919Y9QQGhvx3lgXtQeCMn/0PbuBK+nzixL2+8Resz6g22n/SiAP8pnfpacJZysmHTF6Qikwmkpf/UU//SiZ0bIp Generated-by-Nova", "fingerprint" : "SHA256:FXPuVsVDpXn9Ce3BJz4qVgMso4U+Ehn2GkioiFdSfsA", "user_id" : "dc36c78ad96f42e394f3221bf7c17166" } ]

响应示例 状态码： 200 OK { "volume_types" : [ { "id" : "a1d587f9-ceb2-4261-a04a-b5d217239a8d", "name" : "SATA", "status" : "normal" }, { "id" : "1c3b6c4e-b0a8-4452-9e6a-e97dbdc569ea", "name" : "SAS", "status" : "sellout" } ] }

响应参数 状态码： 200 表2 响应Body参数 参数 参数类型 描述 volume_types Array of VolumeType objects 硬盘类型列表。 表3 VolumeType 参数 参数类型 描述 id String 硬盘类型的ID。 name String 硬盘类型名称。 status String 磁盘类型的状态： 取值范围：normal(当前磁盘类型存在未售罄站点)，sellout(当前磁盘类型所有站点均售罄)

响应示例 状态码： 200 OK { "bandwidth" : { "id" : "1b0ec107-f6d4-4507-a1f4-7d7721bdbc7b", "name" : "Bandwidth_test", "size" : 300, "share_type" : "WHOLE", "publicip_info" : [ { "publicip_id" : "39daeb51-3ea9-4c75-86b9-8298fec7018c", "publicip_address" : "122.9.251.60", "publicip_type" : "5_bgp_900e", "ip_version" : 4 } ], "bandwidth_type" : "share", "charge_mode" : "95peak_plus", "site_id" : "db175dab-acb5-11ea-9310-fa165cf67eaf", "status" : "NORMAL", "create_time" : "0001-01-01T00:00:00Z", "site_info" : "中国/华东地区/浙江/杭州市", "operator" : { "id" : "99", "i18n_name" : "bgp", "sa" : "BGP" }, "update_time" : "0001-01-01T00:00:00Z" } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 bandwidth 是 UpdateBandwidthOption object 更新带宽参数。 表4 UpdateBandwidthOption 参数 是否必选 参数类型 描述 name 否 String 带宽名称。 最小长度：1 最大长度：64 size 否 Integer 带宽大小。 最小值：300 最大值：2000

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 bandwidth Bandwidth object 带宽对象。 表6 Bandwidth 参数 参数类型 描述 bandwidth_type String 带宽类型。 charge_mode String 计费模式，当前只支持峰值95计费。 取值范围： 95peak_plus：峰值95计费 create_time String 创建时间。 id String 带宽ID。 name String 带宽名称。 最小长度：1 最大长度：64 operator Operator object 运营商信息。 publicip_info Array of PublicipInfo objects 弹性公网IP信息。 share_type String 共享带宽类型，标识是否是共享带宽。 取值范围： WHOLE：共享带宽 site_id String 边缘站点ID。 site_info String 站点信息。 size Integer 带宽大小。 最小值：300 最大值：2000 status String 带宽的状态。 取值范围： FREEZED：冻结 NORMAL：正常 update_time String 更新时间。 pool_id String 线路ID。 表7 Operator 参数 参数类型 描述 id String 运营商ID。 name String 运营商名称。 取值范围： chinamobile：中国移动； chinaunicom：中国联通； chinatelecom：中国电信。 i18n_name String 运营商国际化名称。 sa String 运营商的简写。 表8 PublicipInfo 参数 参数类型 描述 ip_version Integer IP版本的信息 publicip_address String 弹性公网IP publicip_id String 弹性公网IP的ID。 publicip_type String 功能说明：弹性公网IP的类型

响应参数 状态码： 200 表15 响应Body参数 参数 参数类型 描述 id String 部署计划ID。 locations Array of Location objects 部署位置信息列表。 表16 Location 参数 参数类型 描述 site_id String 站点ID。 area String 所在大区。 province String 所属省份英文名称。 大小写通用，皆支持 city String 所在城市英文名称。 operator String 所属运营商。 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端口。

请求示例 创建部署计划，按需计费，实例规格为c6.large.2，网卡数量为1，系统盘类型为SATA，大小100GB，调度策略为集中，城市调度西安市区域购买1个实例 POST https://{endpoint}/v1/deployments { "edgecloud" : { "stack" : { "name" : "stack-fo09", "resources" : [ { "name" : "edgeinstance1", "image_ref" : "00000000-0000-0000-0000-000000000002", "flavor_ref" : "c6.large.2", "net_config" : { "vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4", "nic_num" : 1 }, "count" : 1, "root_volume" : { "volume_type" : "SATA", "size" : 100 }, "security_groups" : [ { "id" : "153133f5-2b16-11eb-a594-fa16408859a1" } ], "user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQzOEVORTckaTJ6Li9ibzZMUGlUT3VFVE5KbmxNdC9yMmJSNlhyOC81S3BndWtNU0xhLmhiVlFJNkY3T25sUS5ucVM0SXpmVEhSU0ZHN3lBeHBiakxlNkUwYjE1YjEnIHwgY2hwYXNzd2QgLWU7" } ] }, "coverage" : { "coverage_level" : "city", "coverage_policy" : "centralize", "coverage_sites" : [ { "site" : "xi'an", "demands" : [ { "demand_count" : 1 } ] } ] }, "name" : "edgecloud1" } }

响应示例 状态码： 200 OK { "id" : "87b9a88c-499d-11eb-8a8a-fa1640495574", "locations" : [ { "site_id" : "74a75ed3-cfb9-11ea-a0c3-fa1640495574", "area" : "north", "province" : "shaanxi", "city" : "xi'an", "operator" : "bgp", "pool_id" : "5_bgp_edgecloud-site4_0", "stack_count" : 1, "city_short_name" : "" } ] }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 edgecloud 是 EdgeCloudOption object 待部署的边缘业务。 表3 EdgeCloudOption 参数 是否必选 参数类型 描述 name 否 String 边缘业务名称。 取值范围：只能由中文字符、大小写英文字母、数字及中划线、下划线组成，且长度为[1-32]个字符。 最小长度：1 最大长度：32 id 否 String 已有边缘业务ID，该参数用于扩容边缘业务场景。 说明： id与name不可同时为空，同时有值时部署计划无效； 通过id扩容场景要求区域分布层级与原边缘业务一致； 区域分布层级为站点级的边缘业务不支持扩容。 description 否 String 描述，缺省值为空字符串。 最小长度：0 最大长度：255 coverage 是 Coverage object 边缘业务实例分布策略。 stack 是 Stack object 边缘业务资源组配置模板，边缘业务中的计算实例将根据该参数信息创建。 表4 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 区域及购买数量列表。 表5 CoverageSite 参数 是否必选 参数类型 描述 site 是 String 站点名称。 具体信息可通过调用“查询边缘站点列表”来查询(注意：本字段区分大小写)。 demands 是 Array of Demand objects 租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。 表6 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访问公网能力后，如果当前带宽类型下没有带宽，自动在该带宽类型下创建带宽 表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。不填写时选择默认安全组

功能介绍 为方便您的统一管理，以及跨边缘站点管理资源，IEC基于业务场景角度，定义了边缘业务。 边缘业务即为逻辑层面的一套资源管理集合。这里的资源主要是指计算实例，包含实例规格、镜像、硬盘、网络等方面。通过指定计算实例的数量、调度策略以及区域分布等形成一套管理集合。了解更多 创建一个部署计划并执行，即可创建一个边缘业务。 边缘业务下实例分布取决于部署计划的实例分布与调度策略。 边缘业务下实例名称、规格、镜像等参数取决于部署计划配置计算实例字段。

响应示例 状态码： 200 OK { "firewall" : { "id" : "c2c5234b-67ff-11ea-a41a-00e04c9bd2a3", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "name" : "test", "description" : "test", "admin_state_up" : true, "status" : "INACTIVE", "ingress_firewall_policy" : { "id" : "dd1b46d8-bff8-41d5-b79d-b96c300371d7", "name" : "ingress_firewall_policy", "firewall_rules" : [ { "id" : "1d49edb1-6845-11ea-95d5-00e04c9bd2a3", "name" : "test", "description" : "test", "enabled" : true, "action" : "allow", "protocol" : "tcp", "ip_version" : 4, "destination_ip_address" : "0.0.0.0/12", "destination_port" : "443", "source_ip_address" : "0.0.0.0/24", "source_port" : "35", "operate_type" : "normal" } ] }, "egress_firewall_policy" : { "id" : "55821488-d69b-596c-b529-9c5e16734811", "name" : "egress_firewall_policy", "firewall_rules" : [ { "id" : "5cb41787-6804-11ea-a41a-00e04c9bd2a3", "name" : "testt", "description" : "testt", "enabled" : true, "action" : "allow", "protocol" : "tcp", "ip_version" : 4, "destination_ip_address" : "0.0.0.0/12", "destination_port" : "443", "source_ip_address" : "0.0.0.0/24", "source_port" : "35", "operate_type" : "normal" } ] } } }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 firewall Firewall object 网络ACL对象。 表4 Firewall 参数 参数类型 描述 id String 网络ACL ID name String 网络ACL名称。 最小长度：1 最大长度：64 admin_state_up Boolean 网络ACL使能开关。 取值范围：true（开启），false（关闭）。默认为true 缺省值：true status String 网络ACL状态。 取值范围：INACTIVE description String 网络ACL描述。 最小长度：0 最大长度：64 domain_id String 租户domainID 最小长度：0 最大长度：36 egress_firewall_policy FirewallPolicyResp object 出方向网络ACL策略。 创建或查询防火墙列表时只返回ACL策略ID。 egress_firewall_rule_count Integer 出方向网络ACL规则个数。 ingress_firewall_policy FirewallPolicyResp object 入方向网络ACL策略。 创建或查询防火墙列表时只返回ACL策略ID。 ingress_firewall_rule_count Integer 入方向网络ACL规则个数。 表5 FirewallPolicyResp 参数 参数类型 描述 id String 网络ACL策略ID。 name String 网络ACL策略名称。 最小长度：0 最大长度：64 firewall_rules Array of FirewallRuleResp objects 网络ACL规则列表对象。 数组长度：0 - 1 insert_after String ACL规则ID，表示在此ACL规则之后添加ACL规则 insert_before String ACL规则ID，表示在此ACL规则之前添加ACL规则 表6 FirewallRuleResp 参数 参数类型 描述 action String 策略是否允许 取值范围：allow，deny，reject description String 网络ACL规则描述。 最小长度：0 最大长度：64 destination_ip_address String 目的地IP地址，IPv4或IPv6的CIDR格式 destination_port String 目的地端口范围 取值范围：整数，比如80，或者以"-"隔开的范围，比如80-90 enabled Boolean 网络ACL规则使能开关。 取值范围：true，false 缺省值：true id String 网络ACL规则ID。 进行更新规则时，如果operate_type为add，则该值为空。 ip_version Integer IP协议版本 取值范围：4, 表示ipv4；6, 表示ipv6 name String 网络ACL规则名称。 最小长度：0 最大长度：64 operate_type String 网络ACL规则操作状态，作为请求时取值为"add"/"modify"/"delete"，作为返回值时为"normal"。 当请求更新规则时，本参数值为delete时，除id之外，本请求体其他参数均可为空。 protocol String IP协议，为any时代表所有协议 取值范围： icmp，tcp，udp，icmpv6，any source_ip_address String 源IP地址，IPv4或IPv6的CIDR格式 source_port String 源地端口范围 取值范围：整数，比如80，或者以"-"隔开的范围，比如80-90

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 subnet UpdateSubnetResponseObject object 子网对象 表6 UpdateSubnetResponseObject 参数 参数类型 描述 id String 子网ID status String 子网的状态 取值范围： ACTIVE：表示子网已挂载到ROUTER上 UNKNOWN：表示子网还未挂载到ROUTER上 ERROR：表示子网状态故障 ipv6_enable Boolean 是否开启IPv6 neutron_subnet_id_v6 String 对应IPv6子网（OpenStack Neutron接口）id，如果子网为IPv4子网，则不返回此参数。

请求示例 更新子网名为test-subnet，更新dhcp和dns PUT https://{{endpoint}}/v1/subnets/ceff6c37-1dd2-4232-922c-a59d64dbb7f3 { "subnet" : { "name" : "test-subnet", "dhcp_enable" : true, "primary_dns" : "4.4.4.4", "secondary_dns" : "4.4.4.4", "dnsList" : [ "4.4.4.4" ] } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 否 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 subnet 否 UpdateSubnetOption object 更新子网的结构体。 表4 UpdateSubnetOption 参数 是否必选 参数类型 描述 name 否 String 子网名称 取值范围：0-64，支持数字、字母、中文、_(下划线)、-（中划线）、.（点） dhcp_enable 否 Boolean 子网是否开启dhcp功能 取值范围：true（开启），false（关闭） 约束：不填时默认为true。当设置为false时，会导致新创建的实例无法获取IP地址，cloudinit无法注入帐号密码，请谨慎操作。 primary_dns 否 String 子网dns服务器地址1 约束：ip格式 secondary_dns 否 String 子网dns服务器地址2 约束：ip格式 dnsList 否 Array of strings 子网dns服务器地址的集合；如果想使用两个以上dns服务器，请使用该字段。 约束：是子网dns服务器地址1跟子网dns服务器地址2的合集的父集 ipv6_enable 否 Boolean 是否创建IPv6子网 取值范围： true：开启 false：关闭 约束： 1、若该字段为true，则pool_id字段必填；若该字段为false，则pool_id字段不生效。 2、子网开启IPv6后不支持关闭。 pool_id 否 String IPv6线路ID。

修订记录 发布日期 修订记录 2024-01-02 第五次正式发布。 2023-06-05 第四次正式发布。 新增带宽和边缘镜像相关内容描述。 2023-03-08 第三次正式发布。 新增端口相关内容描述。 2022-04-15 第二次正式发布。 新增路由表相关内容。 2021-08-17 优化密钥对接口相关描述。 2021-07-05 新增实例前缀参数说明内容。 2021-06-26 优化弹性公网IP接口内容。 2021-04-30 第一次正式发布。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 routes 是 Array of DeleteRouteOption objects 待删除的路由信息 表4 DeleteRouteOption 参数 是否必选 参数类型 描述 destination 是 String 功能说明：路由的目的网段 约束：合法的CIDR格式

响应示例 状态码： 201 Created { "name" : "PK", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4uGmCeHNac9ToRtbaGIB02iCakFNk76XYsTiHDtRdIVBobTFxCE9Up9RqRAFtgpzSNBeZT6U6u3PoAV3VMjE0ZNg1Uex10lXLVU3PWfORzQG4M3lXnpqjwojlhqIg+Q88iPeyrgMawiR5If2kQ6xAkPI+4Yyc2JQn2HqV2LxE/rV42JpYEXpilveHW4urfDl9azDe3v9fmAOXq7dXzdGDCTiNMWzxj7B0jnuBiTkGxd9yTErip019O87bAdzrpSD5AZgmeHmW7LAG8GpE820xiiTIGrNONfojGdVzicc88OF/Y4r/GhCBpLC79jKa6dxnwHs4a8+u/ynuafZxvBrH Generated-by-Nova", "private_key" : "string", "user_id" : "dc36c78ad96f42e394f3221bf7c17166", "fingerprint" : "SHA256:vqILnOoQ+aRoQLylIwFcCAxETrLqvUBJEznlGqndwNY" }

请求示例 导入密钥对，密钥对名称为PK并导入公钥信息 POST https://{endpoint}/v1/os-keypairs { "name" : "PK", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4uGmCeHNac9ToRtbaGIB02iCakFNk76XYsTiHDtRdIVBobTFxCE9Up9RqRAFtgpzSNBeZT6U6u3PoAV3VMjE0ZNg1Uex10lXLVU3PWfORzQG4M3lXnpqjwojlhqIg+Q88iPeyrgMawiR5If2kQ6xAkPI+4Yyc2JQn2HqV2LxE/rV42JpYEXpilveHW4urfDl9azDe3v9fmAOXq7dXzdGDCTiNMWzxj7B0jnuBiTkGxd9yTErip019O87bAdzrpSD5AZgmeHmW7LAG8GpE820xiiTIGrNONfojGdVzicc88OF/Y4r/GhCBpLC79jKa6dxnwHs4a8+u/ynuafZxvBrH Generated-by-Nova\n" }

请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表2 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 密钥对名称。 新创建的密钥名称不能和已有密钥名称相同。 最小长度：1 最大长度：64 public_key 否 String 导入的公钥信息。 建议导入的公钥长度不大于1024字节。 说明： 长度超过1024字节会导致边缘实例注入该密钥失败。

响应示例 状态码： 200 OK { "routetable" : { "id" : "b96df94c-7d3b-4e5f-8852-16646a27ef95", "name" : "test1", "subnets" : [ { "id" : "4c2a7e40-0f23-42d7-8f1c-aa6396d12a29" } ], "vpc_id" : "af5b7439-5969-11eb-acfa-fa16408859a1", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "description" : "this is a test", "default" : false } }

响应示例 状态码： 200 OK { "id" : "27101e92-49a7-11eb-8a8a-fa1640495574", "name" : "edgecloud1", "stacks" : { "name" : "stack-fo09-xi_a-001", "resources" : [ { "name" : "edgeinstance1", "image_ref" : "00000000-0000-0000-0000-000000000002", "flavor_ref" : "c6.large.2", "user_data" : "IyEvYmluL2Jhc2gKZWNobyAncm9vdDokNiQzOEVORTckaTJ6Li9ibzZMUGlUT3VFVE5KbmxNdC9yMmJSNlhyOC81S3BndWtNU0xhLmhiVlFJNkY3T25sUS5ucVM0SXpmVEhSU0ZHN3lBeHBiakxlNkUwYjE1YjEnIHwgY2hwYXNzd2QgLWU7", "admin_pass" : "******", "net_config" : { "vpc_id" : "4a6d9663-475f-11eb-aa7c-fa16406a65c4", "nic_num" : 1 }, "count" : 1, "root_volume" : { "volume_type" : "SATA", "size" : 100 }, "security_groups" : [ { "id" : "153133f5-2b16-11eb-a594-fa16408859a1" } ] } ] }, "coverage" : { "coverage_policy" : "centralize", "coverage_level" : "city", "coverage_sites" : [ { "site" : "xi'an", "i18n_site" : "西安市", "demands" : [ { "demand_count" : 1 } ] } ] }, "success_num" : 0, "failed_num" : 1, "status" : "failed", "edge_regions" : 1, "create_at" : "2020-12-29T07:26:22.866644Z", "update_at" : "2020-12-29T07:26:24.728957Z" }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 边缘业务ID。 name String 边缘业务名称。 stacks Array of Stack objects 边缘业务资源组。 coverage CoverageResp object 边缘业务覆盖策略。 success_num Integer 边缘业务成功创建的虚拟机数量。 failed_num Integer 边缘业务创建失败的虚拟机数量。 status String 边缘业务状态。 fail_reason FailReason object 边缘业务失败的原因。 edge_regions Integer 边缘业务支持的边缘区域数目，等同于边缘业务下所有实例的区域数目总和 description String 描述。 create_at String 创建时间。 update_at String 修改时间。 表4 Stack 参数 参数类型 描述 name String 边缘资源组名称。 取值范围：只能由中文字符、大小写英文字母、数字及中划线、下划线组成，且长度为[1-48]个字符。 最小长度：1 最大长度：48 resources Array of Resource objects 边缘业务的堆栈，即为资源组。 表5 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文件。 更多关于待注入用户数据的信息，请参见《弹性云服务器用户指南 》的“用户数据注入”章节。 表6 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”，表示关闭源目地址检查开关 表7 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地址 表8 BandwidthConfig 参数 参数类型 描述 sharetype String 带宽类型，现支持WHOLE类型，即共享带宽，其他类型不支持。 size Integer 带宽（Mbit/s）。 表9 RootVolume 参数 参数类型 描述 size Integer 系统盘大小，容量单位为GB，输入大小范围为[40,100]。 最小值：40 最大值：100 volume_type String 边缘实例系统盘对应的磁盘类型，需要与站点所提供的磁盘类型相匹配。 表10 DataVolume 参数 参数类型 描述 size Integer 数据盘大小，容量单位为GB，输入大小范围为[1,500]。 最小值：1 最大值：500 volume_type String 边缘实例数据盘对应的磁盘类型，需要与站点所提供的磁盘类型相匹配。 表11 SecurityGroupOption 参数 参数类型 描述 id String 边缘实例的安全组，会对边缘实例中配置的网卡生效。需要指定已有安全组的ID。不填写时选择默认安全组 表12 CoverageResp 参数 参数类型 描述 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 CoverageSiteResp objects 区域及购买数量列表。 表13 CoverageSiteResp 参数 参数类型 描述 site String 站点名称。 具体信息可通过调用“查询边缘站点列表”来查询(注意：本字段区分大小写)。 demands Array of DemandResp objects 租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。 i18n_site String 覆盖区域的国际化信息。 表14 DemandResp 参数 参数类型 描述 demand_count Integer 站点需要发放的资源(组)总数。 说明： 实际发放实例数量为count*demand_count。 最小值：1 最大值：10 pool_id_v6 String 指定IPv6线路，使用该线路下的子网分配IPv6端口。 如果该线路下没有关联启用IPv6的子网，则创建新的子网。 ipv6_bandwidth_enable Boolean 使用IPv6带宽。 边缘实例是否开启IPv6公网访问能力。如果该IPv6线路下没有带宽，则创建新的带宽。 表15 FailReason 参数 参数类型 描述 fail_code String 错误码 fail_message String 边缘云失败原因列表。包含所边缘云的失败原因。

响应示例 状态码： 200 OK { "count" : 1, "edgeclouds" : [ { "id" : "27101e92-49a7-11eb-8a8a-fa1640495574", "name" : "edgecloud1", "coverage" : { "coverage_policy" : "centralize", "coverage_level" : "city", "coverage_sites" : [ { "site" : "xi'an", "i18n_site" : "西安市", "demands" : [ { "demand_count" : 1 } ] } ] }, "success_num" : 0, "failed_num" : 1, "status" : "failed", "edge_regions" : 1 } ] }

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 count Integer 边缘业务数量。 edgeclouds Array of EdgeCloud objects 边缘业务列表。 表4 EdgeCloud 参数 参数类型 描述 id String 边缘业务ID。 name String 边缘业务名称。 取值范围：只能由中文字符、大小写英文字母、数字及中划线、下划线组成，且长度为[1-32]个字符。 description String 边缘业务描述。最大支持255字节。 coverage CoverageResp object 边缘业务覆盖策略 failed_num Integer 创建失败的虚拟机 status String 边缘业务状态，现存状态有： creating/scheduling/updating：部署中 inService：运行中 failed：创建失败 deleting：删除中 delFailed：删除失败 success_num Integer 成功创建的虚拟机 edge_regions Integer 边缘业务支持的边缘区域数目。 表5 CoverageResp 参数 参数类型 描述 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 CoverageSiteResp objects 区域及购买数量列表。 表6 CoverageSiteResp 参数 参数类型 描述 site String 站点名称。 具体信息可通过调用“查询边缘站点列表”来查询(注意：本字段区分大小写)。 demands Array of DemandResp objects 租户需求数量列表。表示租户发放资源站点的运营商和发放的资源组的数量。 i18n_site String 覆盖区域的国际化信息。 表7 DemandResp 参数 参数类型 描述 demand_count Integer 站点需要发放的资源(组)总数。 说明： 实际发放实例数量为count*demand_count。 最小值：1 最大值：10 pool_id_v6 String 指定IPv6线路，使用该线路下的子网分配IPv6端口。 如果该线路下没有关联启用IPv6的子网，则创建新的子网。 ipv6_bandwidth_enable Boolean 使用IPv6带宽。 边缘实例是否开启IPv6公网访问能力。如果该IPv6线路下没有带宽，则创建新的带宽。

响应示例 状态码： 200 OK { "ports" : [ { "id" : "0ea06f5f-40dc-4136-aae9-08a0cf8fc356", "name" : "671ff701-3dea-4a15-8aeb-58eb179af4b7", "status" : "DOWN", "admin_state_up" : true, "fixed_ips" : [ { "subnet_id" : "671ff701-3dea-4a15-8aeb-58eb179af4b7", "ip_address" : "172.16.0.1" } ], "mac_address" : "fa:16:3e:af:fc:8d", "network_id" : "eef408da-0f0e-4a09-a5f2-9e9c301c0157", "device_id" : "cf47d861-f407-4cd9-aa56-11d97201539d", "device_owner" : "network:router_interface_distributed", "security_groups" : null, "extra_dhcp_opts" : [ ], "allowed_address_pairs" : [ ], "site_id" : "74a75ed3-cfb9-11ea-a0c3-fa1640495574", "dns_assignment" : [ ], "dns_name" : "" } ], "count" : 1 }

URI GET /v1/ports 表1 Query参数 参数 是否必选 参数类型 描述 admin_state_up 否 Boolean 按照admin_state_up进行过滤 约束：只支持true device_id 否 String 根据设备ID查询端口。 device_owner 否 String 根据设备主查询端口。 fixed_ips 否 Array 根据绑定的IP查询端口。按照fixed_ips=ip_address或者fixed_ips=subnet_id过滤查询，示例：fixed_ips=ip_address=xxx&fixed_ips=subnet_id=xxxx id 否 String 按照端口ID过滤查询 limit 否 Integer 查询返回端口列表数量。取值范围：0~1000。 最小值：0 最大值：1000 缺省值：1000 mac_address 否 String 根据网卡的mac地址查询端口。 name 否 String 按照name过滤查询 取值范围：最大长度不超过255 network_id 否 String 子网的neutron的network的ID。 offset 否 Integer 查询的偏移量。 security_groups 否 String 根据安全组信息ID查询端口。 status 否 String 按照status过滤查询 取值范围：ACTIVE、BUILD、DOWN

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 ports Array of Port objects 端口对象。 count Integer 端口数目。 表4 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 功能说明：提供用户设置自定义信息(扩展属性) 表5 FixedIp 参数 参数类型 描述 subnet_id String 所属子网ID ip_address String 端口IP地址 表6 ExtraDhcpOption 参数 参数类型 描述 opt_name String Option名称 opt_value String Option值 表7 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地址 表8 DnsAssignment 参数 参数类型 描述 fqdn String 端口内网fqdn hostname String 端口hostname ip_address String 端口IP地址