You need to enable JavaScript to run this app.
导航

请求结构定义

最近更新时间2024.01.12 17:37:54

首次发布时间2022.02.25 18:58:33

边缘服务请求结构定义

StorageConfig

名称

类型

是否必选

示例值

描述

system_disk

DiskSpec

{
  "system_disk": {
    "capacity": "40",
    "storage_type": "CloudBlockSSD"
  }
}

系统盘。
详情请参见 DiskSpec

data_disk

DiskSpec

{
  "data_disk": {
    "capacity": "20",
    "storage_type": "CloudBlockSSD"
  }
}

数据盘。该参数用于添加单块数据盘。
详情请参见 DiskSpec

说明

系统盘和数据盘是云盘时,系统云盘和数据云盘的类型需保持一致。如果创建多块数据云盘,数据云盘的类型需保持一致。

data_disk_list

[]DiskSpec

{
  "data_disk_list":[
    {
      "capacity": "20",
      "storage_type": "CloudBlockSSD"
    },
     {
      "capacity": "40",
      "storage_type": "CloudBlockSSD"
    }
  ]
}

数据盘列表。该参数用于添加一块或多块数据盘。
详情请参见 DiskSpec

说明

系统盘和数据盘是云盘时,系统云盘和数据云盘的类型需保持一致。如果创建多块数据云盘,数据云盘的类型需保持一致。

DiskSpec

名称

类型

是否必选

示例值

描述

storage_type

String

CloudBlockHDD

磁盘类型。取值范围:

  • CloudBlockHDD:HDD 型云盘。
  • CloudBlockSSD:SSD 型云盘。

capacity

String

40

磁盘容量。单位:GB。容量范围:

  • 系统云盘:40 ~ 100。
  • 数据云盘:20 ~ 1000。

取值须是 10 的倍数。如需更大磁盘容量,请提交工单申请。

NetworkConfigReq

名称

类型

是否必选

示例值

描述

bandwidth_peak

String

20

公网带宽峰值。取值范围:[5,实例规格支持的带宽上限]。取值须是 5 的倍数。单位:Mbps。
当您选择 IPv4/IPv6 双栈边缘实例时,所设的带宽峰值将被 IPv4 和 IPv6 公网 IP 地址共享。
disable_ipv4 设置为 true 时,无需配置 bandwidth_peak 参数。

enable_ipv6

Boolean

true

是否启用 IPv6。取值范围:

  • true :启用 IPv6。
  • false(默认值):禁用 IPv6。

默认情况下,系统会为边缘实例分配一个公网 IPv4 地址。当您启用 IPv6 时,系统会为边缘实例分配一个公网 IPv4 地址和一个公网 IPv6 地址。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

disable_ipv4

Boolean

false

是否禁用 IPv4。取值范围:

  • true :禁用 IPv4。
  • false(默认值):启用 IPv4。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

custom_internal_interface_name

String

eth0

私网网卡的名称。目前仅 VLANVF 规格实例的私网网卡的名称可以被修改。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

custom_external_interface_name

String

eth1

公网网卡的名称。目前仅 VLANVF 规格实例的公网网卡的名称可以被修改。

dns_type

String

custom

DNS 类型:

  • default:默认 DNS。
  • custom:自定义 DNS。

如果不设置该参数,代表使用默认的 DNS 配置,即首选 DNS 为 114.114.114.114,备用 DNS 为 223.6.6.6。
暂不支持为裸金属实例配置 DNS。当实例规格为裸金属时,无需设置 dns_typedns_list 参数。

dns_list

[]String

["114.114.114.114","223.6.6.6"]

DNS 列表。前面的 IP 地址代表首选 DNS,后面的 IP 地址代表备用 DNS。

说明

  • 当前最多支持一条首选 DNS 和一条备用 DNS。
  • dns_type 设置为 default 时,不允许设置 dns_list。此时,采用默认的 DNS 配置,即首选 DNS 为 114.114.114.114,备用 DNS 为223.6.6.6。
  • dns_type 设置为 custom 时,必须设置 dns_list。至少需要配置一条首选 DNS。可按需配置一条备用 DNS。

secondary_internal_ip_num

Int

5

辅助私网 IP 的个数。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

bound_eip_share_bandwidth_peak

String

300

弹性公网 IP 的共享带宽峰值。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

security_group_id_list

[]String

["veew-sg-22263991211233226410****"]

绑定的全局防火墙的 ID 的列表。

NetworkConfigUpdateReq

名称

类型

是否必选

示例值

描述

bandwidth_peak

String

20

公网带宽峰值。取值范围:[5,实例规格支持的带宽上限]。取值须是 5 的倍数。单位:Mbps。
当您选择 IPv4/IPv6 双栈边缘实例时,所设的带宽峰值将被 IPv4 和 IPv6 公网 IP 地址共享。
disable_ipv4 设置为 true 时,无需配置 bandwidth_peak 参数。

enable_ipv6

Boolean

true

是否启用 IPv6。取值范围:

  • true :启用 IPv6。
  • false(默认值):禁用 IPv6。

默认分配 IPv4 地址。当您启用 IPv6 时,系统会为边缘实例分配 IPv4 和 IPv6 两个公网 IP 地址。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

disable_ipv4

Boolean

false

是否禁用 IPv4。取值范围:

  • true :禁用 IPv4。
  • false(默认值):启用 IPv4。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

custom_internal_interface_name

String

eth0

私网网卡的名称。目前仅 VLANVF 规格实例的私网网卡的名称可以被修改。

说明

您需要提交工单开通相关功能后,该参数才可使用;否则参数值无效。

custom_external_interface_name

String

eth1

公网网卡的名称。目前仅 VLANVF 规格实例的公网网卡的名称可以被修改。

dns_type

String

custom

DNS 类型:

  • default:默认 DNS。
  • custom:自定义 DNS。

如果不设置该参数,代表使用默认的 DNS 配置,即首选 DNS 为114.114.114.114,备用 DNS 为 223.6.6.6。
暂不支持为裸金属实例配置 DNS。当实例规格为裸金属时,无需设置 dns_typedns_list 参数。

dns_list

[]String

["114.114.114.114","223.6.6.6"]

DNS 列表。前面的 IP 地址代表首选 DNS,后面的 IP 地址代表备用 DNS。

说明

  • 当前最多支持一条首选 DNS 和一条备用 DNS。
  • dns_type 设置为 default 时,不允许设置 dns_list。此时,采用默认的 DNS 配置,即首选 DNS 为 114.114.114.114,备用 DNS 为223.6.6.6。
  • dns_type 设置为 custom 时,必须设置 dns_list。至少需要配置一条首选 DNS。可按需配置一条备用 DNS。

security_group_id_list

[]String

["veew-sg-22263991211233226410****"]

绑定的全局防火墙的 ID 的列表。

SecretConfig

名称

类型

是否必选

示例值

描述

secret_type

Integer

2

边缘实例的登录密码的类型。取值范围:

  • 2:自定义密码。
  • 3:SSH Key 类型密码。
  • 4: 代表不注入登录凭证。

secret_data

String

My_password

登录密码。

  • 自定义密码:密码输入规则如下:
    • 允许 8 ~ 30个字符。密码须至少包含以下类型中的3种:大写字母、小写字母、数字和特殊字符。
    • 支持特殊字符 ()`~!@#$%^&*-+=_|{}[]:;'<>,.?/。 |
    • 不能包含双引号(")、反斜线( \)和空格,且不能以正斜线(/)开头。
  • SSH Key 类型密码:输入SSH 密钥对的 ID。您可以通过 ListSSHKey 接口查询密钥对 ID。

InstanceAreaNum

名称

类型

是否必选

示例值

描述

area_name

String

CentralChina

区域名称。您可以通过 ListAvailableResourceInfo 接口查询实例规格支持的区域、城市、运营商、节点信息。

说明

参数 area_nameisp 须组合使用。cluster_name 可单独配置。area_namecluster_name 不能同时配置。

isp

String

CTCC

运营商。您可以通过 ListAvailableResourceInfo 接口查询实例规格支持的区域、城市、运营商、节点信息。

说明

参数 area_nameisp 须组合使用。cluster_name 可单独配置。area_namecluster_name 不能同时配置。

cluster_name

String

wz**-test01

节点名称。指定希望部署边缘服务的节点。您可以通过 ListAvailableResourceInfo 接口查询实例规格支持的区域、城市、运营商、节点信息。

说明

参数 area_nameisp 必须同时使用。cluster_name 可单独使用。area_namecluster_name 不能同时使用。

vpc_identity

String

vpc-8p54gk****

私有网络的 ID。该参数用于指定边缘服务部署到的私有网络。如果设置了 vpc_identity,必须同时设置 cluster_name

num

Integer

5

实例的个数。

host_name_list

[]String

["hosta","hostb"]

主机名的列表。系统按顺序将主机名赋给创建的边缘实例。系统允许您同时使用 host_name_listinstance_host_name 参数。 这两个参数会同时生效,但是 host_name_list 的优先级高于 instance_host_name。举例:如果您批量创建了 3 个边缘实例,将 instance_host_name 指定为了 host,将 host_name_list 指定为了 "hosta","hostb",那么这 3 个边缘实例的名称将分别为 hosta,hostb 和 host-3。

default_isp

String

CTCC

默认运营商。该参数仅适用于三线节点。
取值范围:

  • CMCC
  • CUCC
  • CTCC

注意:

  • external_network_mode 值为 single_interface_cmcc_ipsingle_interface_cucc_ipsingle_interface_ctcc_ip 时,default_isp 中指定的运营商须与 external_network_mode 中指定的运营商相同。
  • external_network_mode 值为 single_interface_multi_ipmulti_interface_multi_ip 时,default_isp 参数必须指定,参数值可按需设置。
  • external_network_mode 值为 single_interface_single_ipno_interface 时,default_isp 无需指定。

说明

如需使用三线节点,请提交工单申请。

external_network_mode

String

single_interface_multi_ip

公网配置。该参数仅适用于三线节点。
取值范围:

  • single_interface_multi_ip:单网卡多 IP。如果您是三线节点的新用户,那么需提交工单开通相关权限。
  • single_interface_cmcc_ip:单网卡移动 IP。需提交工单开通相关权限。
  • single_interface_cucc_ip:单网卡联通 IP。需提交工单开通相关权限。
  • single_interface_ctcc_ip:单网卡电信 IP。需提交工单开通相关权限。
  • multi_interface_multi_ip:多网卡多 IP。需提交工单开通相关权限。
  • single_interface_single_ip:单网卡单 IP。该模式下,系统将根据库存随机分配一个运营商的公网 IP 地址。
  • no_interface:无公网网卡。需提交工单开通相关权限。

默认值:

  • 当有公网网卡时:
    • 单网卡多IP权限开启:默认采用single_interface_multi_ip(单网卡多 IP)。
    • 单网卡多IP权限关闭:默认采用single_interface_single_ip(单网卡单 IP)
  • 无公网网卡时,默认采用 no_interface

说明

如需使用三线节点,请提交工单申请。

ScheduleStrategy

名称

类型

是否必选

示例值

描述

schedule_strategy

String

dispersion

调度策略:

  • dispersion:城市分散。当您在多个区域创建多个边缘实例时,该策略表示系统优先选择不同城市的节点来下发边缘实例。
  • concentration:城市集中。当您在多个区域创建多个边缘实例时,该策略表示系统优先选择相同城市的节点来下发边缘实例。

price_strategy

String

high_priority

价格策略:

  • high_priority:优先高价。当您在多个区域创建多个边缘实例时,该策略表示系统优先选择带宽价格较高的城市的节点来下发边缘实例。
  • low_priority:优先低价。当您在多个区域创建多个边缘实例时,该策略表示系统优先选择带宽价格较低的城市的节点来下发边缘实例。

说明

如果将服务层级指定为城市级,仅支持城市分散、优先低价调度策略且不可修改。

CustomData

名称

类型

是否必选

示例值

描述

data

String

""

自定义数据。自定义数据为边缘实例的定制信息。

CreateCloudServerBillingConfigs

名称

类型

是否必选

示例值

描述

computing_billing_method

String

MonthlyPeak

算力计费方式,取值范围:

  • MonthlyPeak:按月峰值计费。
  • DailyPeak:按日峰值计费。
  • PrePaid:包年包月。当 computing_billing_method 的值为 PrePaid 时, 必须同时指定 pre_paid_periodpre_paid_period_number 参数。

说明

  • 当前只有部分规格的实例支持包年包月的计费方式。
  • 如您有按日峰值计费、包年包月或其他方式计费需求,请提交工单

bandwidth_billing_method

String

MonthlyP95

带宽计费方式,取值范围:

  • MonthlyP95:按月 95 峰值计费。
  • DailyPeak:按日峰值计费。如您有日峰值计费或其他方式计费需求,请提交工单

pre_paid_period

String

monthly

资源的购买时长的单位。在 computing_billing_method 的值为 PrePaid 时,必须指定该参数。取值范围:

  • monthly:月。

pre_paid_period_number

Integer

4

资源的购买时长。在 computing_billing_method 的值为 PrePaid 时,必须指定该参数。取值范围:

  • 1、2、3、4、5、6、7、8、9、12、24、36。

auto_renew

Boolean

true

是否开启自动续费。该参数仅在 computing_billing_method 的值为 PrePaid 时生效。取值范围:

  • true:开启自动续费。
  • false(默认值):不开启自动续费。

AdvancedConfiguration

名称

类型

示例值

描述

instance_name

String

aaaaa

边缘实例的名称。当您批量创建边缘实例时,系统将为自定义实例名称添加数字后缀。举例:<自定义实例名称>-1,<自定义实例名称>-2。

instance_desc

String

test

边缘实例的描述。当您批量创建边缘实例时,系统将为每个实例添加相同的描述。

instance_host_name

String

bbbbb

自定义的主机名。当您批量创建边缘实例时,系统将为自定义主机名称添加数字后缀。举例:<自定义主机名称>-1,<自定义主机名称>-2。

CloudServerBillingConfigs

名称

类型

示例值

描述

computing_billing_method

String

MonthlyPeak

算力计费方式。取值范围:

  • MonthlyPeak:按月峰值计费。
  • DailyPeak:按日峰值计费。
  • PrePaid:包年包月。

说明

  • 当前只有部分规格的实例支持包年包月的计费方式。
  • 如您有按日峰值计费、包年包月或其他方式计费需求,请提交工单

bandwidth_billing_method

String

MonthlyP95

带宽计费方式。取值范围:

  • MonthlyP95:按月 95 峰值计费。
  • DailyPeak:按日峰值计费。如您有日峰值计费或其他方式计费需求,请提交工单

边缘实例请求结构定义

CreateInstanceBillingConfigs

名称

类型

是否必选

示例值

描述

pre_paid_period

String

monthly

资源的购买时长的单位。该参数需要与 pre_paid_period_number 参数一起使用。取值范围:

  • monthly:月

pre_paid_period_number

Integer

4

资源的购买时长。该参数需要与 pre_paid_period 参数一起使用。取值范围:

  • 1、2、3、4、5、6、7、8、9、12、24、36

auto_renew

Boolean

true

是否开启自动续费。取值范围:

  • true:开启自动续费。
  • false(默认值):不开启自动续费。

外网防火墙请求结构定义

RuleParam

名称

类型

是否必选

示例值

描述

direction

String

ingress

外网防火墙规则的方向。取值范围:

  • ingress:入方向。
  • egress:出方向。

protocol

String

TCP

协议。取值范围:

  • TCP
  • UDP
  • ICMP
  • ANY
  • GRE

说明

  • 如需将 protocol 配置为 GRE,请提交工单进行申请。
  • protocol 参数的取值为 ICMPANY时,ports 参数需要设置为 0,代表全部端口。

priority

Integer

100

规则优先级。默认值:100。取值范围:1~100。

说明

只有开通了规则优先级功能后,才需要指定该参数。如果未开通该功能,对参数赋值无效。

ports

String

22,3389

端口。端口之间用半角逗号(,)分隔。
端口范围:1~65535。支持输入单个端口、多个端口、端口段、端口与端口段组合、以及全部端口。示例:

  • 单个端口:例如66。
  • 多个端口:例如66,77,88,99。最多支持5个端口。
  • 端口段:例如66-77,88-99。最多支持5个端口段,且该条规则里端口总数量不能超过1000个。
  • 端口与端口段组合:例如66,77,88-99。最多支持5个端口和端口段的组合使用,且该条规则里端口总数量不能超过1000个。
  • 全部端口:参数值设置为 0,表示全部端口。

ip_cidr

String

0.0.0.0/0

CIDR 地址段。

remark

String

""

外网防火墙规则的描述。

负载均衡请求结构定义

EndpointReq

名称

类型

是否必选

示例值

描述

endpoint_identity

String

veen1128038002028123****

后端服务器的 ID。

endpoint_type

String

veen

后端服务器的类型。取值范围:

  • veen:边缘实例。

port

Integer

80

后端服务器的端口。取值范围:1~65535。

weight

Integer

10

后端服务器的权重。取值范围:0~100。默认值:0

HealthCheck

名称

类型

是否必选

示例值

描述

protocol

String

TCP

健康检查协议。取值范围:

  • TCP
  • UDP
  • HTTP

说明

  • 如果健康检查协议与后端协议不一致,健康检查结果可能会与后端服务器实际状态不同,影响负载均衡流量分发。
  • 当健康检查协议为 HTTP 时,须配置检查路径(http_path)和正常状态码(http_success_codes)。
  • 当健康检查协议为 HTTP 时,可配置 Host 头域(http_host)。

port

Integer

80

健康检查端口。取值范围:1~ 65535。
use_endpoint_port 参数的值为 false 时,必须指定 port

timeout

Integer

10

响应超时时间。取值范围:1~60。单位:秒。 timeout 参数的值需小于 period 参数的值。

period

Integer

20

健康检查间隔。取值范围:1~60。单位:秒。 period 参数的值需大于 timeout 参数的值。

failure_threshold

Integer

2

不健康阈值。取值范围:2~5。超过设置的阈值,后端服务器将被认定为异常,从后端服务器池中移除。

success_threshold

Integer

2

健康阈值。取值范围:2~5。超过设置的阈值,后端服务器将被认定为异常排除,重新加入后端服务器池。

http_host

String

""

发往后端服务器的健康检查请求的 Host 头域。参数值需满足以下要求:

  • 需包含 1~80个字符。
  • 只能包含字母、数字和以下特殊字符:-/.%?#&。

说明

只有健康检查协议为 HTTP 时,可配置 Host 头域。

http_path

String

/

HTTP 检查路径。参数值需满足以下要求:

  • 需包含 1~80个字符。
  • 必须以正斜线(/)开头。
  • 只能包含字母、数字和以下特殊字符:-/.%?#&_;~!()*[]@$^:',+。

说明

当健康检查协议为 HTTP 时,须配置检查路径。

http_success_codes

String

Code2xx

HTTP 正常状态码:

  • Code2xx
  • Code3xx
  • Code4xx
  • Code5xx

说明

当健康检查协议为 HTTP 时,须配置正常状态码。

udp_check_string

String

healthz

UDP 检查字符串。参数值需满足以下要求:

  • 需包含 1~80个字符。
  • 只能包含英文字母,区分大小写。

说明

只有健康检查协议为 UDP 时,可配置检查字符串。

use_endpoint_port

Boolean

false

是否使用后端端口作为健康检查端口。取值范围:

  • true:使用后端端口作为健康检查端口。
  • false:不使用后端端口作为健康检查端口。use_endpoint_port 参数的值为 false 时,必须指定 port

路由表请求结构定义

CreateRouteEntryList

名称

类型

是否必选

示例值

描述

type

String

custom

路由条目的类型。取值范围:

  • custom:自定义路由条目。

dest_cidr

String

114.**.**.0/16

目的地址。目的地址使用 CIDR 格式。不支持 IPv6 地址。

next_hop_type

String

veen

下一跳类型。取值范围:

  • veen:边缘实例。
  • vpc_vgw:边缘云网关。

说明

如需使用边缘云网关服务,请联系客户经理进行申请。

next_hop

String

172.**.**.3

下一跳。

desc

String

test_desc

路由条目的描述。最多可输入 80 个字符。

is_enable

Boolean

true

是否启用路由条目。取值范围:

  • true:启用路由条目。
  • false:不启用路由条目。