华为云用户手册

  • 请求示例 在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 } }
  • 请求参数 表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。
  • 请求示例 批量关闭边缘实例,请求参数必须以"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" } ] } }
  • 请求参数 表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 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 表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 { "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" : "" } }
  • 请求示例 创建一个端口,所在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" } }
  • 响应参数 状态码: 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地址
  • 请求参数 表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" } ] }
  • 请求参数 表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 表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 子网的数目。
  • 响应参数 状态码: 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" : "" } }
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表3 请求Body参数 参数 是否必选 参数类型 描述 port 是 UpdatePortOption object 更新端口对象 表4 UpdatePortOption 参数 是否必选 参数类型 描述 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”,表示关闭源目地址检查开关 为虚拟IP配置后端边缘实例场景, allowed_address_pairs中配置的IP地址,必须为边缘实例网卡已有的IP地址,否则可能会导致虚拟IP通信异常。 被绑定的边缘实例网卡allowed_address_pairs填“1.1.1.1/0” security_groups 否 Array of strings 安全组列表 表5 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地址
  • 请求参数 表1 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。 表2 请求Body参数 参数 是否必选 参数类型 描述 publicip 是 CreatePublicIpOption object 弹性公网IP的信息字典对象 bandwidth 否 CreatePublicIpBandwidthOption object 带宽参数。 表3 CreatePublicIpOption 参数 是否必选 参数类型 描述 site_id 是 String 边缘站点的ID。 ip_version 否 String 弹性公网IP的版本。目前IEC服务只支持4,即ipv4。 type 否 String 线路ID。 不传时默认取当前站点第一条线路 表4 CreatePublicIpBandwidthOption 参数 是否必选 参数类型 描述 id 否 String 带宽id。 开启创建带宽白名单后,需要填写该参数。 bandwidth_type 否 String 带宽类型。 指定带宽ID,则该参数不生效。 不指定带宽的情况下,如果当前带宽类型下没有带宽,自动在该带宽类型下创建带宽,有则使用最近创建的带宽。
  • 响应示例 状态码: 200 OK { "publicip" : { "id" : "8bdc72de-f35c-4ec6-8304-5ffee39f6054", "status" : "PENDING_CREATE", "type" : "5_sbgp_site1", "site_id" : "705da43d-fa20-11ea-9fb2-fa1640495574", "site_info" : "China/华中地区/湖南/长沙市", "public_ip_address" : "188.181.52.224", "create_time" : "2021-03-16 01:52:38", "bandwidth_size" : 0, "ip_version" : 4, "operator" : { "id" : "1", "i18n_name" : "中国电信", "sa" : "CTCC" } } }
  • 响应参数 状态码: 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 运营商的简写。
共100000条