华为云用户手册

  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 边缘业务ID。 name String 部署计划名称。 deployment_id String 部署计划ID。 status String 边缘业务状态,现存状态有: creating/scheduling/updating:部署中 inService:运行中 failed:创建失败 deleting:删除中 delFailed:删除失败 job_id String 任务ID。
  • 响应示例 状态码: 200 OK { "routetable" : { "id" : "b96df94c-7d3b-4e5f-8852-16646a27ef95", "name" : "test1", "vpc_id" : "af5b7439-5969-11eb-acfa-fa16408859a1", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "description" : "this is a test", "default" : false } }
  • 响应示例 状态码: 200 OK { "publicip" : { "id" : "a943a83e-4920-4b8d-87bb-f777d3dce83a", "status" : "ACTIVE", "port_id" : "5dc619ab-2246-4383-8bd7-f37e1e3b89ab", "public_ip_address" : "10.44.2.44", "private_ip_address" : "192.168.0.212", "create_time" : "2021-01-01T14:29:33Z", "bandwidth_id" : "2c3a040c-7b4e-41a1-8b77-26ea7fe61548", "bandwidth_name" : "edgeCloud_chengdu_CMCC-bandwidth-98f7", "bandwidth_share_type" : "PER", "bandwidth_size" : 5, "ip_version" : 4, "site_id" : "e3b52316-05be-11ea-bc35-286ed488d287", "site_info" : "中国/华中地区/湖北/武汉市", "operator" : { "id" : 3, "i18n_name" : "中国移动", "sa" : "CMCC" } } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 publicip PublicIp object 弹性公网ip数据。 表4 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的类型。 表5 Operator 参数 参数类型 描述 id String 运营商ID。 name String 运营商名称。 取值范围: chinamobile:中国移动; chinaunicom:中国联通; chinatelecom:中国电信。 i18n_name String 运营商国际化名称。 sa String 运营商的简写。
  • 响应示例 状态码: 200 OK { "images" : [ { "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" } ] }
  • URI GET /v1/cloudimages/{region_id} 表1 路径参数 参数 是否必选 参数类型 描述 region_id 是 String 华为云区域ID 表2 Query参数 参数 是否必选 参数类型 描述 __imagetype 否 String 镜像类型,目前支持以下类型: 公共镜像:gold 私有镜像:private __isregistered 否 String 镜像是否可用,取值为true/false。 说明: 查询公共镜像时,该参数无效。 __os_type 否 String 镜像系统类型,取值如下: Linux Windows Other __support_diskintensive 否 String 表示该镜像支持密集存储。如果镜像支持密集存储性能,则值为true,否则无需增加该属性。 __support_highperformance 否 String 表示该镜像支持高计算性能。如果镜像支持高计算性能,则值为true,否则无需增加该属性。 __support_kvm 否 String 如果镜像支持KVM,取值为true,否则无该属性。 __support_kvm_gpu_type 否 String 如果镜像是支持KVM虚拟化平台下的GPU类型,取值为“V100_vGPU”或者“RTX5000”,否则无该属性。 __support_kvm_infiniband 否 String 如果镜像支持KVM虚拟化下Infiniband网卡类型,取值为true。否则,无需添加该属性。 该属性与“__support_xen”属性不共存。 __support_largememory 否 String 表示该镜像支持超大内存。如果镜像支持超大内存,取值为true,否则无需增加该属性。 __support_xen 否 String 如果镜像支持XEN,取值为true,否则无需增加该属性。 __support_xen_gpu_type 否 String 表示该镜像是支持XEN虚拟化平台下的GPU优化类型。如果不支持XEN虚拟化下GPU类型,无需添加该属性。该属性与“__support_xen”和“__support_kvm”属性不共存。 __support_xen_hana 否 String 如果镜像支持XEN虚拟化下HANA类型,取值为true。否则,无需添加该属性。 该属性与“__support_xen”和“__support_kvm”属性不共存。 id 否 String 镜像ID,精确匹配。 limit 否 Integer 用于分页,表示查询几条镜像记录,取值为正整数,最大(默认)取值为500 最小值:0 最大值:500 marker 否 String 用于分页,表示从哪个镜像开始查询,取值为镜像ID。 name 否 String 镜像名称,匹配规则为精确匹配。 owner 否 String 镜像属于哪个租户。 protected 否 String 镜像是否是受保护,取值为true/false,一般查询公共镜像时候取值为true,查询私有镜像可以不指定。 sort_dir 否 String 用于排序,表示升序还是降序,取值为asc和desc,与sort_key一起组合使用,默认为降序desc。 缺省值:desc sort_key 否 String 用于排序,表示按照哪个字段排序,取值为镜像属性name、status、disk_format、created_at,默认取值为created_at。 缺省值:created_at status 否 String 镜像状态。取值如下: saving:表示镜像正在上传文件到后端存储 deleted:表示镜像已经删除 killed:表示镜像上传错误 active:表示镜像可以正常使用 virtual_env_type 否 String 镜像使用环境类型。 目前仅支持系统盘镜像,取值为:FusionCompute visibility 否 String 是否被其他租户可见,取值如下: public:公共镜像 private:私有镜像
  • 响应示例 状态码: 200 OK { "id" : "d0272146-f6d8-4e3c-a1dc-196ec4a2f848", "name" : "edgecloud1", "deployment_id" : "87b9a88c-499d-11eb-8a8a-fa1640495574", "status" : "updating", "job_id" : "8ab3ba2f-32b2-11eb-817a-00d861bad499" }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 id String 边缘业务ID。 name String 部署计划名称。 deployment_id String 部署计划ID。 status String 边缘业务状态,现存状态有: creating/scheduling/updating:部署中 inService:运行中 failed:创建失败 deleting:删除中 delFailed:删除失败 job_id String 任务ID。
  • 响应示例 状态码: 200 OK { "routes" : [ { "type" : "local", "destination" : "172.16.0.0/26", "nexthop" : "-", "description" : "" }, { "type" : "local", "destination" : "198.19.128.0/20", "nexthop" : "-", "description" : "" }, { "type" : "local", "destination" : "127.0.0.0/8", "nexthop" : "-", "description" : "" }, { "type" : "local", "destination" : "100.64.0.0/10", "nexthop" : "-", "description" : "" } ] }
  • 请求示例 输入subnet_id,则使用subnet_id创建nic_num个网卡,不输入,则自动分配subnet。 POST https://{endpoint}/v1/cloudservers/f8175002-e4b9-4235-bdf8-80cb95cab69f/nics { "vpc_id" : "67783204-cce0-11ea-a72f-fa16406a65c4", "security_groups" : [ { "id" : "b62f9aae-67ee-11ea-a77b-286ed488d287" } ], "subnet_id" : "829d59b8-f45d-4d81-8286-7afe3992acf7", "nic_num" : 1 }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 vpc_id 是 String 虚拟私有云ID。 security_groups 是 Array of BaseId objects 安全组ID列表。 subnet_id 否 String 子网ID。 当subnet_id提供时,则在该子网下创建nic_num个网卡; 不输入,则自动分配subnet。 当添加网卡的VPC为手动规划VPC时,subnet_id必填。 nic_num 是 Integer 待添加网卡数量。 最小值:1 表4 BaseId 参数 是否必选 参数类型 描述 id 是 String 对象ID,uuid。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 边缘实例规格数量。 flavors Array of Flavor objects 规格列表。 表4 Flavor 参数 参数类型 描述 id String 边缘实例规格的ID。 name String 边缘实例规格的名称。 disk String 边缘实例规格对应要求系统盘大小。 当前未使用该参数,缺省值为0。 ram Integer 边缘实例规格对应的内存大小,单位为MB。 vcpus String 边缘实例规格对应的CPU核数。 os_extra_specs OsExtraSpecs object 规格扩展字段。 os_flavor_access_is_public Boolean 扩展属性,flavor是否给所有租户使用。 表5 OsExtraSpecs 参数 参数类型 描述 cond:operation:status String 此参数是Region级配置,某个AZ没有在cond:operation:az参数中配置时默认使用此参数的取值。不配置或无此参数时等同于“normal”。 cond:network String 网络约束 支持网络特性,不配置时以控制台默认配置为准。 ecs:generation String 边缘实例类型的代数。 ecs:performancetype String 边缘实例规格的分类。 ecs:virtualization_env_types String 虚拟化类型。 info:cpu:name String 此参数是规格的CPU详细信息。 info:gpu:name String 此参数是规格的GPU详细信息。 pci_passthrough:alias String P1型本地直通GPU的型号和数量,参数值可设置为“nvidia-p100:1”,表示使用该规格创建的边缘实例将占用1张NVIDIA P100显卡。 pci_passthrough:enable_gpu String 显卡是否直通。 值为“true”,表示GPU直通。 pci_passthrough:gpu_specs String G1型和G2型边缘实例应用的技术,包括GPU虚拟化和GPU直通。 resource_type String 资源类型,resource_type是为了区分边缘实例的物理主机类型。
  • 响应示例 状态码: 200 OK { "count" : 1, "flavors" : [ { "id" : "d0272146-f6d8-4e3c-a1dc-196ec4a2f848", "name" : "c3.large", "vcpus" : "c3.large", "ram" : 2048, "disk" : "100", "os_flavor_access_is_public" : "true", "os_extra_specs" : { "ecs:performancetype" : "cpuv1", "resource_type" : "IOoptimizedC3_2", "ecs:generation" : "c3", "ecs:virtualization_env_types" : "FusionCompute", "pci_passthrough:enable_gpu" : true, "pci_passthrough:gpu_specs" : "m60_1q:virt:1", "pci_passthrough:alias" : "nvidia-p100:1", "cond:operation:status" : "normal", "info:cpu:name" : "Intel SkyLake 6151 3.0GHz / Intel Cascade Lake 6278 2.6GHz", "info:gpu:name" : "1 * NVIDIA Quadro RTX5000 / 1 * 16G" } } ] }
  • URI GET /v1/cloudservers/flavors 表1 Query参数 参数 是否必选 参数类型 描述 area 否 String 边缘规格所在大区。 大小写通用,皆支持。 支持多个查询,中间使用“,”分隔。 city 否 String 边缘规格所在城市。 大小写通用,皆支持。 支持多个查询,中间使用“,”分隔。 id 否 String 查询条件,规格的ID。 limit 否 Integer 查询返回边缘实例规格列表当前页面的数量 。 取值范围:0~1000。 name 否 String 查询条件,规格的名称。 offset 否 Integer 页码。 当前页面数,默认为1。 取值大于等于0,取值为0时返回第1页。 operator 否 String 边缘规格支持运营商。 大小写通用,皆支持。 支持多个查询,中间使用“,”分隔。 province 否 String 边缘规格所在省份。 大小写通用,皆支持。 支持多个查询,中间使用“,”分隔。 site_ids 否 String 查询条件,边缘规格站点列表,站点之间用“,”分隔。
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 虚拟私有云的总数。 vpcs Array of Vpc objects 虚拟私有云数组对象。 表4 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 子网的数目。
  • 响应示例 状态码: 200 OK { "count" : 1, "vpcs" : [ { "id" : "ab96424b-aba2-4b08-b534-25e2dbd89519", "name" : "dc_vpc_001", "cidr" : "192.168.2.0/21", "subnet_num" : 4, "mode" : "SYSTEM" } ] }
  • 响应示例 状态码: 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 } ] } }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 security_group SecurityGroup object 安全组对象。 表4 SecurityGroup 参数 参数类型 描述 id String 安全组的ID。UUID name String 安全组的名称。 最小长度:1 最大长度:64 description String 安全组的描述。 最小长度:0 最大长度:64 security_group_rules Array of SecurityGroupRule objects 安全组规则列表。 表5 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
  • 响应示例 状态码: 200 OK { "count" : 1, "sites" : [ { "id" : "705da43d-fa20-11ea-9fb2-fa1640495574", "name" : "changsha", "city" : "changsha", "i18n_city" : "长沙市", "province" : "hunan", "i18n_province" : "湖南", "area" : "central", "i18n_area" : "华中地区", "country" : "China", "i18n_country" : "China", "status" : "Normal", "city_short_name" : "CS", "pools" : [ { "id" : "705ed516-fa20-11ea-9fb2-fa1640495574", "site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574", "display_name" : "", "operator" : { "id" : "1", "name" : "chinatelecom", "i18n_name" : "中国电信", "sa" : "CTCC" }, "pool_id" : "5_sbgp_site1", "ip_version" : "4" }, { "id" : "705ed56a-fa20-11ea-9fb2-fa1640495574", "site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574", "display_name" : "", "operator" : { "id" : "2", "name" : "chinaunicom", "i18n_name" : "中国联通", "sa" : "CUCC" }, "pool_id" : "5_unicon_site1", "ip_version" : "4" }, { "id" : "fcd8beaa-fd71-11ea-9594-00d861bad499", "site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574", "display_name" : "iec-changsha-pool2", "operator" : { "id" : "3", "name" : "chinamobile", "i18n_name" : "中国移动", "sa" : "CMCC" }, "pool_id" : "5_mobile_site1", "ip_version" : "4" } ] } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 边缘站点总数。 sites Array of Site objects 站点列表。 表4 Site 参数 参数类型 描述 id String 边缘站点ID。 name String 边缘站点名称。 city String 站点所在城市。 i18n_city String 城市的国际化名称。 province String 站点所在省份。 i18n_province String 省份的国际化名称。 area String 所在大区。 i18n_area String 大区的国际化名称。 country String 站点所在的国家。 i18n_country String 国家的国际化名称。 status String 站点当前的状态。 取值范围: Normal(正常商用) Obt(公测) Gray(灰度) Offline(下线) Promotion(推荐,也是商用) sellout(售罄) pools Array of IpPool objects 站点IP线路列表。 city_short_name String 城市名称缩写。 表5 IpPool 参数 参数类型 描述 id String 线路的ID。 site_id String 线路所属站点ID。 pool_id String 线路标识。 ip_version String IPv4或IPv6线路。 取值范围: 4:IPv4线路 6:IPv6线路 operator Operator object 运营商信息。 display_name String 线路的显示名称。 allow_share_bandwidth_types Array of strings 功能说明:表示此publicip可以加入的共享带宽类型列表,如果列表为空,则表示该publicip不能加入任何共享带宽 约束:publicip只能加入到有该带宽类型的共享带宽中 最大长度:36 表6 Operator 参数 参数类型 描述 id String 运营商ID。 name String 运营商名称。 取值范围: chinamobile:中国移动; chinaunicom:中国联通; chinatelecom:中国电信。 i18n_name String 运营商国际化名称。 sa String 运营商的简写。
  • URI GET /v1/sites 表1 Query参数 参数 是否必选 参数类型 描述 area 否 String 边缘实例所在大区。 大小写通用,皆支持。 支持多个查询,中间使用','分隔。 city 否 String 边缘实例所在城市。 大小写通用,皆支持。 支持多个查询,中间使用“,”分隔。 flavor 否 String 边缘实例规格。 id 否 String 查询条件,站点ID。 limit 否 Integer 查询返回边缘站点列表当前页面的数量。 取值范围:0~1000。 最小值:0 最大值:1000 缺省值:1000 offset 否 Integer 查询的偏移量。默认为0。 缺省值:0 province 否 String 边缘实例所在省份。 大小写通用,皆支持。 支持多个查询,中间使用“,”分隔。 volume_type 否 String 过滤支持磁盘类型的站点,多个类型之间用“,”分割。
  • 响应示例 状态码: 200 OK { "name" : "PK", "public_key" : "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC4uGmCeHNac9ToRtbaGIB02iCakFNk76XYsTiHDtRdIVBobTFxCE9Up9RqRAFtgpzSNBeZT6U6u3PoAV3VMjE0ZNg1Uex10lXLVU3PWfORzQG4M3lXnpqjwojlhqIg+Q88iPeyrgMawiR5If2kQ6xAkPI+4Yyc2JQn2HqV2LxE/rV42JpYEXpilveHW4urfDl9azDe3v9fmAOXq7dXzdGDCTiNMWzxj7B0jnuBiTkGxd9yTErip019O87bAdzrpSD5AZgmeHmW7LAG8GpE820xiiTIGrNONfojGdVzicc88OF/Y4r/GhCBpLC79jKa6dxnwHs4a8+u/ynuafZxvBrH Generated-by-Nova", "user_id" : "dc36c78ad96f42e394f3221bf7c17166", "fingerprint" : "SHA256:vqILnOoQ+aRoQLylIwFcCAxETrLqvUBJEznlGqndwNY" }
  • 响应示例 状态码: 200 OK { "firewall" : { "id" : "ce1ce0c8-d714-11ea-a863-fa16408859a1", "domain_id" : "2b76febbe5d34eac85d26435c1f15809", "name" : "fw-nhsr", "description" : "xx", "admin_state_up" : true, "status" : "INACTIVE", "ingress_firewall_policy" : { "id" : "ff15fc0e-b80d-4d00-89d0-0c1fbb3d98b9" }, "egress_firewall_policy" : { "id" : "b0ea29d4-6350-5e79-9605-89e3837480d7" }, "ingress_firewall_rule_count" : 0, "egress_firewall_rule_count" : 0 } }
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 firewall 是 CreateFirewallOption object 创建网络ACL请求体。 表3 CreateFirewallOption 参数 是否必选 参数类型 描述 name 是 String 中文字符、字母、数字、中划线和下划线组成,长度为1~64个字符 最小长度:1 最大长度:64 description 否 String 网络ACL描述。 取值范围:0-64 最小长度:0 最大长度:64
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 firewall Firewall object 网络ACL对象。 表5 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规则个数。 表6 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规则 表7 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
  • 请求示例 批量启动边缘实例 POST https://{endpoint}/v1/cloudservers/action { "os-start" : { "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-start 否 BatchStart object 标记为启动边缘实例操作。 表3 BatchStart 参数 是否必选 参数类型 描述 servers 否 Array of BaseId objects 待启动的边缘实例列表。 表4 BaseId 参数 是否必选 参数类型 描述 id 是 String 对象ID,uuid。
  • 响应示例 状态码: 200 OK { "volume" : { "id" : "48eb38f5-da62-42f3-a19e-f4fe58f92e5e", "status" : "in-use", "size" : 40, "availability_zone" : "edgecloud-site3", "attachments" : [ { "attachment_id" : "83e647b7-01a4-4c38-9108-ed83989f0a9a", "device" : "/dev/vda", "host_name" : "", "id" : "48eb38f5-da62-42f3-a19e-f4fe58f92e5e", "server_id" : "51aff40b-3adf-4048-b18e-f11cbd76b02f", "volume_id" : "48eb38f5-da62-42f3-a19e-f4fe58f92e5e" } ], "name" : "IEC-zhongshan01-test-edgestackEdge1-0002-volume-0000", "description" : "", "volume_type" : "SATA", "metadata" : { "attached_mode" : "rw", "readonly" : "False" }, "bootable" : "true", "encrypted" : false, "multiattach" : false } }
  • 响应示例 状态码: 200 OK { "count" : 10, "publicips" : [ { "id" : "a943a83e-4920-4b8d-87bb-f777d3dce83a", "status" : "ACTIVE", "port_id" : "5dc619ab-2246-4383-8bd7-f37e1e3b89ab", "public_ip_address" : "10.44.2.44", "private_ip_address" : "192.168.0.212", "create_time" : "2021-01-01T14:29:33Z", "bandwidth_id" : "2c3a040c-7b4e-41a1-8b77-26ea7fe61548", "bandwidth_name" : "edgeCloud_chengdu_CMCC-bandwidth-98f7", "bandwidth_share_type" : "PER", "bandwidth_size" : 5, "ip_version" : 4, "site_id" : "e3b52316-05be-11ea-bc35-286ed488d287", "site_info" : "中国/华中地区/湖北/武汉市", "operator" : { "id" : 3, "i18n_name" : "中国移动", "sa" : "CMCC" } } ] }
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 count Integer 弹性公网IP数目。 publicips Array of PublicIp objects 弹性公网IP数组对象。 表4 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的类型。 表5 Operator 参数 参数类型 描述 id String 运营商ID。 name String 运营商名称。 取值范围: chinamobile:中国移动; chinaunicom:中国联通; chinatelecom:中国电信。 i18n_name String 运营商国际化名称。 sa String 运营商的简写。
共100000条