## 返回结构头部定义 ### VolcResponseMetadata | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |Action |String |ListLBListeners |接口名称。 | | | | | | \ |Error |[VolcError](/docs/6499/81081#volcerror) |见下文说明 |错误消息。 | | | | | | \ |Region |String |cn-north-1 |请求访问的区域。 | | | | | | \ |RequestId |String |20211213153848010225243081049AAF24 |请求 ID。 | | | | | | \ |Service |String |veenedge |服务名称。 | | | | | | \ |Version |String |2021-04-30 |接口版本。 | ### VolcError | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |CodeN |Integer |100008 |状态码。 | | | | | | \ |Code |String |InvalidActionOrVersion |状态码描述。 | | | | | | \ |Message |String |Could not find operation for version 2021-04-31 |错误消息。 | ## 边缘服务 ### CloudServer | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |cloud_server_identity |String |cloudserver-z6k854srz8c**** |边缘服务的 ID。 | | | | | | \ |name |String |z-cloud |边缘服务的名称。 | | | | | | \ |load_type |String |virtual_machine |边缘实例的类型： |\ | | | | |\ | | | |* **virtual_machine**：虚拟机。 |\ | | | |* **bare_metal**：裸金属。 | | | | | | \ |server_area_count |Integer |1 |边缘服务所在的区域的个数。 | | | | | | \ |instance_count |Integer |1 |边缘服务中的边缘实例的个数。 | | | | | | \ |instance_status |[][CloudServerInstanceStatus](/docs/6499/81081#cloudserverinstancestatus) |见下文说明 |边缘实例的状态。 | | | | | | \ |spec_sum |Map[String]Integer |\ | | |```JSON |\ | | |{ |\ | | | "cpu": 2, |\ | | | "data_disk": 20, |\ | | | "mem": 4, |\ | | | "sys_disk": 40 |\ | | |} |\ | | |``` |\ | | | |\ | | | |边缘服务中的资源的总量： |\ | | | | |\ | | | |* **cpu**：CPU 的总量。单位：核。 |\ | | | |* **data_disk**：数据盘的总量。单位：GB。 |\ | | | |* **mem**：内存的总量。单位：GB。 |\ | | | |* **sys_disk**：系统盘的总量。单位：GB。 | | | | | | \ |spec |String |veEN.C1.large |实例规格的名称。 | | | | | | \ |spec_display |String |计算型2C4G |实例规格的中文名称。 | | | | | | \ |cpu |String |2 |实例的 CPU 配置。 | | | | | | \ |mem |String |4 |实例的内存配置。 | | | | | | \ |image |[ImageConfig](/docs/6499/81081#imageconfig) |见下文说明 |镜像配置。 | | | | | | \ |storage |[StorageConfig](/docs/6499/81081#storageconfig) |见下文说明 |存储配置。 | | | | | | \ |network |[CloudServerNetworkConfig](/docs/6499/81081#cloudservernetworkconfig) |见下文说明 |网络配置。 | | | | | | \ |gpu |[GpuConfig](/docs/6499/81081#gpuconfig) |见下文说明 |GPU 配置。 | | | | | | \ |secret_config |[SecretConfig](/docs/6499/81081#secretconfig) |见下文说明 |密码配置。 | | | | | | \ |custom_data |[CustomData](/docs/6499/81081#customdata) |见下文说明 |自定义数据。 | | | | | | \ |billing_config |[CloudServerBillingConfigs](/docs/6499/81081#cloudserverbillingconfigs) |见下文说明 |计费方式。 | | | | | | \ |desc |\ | |String |这是一个描述 |边缘服务的描述。 | | | | | | \ |arch |String |x86 |边缘实例的架构。 | | | | | | \ |advanced_configuration |[AdvancedConfiguration](/docs/6499/81081#advancedconfiguration) |见下文说明 |高级配置，包括边缘实例名称、实例描述信息、主机名等。 | | | | | | \ |schedule_strategy_configs |[ScheduleStrategy](/docs/6499/81081#schedulestrategy) |见下文说明 |调度策略配置。 | | | | | | \ |server_areas |[][CloudServerArea](/docs/6499/81081#cloudserverarea) |见下文说明 |边缘服务所在的地域的信息。 | | | | | | \ |create_time |Integer |1637288501 |创建时间，以 UNIX 时间戳格式显示。 | | | | | | \ |update_time |Integer |1637288501 |更新时间，以 UNIX 时间戳格式显示。 | | | | | | \ |project |String |default |边缘服务所属的项目。 | | | | | | \ |instance_project |String |default |边缘实例所属的项目。 | | | | | | \ |Tags |[][Tag](/docs/6499/81081#tag) |```JSON |\ | | |{ |\ | | | { |\ | | | "Key": "test_key1", |\ | | | "Value": "test_value1" |\ | | | }, |\ | | | { |\ | | | "Key": "test_key2", |\ | | | "Value": "test_value2" |\ | | | } |\ | | |} |\ | | |``` |\ | | | |边缘服务的标签。 | ### CloudServerInstanceStatus | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |status |String |running |边缘实例的状态： |\ | | | | |\ | | | |* **opening**：创建中。 |\ | | | |* **starting**：启动中。 |\ | | | |* **running**：运行中。 |\ | | | |* **stopping**：停止中。 |\ | | | |* **stop**：已停止。 |\ | | | |* **rebooting**：重启中。 |\ | | | |* **terminating**：删除中。 |\ | | | |* **open_fail**：创建失败。 | | | | | | \ |instance_count |Integer |1 |处于该状态的边缘实例的个数。 | ### ImageConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |image_identity |String |imagelsoun**** |镜像的 ID。 | | | | | | \ |image_name |String |centos-6.8-amd64 |镜像的名称。 | | | | | | \ |system_arch |String |Linux |操作系统的架构。 | | | | | | \ |system_type |String |CentOS |操作系统的类型。 | | | | | | \ |system_bit |String |64位 |操作系统的位数。 | | | | | | \ |system_version |String |6.8 |操作系统的版本。 | | | | | | \ |property |\ | |String |PublicBaseImage |镜像的属性： |\ | | | | |\ | | | |* **BENBuildImage**：通过边缘实例创建的镜像。 |\ | | | |* **LocalImage**：本地镜像。 |\ | | | |* **PublicBaseImage**：公共镜像。 |\ | | | |* **UrlImage**：通过 URL 上传的镜像。 | | | | | | \ |disable_vga |Boolean |false |\ | | | |是否禁用 VGA。取值范围： |\ | | | |- **true**：禁用VGA。 |\ | | | |- **false**：启用VGA。 |\ | | | |:::tip |\ | | | |仅GPU类型实例支持该功能。如需使用GPU类型实例，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 |\ | | | |::: | | | | | | \ |image_boot_mode |String |BIOS |镜像启动模式： |\ | | | | |\ | | | |* BIOS |\ | | | |* UEFI | ### StorageConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |system_disk |[DiskSpec](/docs/6499/81081#diskspec) |```JSON |\ | | |{ |\ | | | "system_disk": { |\ | | | "capacity": "40", |\ | | | "storage_type": "CloudBlockSSD" |\ | | | } |\ | | |} |\ | | |``` |\ | | | |\ | | | |系统盘。 | | | | | | \ |data_disk |\ | |[DiskSpec](/docs/6499/81081#diskspec) |\ | | |```JSON |\ | | |{ |\ | | | "data_disk": { |\ | | | "capacity": "20", |\ | | | "storage_type": "CloudBlockSSD" |\ | | | } |\ | | |} |\ | | |``` |\ | | | |\ | | | |数据盘。 |\ | | | | | | | | | | \ |data_disk_list |\ | |[][DiskSpec](/docs/6499/81081#diskspec) |\ | | |```JSON |\ | | |{ |\ | | | "data_disk_list":[ |\ | | | { |\ | | | "capacity": "20", |\ | | | "storage_type": "CloudBlockSSD" |\ | | | }， |\ | | | { |\ | | | "capacity": "40", |\ | | | "storage_type": "CloudBlockSSD" |\ | | | } |\ | | | ] |\ | | |} |\ | | |``` |\ | | | |\ | | | |数据盘列表。 | ### DiskSpec | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |storage_type |String |CloudBlockHDD |磁盘类型。 |\ | | | | |\ | | | |* **CloudBlockHDD**：HDD 型云盘。 |\ | | | |* **CloudBlockSSD**：SSD 型云盘。 | | | | | | \ |capacity |String |40 |磁盘容量。单位：GB。 | ### CloudServerNetworkConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |bandwidth_peak |\ | |String |20 |公网带宽峰值。取值范围：[5,实例规格支持的带宽上限]。取值须是 5 的倍数。单位：Mbps。 |\ | | | |当您选择 IPv4/IPv6 双栈边缘实例时，所设的带宽峰值将被 IPv4 和 IPv6 公网 IP 地址共享。 | | | | | | \ |internal_bandwidth_peak |String |500 |内网带宽峰值。单位：Mbps。 |\ | | | |新创建的边缘实例的内网带宽峰值默认为实例规格支持的最大内网带宽峰值。不同实例规格支持的带宽峰值有所不同。 | | | | | | \ |vf_passthrough |Boolean |false |是否是 VF 直通类型： |\ | | | | |\ | | | |* **true**：VF 直通类型。 |\ | | | |* **false**：非 VF 直通类型。 | | | | | | \ |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 |私网网卡的名称。 | | | | | | \ |custom_external_interface_name |String |eth1 |公网网卡的名称。 | | | | | | \ |dns_type |String |custom |DNS 类型： |\ | | | | |\ | | | |* **default**：默认 DNS。默认的 DNS 配置：首选 DNS 为114.114.114.114，备用 DNS 为 180.184.1.1。 |\ | | | |* **custom**：自定义 DNS。 | | | | | | \ |dns_list |[]String |["114.114.114.114","180.184.1.1"] |DNS 列表。前面的 IP 地址代表首选 DNS，后面的 IP 地址代表备用 DNS。 |\ | | | | | | | | | | \ |secondary_internal_ip_num |Integer |5 |辅助私网 IP 的个数。 |\ | | | |:::tip |\ | | | |需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关功能后，该参数才可使用。 |\ | | | |::: | | | | | | \ |bound_eip_share_bandwidth_peak |String |300 |弹性公网 IP 的共享带宽峰值。 |\ | | | |:::tip |\ | | | |需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关功能后，该参数才可使用。 |\ | | | |::: | | | | | | \ |udp_timeout |Integer |60 |边缘实例的 UDP 会话超时时间。单位：秒。 | | | | | | \ |tcp_timeout |Integer |60 |边缘实例的 TCP 连接超时时间。单位：秒。 | ### GpuConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |gpus |[][GpuSpecWithNum](/docs/6499/81081#gpuspecwithnum) |见下文说明 |GPU 规格信息。 | ### GpuSpecWithNum | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |gpu_spec |[GpuSpec](/docs/6499/81081#gpuspec) |见下文说明 |GPU 规格。 | | | | | | \ |num |Integer |1 |GPU 个数。 | ### GpuSpec | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |gpu_type |String |GPU_T4 |GPU 类型。 | ### SecretConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |secret_type |\ | |Integer |2 |边缘实例的登录密码类型： |\ | | | | |\ | | | |* **2**：自定义密码。 |\ | | | |* **3**：SSH Key 类型密码。 |\ | | | |* **4**: 代表不注入登录凭证。 | | | | | | \ |secret_data |\ | |String |sshkey-4ht47hq65z9**** |该参数仅在登录密码类型为 SSH Key 时有返回值。返回值代表密钥对的 ID。 | ### CustomData | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |data |String |"" |自定义数据。自定义数据为用户设置的边缘实例的定制信息。首次启动实例时，自定义数据将会作为脚本执行。 | ### CloudServerBillingConfigs | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |computing_billing_method |\ | |String |MonthlyPeak |算力计费方式： |\ | | | | |\ | | | |* **MonthlyPeak**：按月峰值计费。 |\ | | | |* **DailyPeak**：按日峰值计费。 |\ | | | |* **PrePaid**：包年包月。 | | | | | | \ |bandwidth_billing_method |String |MonthlyP95 |带宽计费方式： |\ | | | | |\ | | | |* **DailyPeak**：按日峰值计费。 |\ | | | |* **MonthlyP95**：按月 95 峰值计费。 | ### AdvancedConfiguration | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |instance_name |String |aaaaa |边缘实例的名称。 | | | | | | \ |instance_desc |String |test |边缘实例的描述。 | | | | | | \ |instance_host_name |String |bbbbb |自定义的主机名。 | | | | | | \ |delete_protection |Boolean |false |是否为边缘服务开启了删除保护： |\ | | | | |\ | | | |* **true**：已开启删除保护。 |\ | | | |* **false**：未开启删除保护。 | ### ScheduleStrategy | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |schedule_strategy |\ | |String |dispersion |调度策略： |\ | | | | |\ | | | |* **dispersion**：城市分散。当您在多个区域创建多个边缘实例时，该策略表示系统优先选择不同城市的节点来下发边缘实例。 |\ | | | |* **concentration**：城市集中。当您在多个区域创建多个边缘实例时，该策略表示系统优先选择相同城市的节点来下发边缘实例。 | | | | | | \ |price_strategy |\ | |String |\ | | |high_priority |价格策略： |\ | | | | |\ | | | |* **high_priority**：优先高价。当您在多个区域创建多个边缘实例时，该策略表示系统优先选择带宽价格较高的城市的节点来下发边缘实例。 |\ | | | |* **low_priority**：优先低价。当您在多个区域创建多个边缘实例时，该策略表示系统优先选择带宽价格较低的城市的节点来下发边缘实例。 |\ | | | | |\ | | | |:::tip |\ | | | |如果将服务层级指定为城市级，仅支持城市分散、优先低价调度策略且不可修改。 |\ | | | |::: | ### CloudServerArea | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |area |String |CentralChina |区域或城市。 | | | | | | \ |isp |String |CUCC |运营商。 | | | | | | \ |cluster_name |String |nbct-01 |节点名称。 | | | | | | \ |cluster_alias |String |宁波电信01 |节点的中文名称。 | | | | | | \ |instance_num |Integer |1 |边缘实例的个数。 | ### InstanceTypeConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |instance_type |String |veEN.G1.large |实例规格。 | | | | | | \ |instance_type_family |String |G |实例规格族。 | | | | | | \ |cpu |Int16 |2 |CPU 核数。 | | | | | | \ |memory |Int16 |8 |内存容量。单位：GB。 | | | | | | \ |gpu |Integer |1 |GPU 个数。 | | | | | | \ |gpu_spec |String |GPU_T4 |GPU 规格。 | | | | | | \ |instance_type_family_name |String |通用型 |实例规格族的中文名称。 | | | | | | \ |arch |String |x86 |实例架构。 | | | | | | \ |storage_info |[][StorageInfo](/docs/6499/81081#storageinfo) |见下文说明 |本地盘的列表。该参数仅在实例是本地盘类型时会返回。 | ### StorageInfo | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |local_storage_category |String |LocalSSD |磁盘的类型： |\ | | | | |\ | | | |* LocalSSD：SSD 型本地盘。 |\ | | | |* LocalHDD：HDD 型本地盘。 | | | | | | \ |local_storage_capacity |Integer |950 |磁盘的容量。 | | | | | | \ |local_storage_amount |Integer |2 |磁盘的数量。 | | | | | | \ |local_storage_unit |String |GB |磁盘容量的单位。 | ### RegionInfo | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |country |[GeoInfo](/docs/6499/81081#geoinfo) |见下文说明 |国家。 | | | | | | \ |area |[GeoInfo](/docs/6499/81081#geoinfo) |见下文说明 |区域名称。 | | | | | | \ |city |[GeoInfo](/docs/6499/81081#geoinfo) |见下文说明 |城市。 | | | | | | \ |isp |[GeoInfo](/docs/6499/81081#geoinfo) |见下文说明 |运营商。 | | | | | | \ |cluster |[GeoInfo](/docs/6499/81081#geoinfo) |见下文说明 |节点信息。 | | | | | | \ |available_num |Integer |1 |可用节点的个数。当服务层级为大区级时，该参数不可见。 | ### GeoInfo | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |id |String |EastChina |地域的 ID。地域包括国家、区域、城市、运营商、节点。 | | | | | | \ |name |String |华东大区 |地域的中文名称。 | | | | | | \ |en_name |String |EastChina |地域的英文名称。 | ### Tag | | | | | | \ |**名称** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| | | | | | | \ |Key |String |是 |"test_key" |标签键。 | | | | | | | \ |Value |String |否 |"test_value" |标签值。 | ## 边缘实例 ### VEENInstance | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |instance_identity |String |veen21130201615222**** |边缘实例的 ID。 | | | | | | \ |instance_uuid |String |67a7f071-6403-5a9e-826a-3e68cf9e**** |边缘实例的 UUID。 | | | | | | \ |instance_name |String |test |边缘实例的名称。 | | | | | | \ |load_type |String |virtual_machine |边缘实例的类型： |\ | | | | |\ | | | |* **virtual_machine**：虚拟机。 |\ | | | |* **bare_metal**：裸金属。 | | | | | | \ |cloud_server_identity |String |cloudserver-7wcqrqr425t5**** |边缘服务的 ID。 | | | | | | \ |cloud_server_name |String |new-cloud |边缘服务的名称。 | | | | | | \ |vpc_identity |String |vpc-8jxzl**** |私有网络的 ID。 | | | | | | \ |subnet_cidr |String |172.\*\*.\*\*.128/26 |子网 CIDR。 | | | | | | \ |cluster |[VEENCluster](/docs/6499/81081#veencluster) |见下文说明 |边缘实例所在节点的信息。 | | | | | | \ |spec |String |veEN.G1.large |边缘实例规格。 | | | | | | \ |spec_display |String |通用型2C8G |实例规格的中文名称。 | | | | | | \ |cpu |String |2 |边缘实例的 CPU 核数。 | | | | | | \ |mem |String |4 |边缘实例的内存大小。单位：GB。 | | | | | | \ |status |String |running |边缘实例的状态： |\ | | | | |\ | | | |* **opening**：创建中。 |\ | | | |* **starting**：启动中。 |\ | | | |* **running**：运行中。 |\ | | | |* **stopping**：停止中。 |\ | | | |* **stop**：已停止。 |\ | | | |* **rebooting**：重启中。 |\ | | | |* **terminating**：删除中。 |\ | | | |* **open_fail**：创建失败。 | | | | | | \ |creator |String |admin |边缘实例的创建者。 | | | | | | \ |image |[ImageConfig](/docs/6499/81081#imageconfig) |见下文说明 |边缘实例的镜像配置。 | | | | | | \ |storage |[StorageConfig](/docs/6499/81081#storageconfig) |见下文说明 |边缘实例的存储配置。 | | | | | | \ |network |[NetworkConfig](/docs/6499/81081#networkconfig) |见下文说明 |边缘实例的网络配置。 | | | | | | \ |gpu |[GpuConfig](/docs/6499/81081#gpuconfig) |见下文说明 |边缘实例的 GPU 配置。 | | | | | | \ |secret |[SecretConfig](/docs/6499/81081#secretconfig) |\ | | |见下文说明 |边缘实例的密码配置。 | | | | | | \ |billing |[InstanceBillingConfig](/docs/6499/81081#instancebillingconfig) |见下文说明 |边缘实例的计费配置。 | | | | | | \ |instance_desc |String |这是一个实例描述 |边缘实例的描述。 | | | | | | \ |host_name |String |hosta |边缘实例的主机名。 | | | | | | \ |arch |String |x86 |\ | | | |边缘实例的架构： |\ | | | | |\ | | | |* arm：ARM |\ | | | |* x86：x86 |\ | | | |* bare_metal：裸金属 |\ | | | | |\ | | | |:::tip |\ | | | |如需使用 ARM 和裸金属实例，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 |\ | | | |::: | | | | | | \ |monitor_agent | [MonitorAgentConfig](/docs/6499/81081#monitoragentconfig) |\ | | |```JSON |\ | | |{ |\ | | | "agent_status": "running" |\ | | |} |\ | | |``` |\ | | | |\ | | | |监控 Agent 的信息。 | | | | | | \ |project |String |default |边缘实例所属的项目。 | | | | | | \ |advanced_configuration |[InstanceAdvancedConfiguration](/docs/6499/81081#instanceadvancedconfiguration) |```JSON |\ | | |"advanced_configuration": { |\ | | | "delete_protection": false |\ | | |} |\ | | |``` |\ | | | |边缘实例的高级配置，如删除保护。 | | | | | | \ |Tags |[][Tag](/docs/6499/81081#tag) |```JSON |\ | | |{ |\ | | | { |\ | | | "Key": "test_key1", |\ | | | "Value": "test_value1" |\ | | | }, |\ | | | { |\ | | | "Key": "test_key2", |\ | | | "Value": "test_value2" |\ | | | } |\ | | |} |\ | | |``` |\ | | | |边缘实例的标签。 | | | | | | \ |start_time |Integer |1634108917 |边缘实例的启动时间。 | | | | | | \ |end_time |Integer |0 |边缘实例的运行结束时间。 | | | | | | \ |create_time |Integer |1634108660 |边缘实例的创建时间。 | | | | | | \ |update_time |Integer |1635474133 |边缘实例的更新时间。 | ### VEENCluster | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |cluster_name |String |nb**05 |节点的名称。 | | | | | | \ |country |String |CN |节点所在的国家。 | | | | | | \ |region |String |EastChina |节点所在的区域。 | | | | | | \ |province |String |ZJ |节点所在的省份。 | | | | | | \ |city |String |330200 |节点所在的城市。 | | | | | | \ |isp |String |CTCC |节点的网络运营商。 | | | | | | \ |level |String |2 |节点的计费类别： |\ | | | | |\ | | | |* 1：北上广 |\ | | | |* 2：地区中心 |\ | | | |* 3：一般城市 | | | | | | \ |alias |String |浙江宁波电信 |节点的别名。 | ### ImageConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |image_identity |String |imagelsoun**** |镜像的 ID。 | | | | | | \ |image_name |String |centos-6.8-amd64 |镜像的名称。 | | | | | | \ |system_arch |String |Linux |操作系统的架构。 | | | | | | \ |system_type |String |CentOS |操作系统的类型。 | | | | | | \ |system_bit |String |64位 |操作系统的位数。 | | | | | | \ |system_version |String |6.8 |操作系统的版本。 | | | | | | \ |property |String |PublicBaseImage |镜像的属性： |\ | | | | |\ | | | |* **BENBuildImage**：通过边缘实例创建的镜像。 |\ | | | |* **LocalImage**：本地镜像。 |\ | | | |* **PublicBaseImage**：公共镜像。 |\ | | | |* **UrlImage**：通过 URL 上传的镜像。 | | | | | | \ |disable_vga |\ | |Boolean |\ | | |false |是否禁用 VGA： |\ | | | |- **true**：禁用VGA。 |\ | | | |- **false**：启用VGA。 |\ | | | |:::tip |\ | | | |仅GPU类型实例支持该功能。如需使用GPU类型实例，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 |\ | | | |::: | | | | | | \ |image_boot_mode |String |BIOS |镜像启动模式： |\ | | | | |\ | | | |* BIOS |\ | | | |* UEFI | | | | | | \ |gpu_version_info |[GpuVersionInfo](/docs/6499/81081#782917bc) |见下文说明 |GPU 版本信息。 |\ | | | |:::tip |\ | | | |该参数仅适用于 GPU 类型实例。 |\ | | | |::: | ### GpuVersionInfo | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |driver_version |String |520.61.05 |GPU 驱动版本。 | | | | | | \ |cuda_version |String |11.8.0 |CUDA 版本。 | | | | | | \ |cudnn_version |String |8.9.0.131 |cuDNN 版本。 | ### StorageConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |system_disk |[DiskSpec](/docs/6499/81081#diskspec-2) |见下文说明 |系统盘。 | | | | | | \ |data_disk |[DiskSpec](/docs/6499/81081#diskspec-2) |见下文说明 |数据盘。 | | | | | | \ |data_local_disks |[][DiskSpecWithNum](/docs/6499/81081#diskspecwithnum) |见下文说明 |本地数据盘列表。 | | | | | | \ |data_disk_list |[DiskSpec](/docs/6499/81081#diskspec-2) |见下文说明 |数据盘列表。 | ### DiskSpec | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |storage_type |\ | |String |CloudBlockHDD |磁盘类型： |\ | | | | |\ | | | |* **CloudBlockHDD**：HDD 型云盘。 |\ | | | |* **CloudBlockSSD**：SSD 型云盘。 | | | | | | \ |capacity |String |20 |磁盘容量。单位：GB。 | ### DiskSpecWithNum | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |disk_spec |[DiskSpec](/docs/6499/81081#diskspec-2) |参见[DiskSpec](/docs/6499/81081#diskspec-2) |磁盘规格。 | | | | | | \ |num |Integer |1 |磁盘个数。 | ### NetworkConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |internal_interface |[NetworkInterfaceConfig](/docs/6499/81081#networkinterfaceconfig) |见下文说明 |私网网卡的配置。 | | | | | | \ |external_interface |[NetworkInterfaceConfig](/docs/6499/81081#networkinterfaceconfig) |见下文说明 |公网网卡的配置。 |\ | | | | | | | | | | \ |external_interfaces |[NetworkInterfaceConfig](/docs/6499/81081#networkinterfaceconfig) |见下文说明 |公网网卡的列表。 | | | | | | \ |vf_passthrough |\ | |Boolean |false |是否是 VF 直通类型： |\ | | | | |\ | | | |* **true**： VF 直通类型。 |\ | | | |* **false**：非 VF 直通类型。 | | | | | | \ |vlan_vf_passthrough |Boolean |false |是否是 VLAN VF 直通类型： |\ | | | | |\ | | | |* **true**：VLAN VF 直通类型。 |\ | | | |* **false**：非 VLAN VF 直通类型。 | | | | | | \ |external_network_mode |String |single_interface_multi_ip |多线节点的公网配置。 |\ | | | |取值范围： |\ | | | | |\ | | | |* **single_interface_multi_ip**：单网卡多 IP。 |\ | | | |* **single_interface_cmcc_ip**：单网卡移动 IP。需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关权限。 |\ | | | |* **single_interface_cucc_ip**：单网卡联通 IP。需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关权限。 |\ | | | |* **single_interface_ctcc_ip**：单网卡电信 IP。需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关权限。 |\ | | | |* **multi_interface_multi_ip**：多网卡多 IP。需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关权限。 |\ | | | |* **no_interface**：无公网网卡。需[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关权限。 |\ | | | | |\ | | | |若不配置该参数： |\ | | | | |\ | | | |* 当有公网网卡时，默认采用 **single_interface_multi_ip。** |\ | | | |* 无公网网卡时，默认采用 **no_interface**。 |\ | | | | |\ | | | |:::tip |\ | | | |如需使用多线节点，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 |\ | | | |::: | | | | | | \ |disable_ipv4 |Boolean |false |\ | | | |是否禁用 IPv4。取值范围： |\ | | | | |\ | | | |* **true** ：禁用 IPv4。 |\ | | | |* **false** （默认值）：启用 IPv4。 |\ | | | | |\ | | | |:::tip |\ | | | |您需要[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)开通相关功能后，该参数才可使用；否则参数值无效。 |\ | | | |::: | | | | | | \ |enable_ipv6 |Boolean |false |是否开启了 IPv6： |\ | | | | |\ | | | |* **true**：已开启 IPv6。 |\ | | | |* **false**：未开启 IPv6。 | | | | | | \ |default_isp |String |CTCC |默认运营商。使用多线节点时，可配置该参数。配置后，该运营商将作为默认出口。 |\ | | | |:::tip |\ | | | |如需使用多线节点，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 |\ | | | |::: | | | | | | \ |wanted_secondary_ip_num |\ | |Integer |\ | | |6 |\ | | | |所需辅助私网 IP 地址的数量。 |\ | | | | | | | | | | \ |actual_secondary_ip_num |Integer |3 |实际已分配的辅助私网 IP 地址的数量。 | | | | | | \ |custom_internal_interface_name |String |eth0 |私网网卡的名称。 | | | | | | \ |custom_external_interface_name |String |eth1 |公网网卡的名称。 | | | | | | \ |dns_type |String |custom |DNS 类型： |\ | | | | |\ | | | |* **default**：默认 DNS。默认的 DNS 配置：首选 DNS 为 114.114.114.114，备用 DNS 为 180.184.1.1。 |\ | | | |* **custom**：自定义 DNS。 | | | | | | \ |dns_list |[]String |["114.114.114.114","180.184.1.1"] |DNS 列表。前面的 IP 地址代表首选 DNS，后面的 IP 地址代表备用 DNS。 | | | | | | \ |bandwidth_peak_update_status |String |ready |带宽峰值更新状态： |\ | | | | |\ | | | |* **updating**：更新中。 |\ | | | |* **ready**：更新完成。 | | | | | | \ |limit_mode |String |shared |限速模式。 |\ | | | | |\ | | | |* **shared**：共享限速。各运营商共享带宽资源。 |\ | | | |* **isp**：按运营商限速。您为每个运营商分别设置的带宽峰值。 |\ | | | | |\ | | | |:::tip |\ | | | |只有多线节点支持限速模式的配置。 |\ | | | |::: | | | | | | \ |udp_timeout |Integer |60 |边缘实例的 UDP 会话超时时间。单位：秒。 | | | | | | \ |tcp_timeout |Integer |60 |边缘实例的 TCP 连接超时时间。单位：秒。 | ### NetworkInterfaceConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |ip_addr |String |172.31.\*\*.\*\* |IPv4 地址。 | | | | | | \ |mask |String |26 |IPv4 掩码。 | | | | | | \ |ip6_addr |String |2408:8720:1:502:8000::\*\*\:*\* |IPv6 地址。 | | | | | | \ |mask6 |String |65 |IPv6 掩码。 | | | | | | \ |ips |[][IP](/docs/6499/81081#ip) |见下文说明 |IP 地址列表。 | | | | | | \ |mac_addr |String |0a:58:b7:83:\*\*:\*\* |网卡的 MAC 地址。 | | | | | | \ |bandwidth_peak |String |20 |带宽峰值。 | ### IP | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |addr |String |172.31.\*\*.\*\* |IP 地址。 | | | | | | \ |mask |String |26 |掩码。 | | | | | | \ |isp |String |CUCC |运营商。 | | | | | | \ |ip_version |String |IPv4 |IP 地址版本。 | | | | | | \ |primary |Boolean |true |是否为主私网 IP 地址： |\ | | | | |\ | | | |* **true**：主私网 IP 地址。 |\ | | | |* **false**：非主私网 IP 地址。 | ### GpuConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |gpus |[][GpuSpecWithNum](/docs/6499/81081#gpuspecwithnum) |见下文说明 |GPU 规格列表。 | ### GpuSpecWithNum | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |gpu_spec |[GpuSpec](/docs/6499/81081#gpuspec) |见下文说明 |GPU 规格。 | | | | | | \ |num |Integer |1 |GPU 的个数。 | ### GpuSpec | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |gpu_type |String |GPU_T4 |GPU 类型。 | ### SecretConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |secret_type |\ | |Integer |2 |边缘实例的登录密码类型： |\ | | | | |\ | | | |* **2**：自定义密码。 |\ | | | |* **3**：SSH Key 类型密码。 |\ | | | |* **4**: 代表不注入登录凭证。 | | | | | | \ |secret_data |\ | |String |sshkey-4ht47hq65z9**** |该参数仅在登录密码类型为 SSH Key 时有返回值。返回值代表密钥对的 ID。 | ### MonitorAgentConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |agent_status |\ | |String |running |监控 Agent 的状态： |\ | | | | |\ | | | |* **running**：运行中 |\ | | | |* **stopped**：未运行 |\ | | | | |\ | | | |如果返回值为空字符串，代表 Agent 未运行。 | ### InstanceBillingConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |computing_billing_method |\ | |String |MonthlyPeak |算力计费方式，取值范围： |\ | | | | |\ | | | |* **MonthlyPeak**：按月峰值计费。 |\ | | | |* **DailyPeak**：按日峰值计费。如您有日峰值计费或其他方式计费需求，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)。 |\ | | | |* **PrePaid**：包年包月。 | | | | | | \ |bandwidth_billing_method |String |MonthlyP95 |带宽计费方式，取值范围： |\ | | | | |\ | | | |* **MonthlyP95**：按月 95 峰值计费。 |\ | | | |* **DailyPeak**：按日峰值计费。如您有日峰值计费或其他方式计费需求，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)。 | ### InstanceAdvancedConfiguration | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |delete_protection |Boolean |false |边缘实例是否已开启删除保护。 |\ | | | | |\ | | | |* **true**：已开启。 |\ | | | |* **false**：未开启。 | ### CloudDiskInfo | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |storage_type |String |CloudBlockSSD |存储类型。 | | | | | | \ |capacity |String |1000 |容量。单位：GB | | | | | | \ |device_name |String |vda |设备名称。 | ### InstanceEnableIPv6Status | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |instance_identity |String |veen1020125208252511**** |边缘实例的 ID。 | | | | | | \ |instance_name |String |instance_test01 |边缘实例的名称。 | | | | | | \ |enable_status |String |success |边缘实例的 IPv6 开启状态： |\ | | | | |\ | | | |* **success**：IPv6 开启成功。 |\ | | | |* **fail**：IPv6 开启失败。 |\ | | | |* **upgrading**：IPv6 开启中。 | | | | | | \ |remark |String |"" |失败原因。如果开启 IPv6 失败，系统会返回失败原因。 | ### InternalIP | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |addr |String |172.\*\*.\*\*.2 |私网 IP 地址。 | | | | | | \ |mask |String |26 |掩码。 | | | | | | \ |ip_version |String |ipv4 |IP 地址版本： |\ | | | | |\ | | | |* **ipv4**：IPv4 地址。 |\ | | | |* **ipv6**：IPv6 地址。 | | | | | | \ |primary |Boolean |false |是否为主私网 IP 地址： |\ | | | | |\ | | | |* **true**：主私网 IP 地址。 |\ | | | |* **false**：非主私网 IP 地址。 | | | | | | \ |status |String |bound |\ | | | |IP 地址的状态： |\ | | | | |\ | | | |* **allocating**：分配中。 |\ | | | |* **unbound**：未绑定。 |\ | | | |* **binding**：绑定中。 |\ | | | |* **bound**：已绑定。 |\ | | | |* **unbinding**：解绑中。 |\ | | | |* **deleting**：删除中。 |\ | | | |* **allocate_fail**：分配失败。 |\ | | | |* **bind_fail**：绑定失败。 | | | | | | \ |bound_eip_identity |String |eip-vt4xhks**** |绑定的弹性公网 IP 的 ID。 | | | | | | \ |bound_eip_addr |String |223.\*\*.\*\*.105 |绑定的弹性公网 IP 的地址。 | | | | | | \ |bound_eip_name |String |测试EIP |绑定的弹性公网 IP 的名称。 | ## 密钥 ### SSHKey | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |key_pair_identity |String |sshkey-5x5sdlm2k2f**** |密钥对的 ID。 | | | | | | \ |key_pair_name |String |new_key |密钥对的名称。 | | | | | | \ |fingerprint |String |0277b9039b2a3dba513b78afd25e**** |密钥对的指纹。 | | | | | | \ |create_time |Integer |1639362125 |密钥对的创建时间。 | | | | | | \ |tags |Map[String]String |```JSON |\ | | |{ |\ | | | "foo": "bar" |\ | | |} |\ | | |``` |\ | | | |\ | | | |标签。 |\ | | | | | | | | | | \ |used |Boolean |false |密钥对的使用状态： |\ | | | | |\ | | | |* **true**：密钥对已被使用。 |\ | | | |* **false**：密钥对未被使用。 | ### SSHKeyPair | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |key_pair_identity |String |sshkey-5x5sdlm2k2f**** |密钥对的 ID。 | | | | | | \ |private_key |String |-----BEGIN RSA PRIVATE KEY-----\nMIIEpAIBAAKCAQEAtE5g06d2z0dxJ/ER6heDdvhIck6atZdAUe****\==\n-----END RSA PRIVATE KEY-----\n |私钥。 | ## 镜像 ### Image | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |id |String |imagespnwnf**** |镜像的 ID。 | | | | | | \ |name |String |newimage |镜像的名称。 | | | | | | \ |description |String |This is basic image |镜像的描述。 | | | | | | \ |system_arch |Integer |Linux |操作系统的架构。 | | | | | | \ |system_bit |String |64位 |操作系统的位数。 | | | | | | \ |system_type |String |CentOS |操作系统的类型。 | | | | | | \ |system_version |String |8.3 |操作系统的版本。 | | | | | | \ |disk_size |Integer |50 |镜像的磁盘的大小。单位：GB。 | | | | | | \ |property |String |UrlImage |镜像属性： |\ | | | | |\ | | | |* **PublicBaseImage**：公共镜像。 |\ | | | |* **LocalImage**：本地镜像。 |\ | | | |* **UrlImage**：通过 URL 上传的镜像。 |\ | | | |* **BENBuildImage**：通过边缘实例创建的镜像。 | | | | | | \ |status |String |Online |镜像状态： |\ | | | | |\ | | | |* **Online**：镜像在线。 |\ | | | |* **Uploading**：镜像上传中。 |\ | | | |* **Building**：镜像构建中。 |\ | | | |* **Rebuilding**：镜像重新构建中。 |\ | | | |* **BuildError**：镜像构建失败。 |\ | | | |* **UploadError**：镜像上传失败。 |\ | | | |* **RebuildError**：镜像重新构建失败。 |\ | | | |* **Offline**：镜像下线。 | | | | | | \ |is_enable |Boolean |false |镜像是否已启用： |\ | | | | |\ | | | |* **true**：镜像已启用。 |\ | | | |* **false**：镜像未启用。 | | | | | | \ |label |Map[String]String |{"IPV6": ""} |镜像标签： |\ | | | | |\ | | | |* **IPV6**：IPv6。 |\ | | | |* **MultiIPPriNet**：辅助私网 IP。 | | | | | | \ |create_time |String |2022-07-05T11:28:51+08:00 |镜像的创建时间。 | | | | | | \ |update_time |String |2022-07-05T11:47:00+08:00 |镜像的更新时间。 | | | | | | \ |boot_mode |String |BIOS |镜像启动模式： |\ | | | | |\ | | | |* BIOS |\ | | | |* UEFI | ## 计费用量 ### VEENInstanceUsage | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |bill_cycle |String |2021-10 |账单周期。 | | | | | | \ |bill_start_time |String |2021-10-15 |账单的开始时间。 | | | | | | \ |bill_end_time |String |2021-10-31 |账单的结束时间。 | | | | | | \ |usage |Map[String]Float64 |```JSON |\ | | |{ |\ | | | "CPU": 6, |\ | | | "CloudHDD": 60, |\ | | | "CloudSSD": 120, |\ | | | "GPU_T4": 0, |\ | | | "InstanceCount": 0, |\ | | | "LocalHDD": 0, |\ | | | "LocalSSD": 0, |\ | | | "MEM": 12 |\ | | |} |\ | | |``` |\ | | | |\ | | | |用量信息。 | ### VEEWInstanceUsage | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |bill_cycle |String |2021-12 |账单周期。 | | | | | | \ |bill_start_time |String |2021-12-01 |账单的开始时间。 | | | | | | \ |bill_end_time |String |2021-12-12 |账单的结束时间。 | | | | | | \ |data |Map[String][VEEWInstanceChargeItemUsage](/docs/6499/81081#veewinstancechargeitemusage) |见下文说明 |用量信息。 | ### VEEWInstanceChargeItemUsage | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |charge_item |String |EIP |计费类型： |\ | | | | |\ | | | |* **EIP**：弹性公网 IP。 |\ | | | |* **LB**：四层负载均衡。 | | | | | | \ |usage |Float64 |1 |使用的实例的数量。 | | | | | | \ |used_list |[]Map[String]String |```JSON |\ | | |{ |\ | | | "CPU": 6, |\ | | | "cluster_name": "****-yzcm02", |\ | | | "create_time": "1646195762", |\ | | | "delete_time": "0", |\ | | | "desc": "", |\ | | | "eip_addr": "36.**.**.40", |\ | | | "eip_identity": "eip-7gf4l9****", |\ | | | "eip_name": "eip-Petp-****-yzcm02-CMCC-0", |\ | | | "eip_type": "IPv4", |\ | | | "isp": "CMCC", |\ | | | "network_type": "public", |\ | | | "status": "bound", |\ | | | "update_time": "1646195767" |\ | | |} |\ | | |``` |\ | | | |\ | | | |使用的实例的列表。 |\ | | | | | ### BandwidthData | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |bill_cycle |String |2021-11 |账单周期。 | | | | | | \ |bill_start_time |String |2021-11-01 |账单的开始时间。 | | | | | | \ |bill_end_time |String |2021-11-30 |账单的结束时间。 | | | | | | \ |isp |String |CMCC |运营商代码。 | | | | | | \ |isp_cn |String |移动 |运营商名称。 | | | | | | \ |city_level |String |2 |城市的计费类别： |\ | | | | |\ | | | |* 1：北上广 |\ | | | |* 2：地区中心 |\ | | | |* 3：一般城市 | | | | | | \ |city_level_cn |String |地区中心 |城市计费类别的中文描述。 | | | | | | \ |value |Float64 |0 |用量数据。单位：Mbps。 | ### BillingUsageDetailData | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |date |String |2021-12-01 |日期，格式为 YYYY-MM-DD。 | | | | | | \ |value |String |6 |指定计费项的用量数据。 | ## 四层负载均衡 ### LB | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |identity |String |veew-lb2131011027612112**** |负载均衡实例的 ID。 | | | | | | \ |name |String |z-loadbalance |负载均衡实例的名称。 | | | | | | \ |region |String |CentralChina |负载均衡实例所在的大区。 | | | | | | \ |city |String |410100 |负载均衡实例所在的城市。 | | | | | | \ |cluster_name |String |****-zzcu01 |负载均衡实例所在的节点的名称。 | | | | | | \ |cluster_alias |String |郑州联通01 |节点的中文名称。 | | | | | | \ |vpc_name |String |郑州联通01-默认VPC |私有网络的名称。 | | | | | | \ |vpc_identity |String |vpc-sbjngs**** |私有网络的 ID。 | | | | | | \ |vpc_subnets |[]String |["172.\*\*.\*\*.64/26"] |私有网络的子网。 | | | | | | \ |status |String |bound |负载均衡实例的状态： |\ | | | | |\ | | | |* **bound**：已绑定弹性公网 IP。 |\ | | | |* **unbound**：未绑定弹性公网 IP。 |\ | | | |* **updating**: 更新中。 |\ | | | |* **terminating**: 删除中。 |\ | | | |* **changing**: 单双栈转换中。 |\ | | | |* **creating**: 创建中。 |\ | | | |* **failed**: 创建失败。 |\ | | | |* **stopping**: 停止中。 |\ | | | |* **stopped**: 已停止。 | | | | | | \ |ips |[][IP](/docs/6499/81081#ip-3) |见下文说明 |负载均衡实例绑定的 IP 地址的列表。 | | | | | | \ |listeners |[][Listener](/docs/6499/81081#listener) |见下文说明 |负载均衡实例关联的监听器的列表。 | | | | | | \ |desc |String |This is a new lb |负载均衡实例的描述。 | | | | | | \ |billing_method |String |MonthlyPeak |负载均衡实例的计费方式： |\ | | | | |\ | | | |* **MonthlyPeak**：按月计费。 |\ | | | |* **DailyPeak**：按日计费。如需使用该计费方式，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 | | | | | | \ |create_time |Integer |1635327375 |负载均衡实例的创建时间，以 UNIX 时间戳格式显示。 UNIX 时间戳表示的是从 1970年1月1日（UTC/GMT 的午夜）开始所经过的秒数。 | | | | | | \ |update_time |Integer |1638162081 |负载均衡实例的更新时间，以 UNIX 时间戳格式显示。 UNIX 时间戳表示的是从 1970年1月1日（UTC/GMT 的午夜）开始所经过的秒数。 | | | | | | \ |lb_type |String |IPv4 |负载均衡实例的公网类型： |\ | | | | |\ | | | |* **IPv4**：IPv4 网络。 |\ | | | |* **IPv4,IPv6**：IPv4/IPv6 双栈网络。 | | | | | | \ |account_identity |Integer |210006**** |账号 ID。 | | | | | | \ |ep_net_type |Integer |1 |表明实例是单栈还是双栈： |\ | | | |1：单栈。 |\ | | | |2：双栈。 | | | | | | \ |rs_type |String |veen |后端服务器类型： |\ | | | | |\ | | | |* veen：边缘实例。 | | | | | | \ |clusters |[][Cluster](/docs/6499/81081#cluster) |```JSON |\ | | |{ |\ | | | "cluster_name": "****-gzcm03", |\ | | | "alias": "广州移动03", |\ | | | "country": "CN", |\ | | | "region": "SouthChina", |\ | | | "province": "GD", |\ | | | "city": "440100", |\ | | | "isp": "CMCC" |\ | | |} |\ | | |``` |\ | | | |\ | | | |负载均衡实例所在的节点。 | | | | | | \ |isp |String |CMCC |运营商。 | | | | | | \ |eip_num |Integer |1 |负载均衡实例绑定的弹性公网 IP 的数量。 | ### Cluster | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |cluster_name |String |**ct05 |节点的名称。 | | | | | | \ |country |String |CN |国家。 | | | | | | \ |region |String |EastChina |区域。 | | | | | | \ |province |String |ZJ |省份。 | | | | | | \ |city |String |330200 |城市。 | | | | | | \ |isp |String |CTCC |运营商。 | | | | | | \ |alias |String |浙江宁波电信01 |节点的中文别名。 | ### IP | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |ip_identity |String |eip-wqjgxf**** |弹性公网 IP 的 ID。 | | | | | | \ |ip |String |123.\*\*.\*\*.158 |弹性公网 IP 地址。 | | | | | | \ |ip_name |String |"" |弹性公网 IP 的名称。 | | | | | | \ |ip_type |String |IPv4 |弹性公网 IP 的类型。 | | | | | | \ |bandwidth_peak |String |20 |弹性公网 IP 的带宽峰值。单位：Mbps。 | | | | | | \ |ack |Boolean |true |是否已成功绑定弹性公网 IP： |\ | | | | |\ | | | |* **true**：已绑定。 |\ | | | |* **false**：未绑定。 | ### Listener | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |name |String |listener-2 |监听器的名称。 | | | | | | \ |listen_port_protocol |String |TCP |监听协议。 | | | | | | \ |listen_port |Integer |80 |前端端口。 | | | | | | \ |idle_timeout |Integer |60 |连接空闲超时时间。 | | | | | | \ |loadbalance_strategy |String |sip |负载均衡算法： |\ | | | | |\ | | | |* **sip**：源IP一致性哈希。 |\ | | | |* **sip+sport**：源IP+源端口一致性哈希。 | | | | | | \ |desc |String |This is a listener |监听器的描述。 | | | | | | \ |endpoints |[][Endpoint](/docs/6499/81081#endpoint) |见下文说明 |后端服务器的列表。 | | | | | | \ |health_check |[HealthCheckResp](/docs/6499/81081#healthcheckresp) |见下文说明 |健康检查配置。 | | | | | | \ |create_time |Integer |1635327375 |创建时间，以UNIX 时间戳格式显示。 | | | | | | \ |listener_uniq |String |a46c0c0ed2c38bc514528db2515f**** |监听器的唯一标识。 | | | | | | \ |default_endpoint_port |Integer |80 |默认的后端端口。 | | | | | | \ |connection_drain_config |[ConnectionDrainConfig](/docs/6499/81081#aa4716e8) |```JSON |\ | | |{ |\ | | | "connection_drain_enabled": true, |\ | | | "connection_drain_timeout": 360 |\ | | |} |\ | | |``` |\ | | | |“连接优雅中断”功能的配置详情。 | ### Endpoint | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |endpoint_identity |String |veen1128038002028123**** |后端服务器的 ID。 | | | | | | \ |endpoint_name |String |endpoint-1 |后端服务器的名称。 | | | | | | \ |endpoint_type |String |veen |后端服务器的类型。 | | | | | | \ |port |Integer |80 |后端服务器的端口。 | | | | | | \ |weight |Integer |10 |后端服务器的权重。 | | | | | | \ |internal_ip |[EndpointIP](/docs/6499/81081#endpointip) |见下文说明 |后端服务器的私网 IP 地址。 | | | | | | \ |external_ip |[EndpointIP](/docs/6499/81081#endpointip) |见下文说明 |后端服务器的公网 IP 地址。 | | | | | | \ |mac_addr |String |0a:58:ac:**:**:43 |后端服务器的 MAC 地址。 | | | | | | \ |healthy_status |Boolean |false |后端服务器的健康检查状态是否正常： |\ | | | | |\ | | | |* **true**：正常。 |\ | | | |* **false**：异常。 | | | | | | \ |endpoint_uniq |String |1992fff44211218becb0c5944459**** |后端服务器的唯一标识。 | ### EndpointIP | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |ip_addr |String |123.\*\*.\*\*.152 |IP 地址。 | | | | | | \ |ip_version |String |ipv4 |IP 地址版本。 | | | | | | \ |isp |String |CUCC |运营商。 | | | | | | \ |primary |Boolean |false |是否是主私网 IP 地址： |\ | | | | |\ | | | |* true：主私网 IP 地址。 |\ | | | |* false：非主私网 IP 地址。 | ### HealthCheckResp | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |protocol |\ | |String |TCP |健康检查协议： |\ | | | | |\ | | | |* TCP |\ | | | |* UDP |\ | | | |* HTTP | | | | | | \ |port |Integer |80 |健康检查端口。 | | | | | | \ |timeout |Integer |10 |响应超时时间。 | | | | | | \ |period |Integer |20 |健康检查间隔。单位：秒。 | | | | | | \ |failure_threshold |Integer |2 |不健康阈值。 | | | | | | \ |success_threshold |Integer |2 |健康阈值。 | | | | | | \ |http_host |String |"" |Host 头域。 | | | | | | \ |http_path |String |healthz |HTTP 检查路径。 | | | | | | \ |http_success_codes |String |\ | | |Code2xx |HTTP 正常状态码： |\ | | | | |\ | | | |* Code2xx |\ | | | |* Code3xx |\ | | | |* Code4xx |\ | | | |* Code5xx | | | | | | \ |udp_check_string |String |"" |UDP 检查字符串。 | | | | | | \ |use_endpoint_port |Boolean |false |是否使用后端端口作为健康检查端口。 | ### ConnectionDrainConfig | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |connection_drain_enabled |\ | |Boolean |true |是否已开启“连接优雅中断”功能： |\ | | | | |\ | | | |* **true**：已开启该功能。 |\ | | | |* **false**：未开启该功能。 | | | | | | \ |connection_drain_timeout |Integer |60 |连接优雅中断超时时间。单位：秒。 | ## 弹性公网IP ### EIPInstance | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |account_identity |Integer |210000**** |账号 ID。 | | | | | | \ |user_identity |Integer |0 |用户 ID。 | | | | | | \ |eip_identity |String |eip-6wb9mg**** |弹性公网 IP 的 ID。 | | | | | | \ |eip_name |String |test-****-gzcm03-CMCC |弹性公网 IP 的名称。 | | | | | | \ |cluster |[EIPCluster](/docs/6499/81081#eipcluster) |见下文说明 |弹性公网 IP 所在的节点的信息。 | | | | | | \ |eip_type |String |IPv4 |弹性公网 IP 的类型。 | | | | | | \ |eip_addr |String |183.\**.**.146 |弹性公网 IP。 | | | | | | \ |bandwidth_peak |Integer |20 |带宽峰值。单位：Mbps。 | | | | | | \ |isp |String |CTCC |运营商。 | | | | | | \ |network_type |String |public |网络类型： |\ | | | | |\ | | | |* **public**：公网。 | | | | | | \ |binder_resource |[EIPBinderResource](/docs/6499/81081#eipbinderresource) |见下文说明 |弹性公网 IP 绑定的资源。 |\ | | | |如需获取该信息，您需要在请求中将 **with_binder_info** 参数的值指定为 **true**。 | | | | | | \ |status |String |bound |弹性公网 IP 的状态： |\ | | | | |\ | | | |* **creating**：创建中。 |\ | | | |* **unbound**：未绑定。 |\ | | | |* **binding**：绑定中。 |\ | | | |* **bound**：已绑定。 |\ | | | |* **unbinding**：解绑中。 |\ | | | |* **deleting**：删除中。 | | | | | | \ |desc |String |"" |弹性公网 IP 的描述。 | | | | | | \ |billing_config |[EIPBillingConfigs](/docs/6499/81081#eipbillingconfigs) |见下文说明 |弹性公网 IP 的计费配置。 | | | | | | \ |create_time |Integer |1634109032 |创建时间。 | | | | | | \ |update_time |Integer |1641979402 |更新时间。 | | | | | | \ |project |String |default |弹性公网 IP 所属的项目。 | ### EIPCluster | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |cluster_name |String |nb**05 |节点的名称。 | | | | | | \ |country |String |CN |国家。 | | | | | | \ |region |String |EastChina |区域。 | | | | | | \ |province |String |ZJ |省份。 | | | | | | \ |city |String |330200 |城市。 | | | | | | \ |isp |String |CTCC |运营商。 | | | | | | \ |level |String |3 |节点的计费类别： |\ | | | | |\ | | | |* 1：北上广 |\ | | | |* 2：地区中心 |\ | | | |* 3：一般城市 | | | | | | \ |alias |String |浙江宁波电信01 |节点的中文别名。 | ### EIPBinderResource | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |resource_type |String |lb |弹性公网 IP 绑定的实例的类型： |\ | | | | |\ | | | |* **lb**：四层负载均衡实例。 |\ | | | |* **lb7**：七层负载均衡实例。 |\ | | | |* **veen**：边缘实例。 | | | | | | \ |resource_identity |String |veew-lb2002010112252015**** |实例的 ID。 | | | | | | \ |resource_name |String |zx-lb |实例的名称。 | | | | | | \ |resource_vpc_identity |String |vpc-t9wjgm**** |实例所在的私有网络的 ID。 | | | | | | \ |resource_vpc_name |String |宁波电信01-默认VPC |实例所在的私有网络的名称。 | | | | | | \ |resource_vpc_subnet_cidrs |[]String |["172.\**.**.192/26"] |实例所在的私有网络子网的 CIDR 地址段。 | ### EIPBillingConfigs | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |ip_billing_method |String |MonthlyPeak |IP 计费方式： |\ | | | | |\ | | | |* **MonthlyPeak**：按月计费。 |\ | | | |* **DailyPeak**：按日计费。如需使用该计费方式，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 | | | | | | \ |bandwidth_billing_method |String |MonthlyP95 |带宽计费方式： |\ | | | | |\ | | | |* **MonthlyP95**：按月 95 峰值计费。 |\ | | | |* **DailyPeak**：按日峰值计费。如需使用该计费方式，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 |\ | | | |* **HourUsed**：按流量计费。如需使用该计费方式，请[提交工单](https://console.volcengine.com/workorder/create?step=2&SubProductID=P00000309)申请。 | ## NAT 网关 ### NATGateway | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |natgw_identity |String |natgw-zh7gjhkwqj**** |NAT 网关的 ID。 | | | | | | \ |natgw_name |String |nat_dev01 |NAT 网关的名称。 | | | | | | \ |status |\ | |String |\ | | |running |NAT 网关的状态： |\ | | | | |\ | | | |* **creating**：创建中。 |\ | | | |* **running**：运行中。 |\ | | | |* **updating**：更新中。 |\ | | | |* **deleting**：删除中。 | | | | | | \ |cluster |\ | |[Cluster](/docs/6499/81081#cluster-2) |\ | | |见下文说明 |NAT 网关所在节点的信息。 | | | | | | \ |vpc |[VPC](/docs/6499/81081#vpc) |见下文说明 |NAT 网关所属私有网络的信息。 | | | | | | \ |eip_list |[][NatEIP](/docs/6499/81081#nateip) |见下文说明 |NAT 网关绑定的弹性公网 IP 的列表。 | | | | | | \ |bps_limit |String |2000 |NAT 网关的最大带宽。单位：Mbps。 | | | | | | \ |billing_method |String |HourUsed |计费方式： |\ | | | | |\ | | | |* **HourUsed**：按小时计费。 | | | | | | \ |connect_limit |String |500000 |最大并发连接数。 | | | | | | \ |new_connect_limit |String |50000 |最大新建连接数。 | | | | | | \ |project |String |default |NAT 网关所属的项目。 | | | | | | \ |is_overdue |\ | |Boolean |false |是否欠费。 |\ | | | | |\ | | | |* **false**：未欠费。 |\ | | | |* **true**：已欠费。 | | | | | | \ |overdue_close_time |Integer |1733200715 |欠费关停时间。 | | | | | | \ |overdue_reclaim_time |Integer |1733200715 |欠费回收时间。 | | | | | | \ |start_at |Integer |1733200715 |启动时间，以 UNIX 时间戳格式显示。单位：秒。 | | | | | | \ |end_at |Integer |1733200715 |运行结束时间，以 UNIX 时间戳格式显示。单位：秒。 | | | | | | \ |create_time |\ | |Integer |1733200714 |\ | | | |创建时间，以 UNIX 时间戳格式显示。单位：秒。 | | | | | | \ |update_time |Integer |1733200899 |更新时间，以 UNIX 时间戳格式显示。单位：秒。 | ### Cluster | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |cluster_name |String |nb**05 |节点的名称。 | | | | | | \ |country |String |CN |节点所在的国家。 | | | | | | \ |region |String |EastChina |节点所在的区域。 | | | | | | \ |province |String |ZJ |节点所在的省份。 | | | | | | \ |city |String |330200 |节点所在的城市。 | | | | | | \ |isp |String |CTCC |节点的网络运营商。 | | | | | | \ |level |String |2 |节点的带宽计费类别： |\ | | | | |\ | | | |* **1**：北上广 |\ | | | |* **2**：地区中心 |\ | | | |* **3**：一般城市 | | | | | | \ |alias |String |浙江**电信 |节点的别名。 | ### VPC | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |vpc_identity |String |vpc-xltvcb**** |私有网络的 ID。 | | | | | | \ |vpc_name |String |**电信-默认VPC |私有网络的名称。 | ### NatEIP | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |eip_identity |String |eip-rc8pdh**** |弹性公网 IP 的 ID。 | | | | | | \ |eip_addr |String |27.\*\*.\*\*.195 |弹性公网 IP 地址。 | ### DnatRule | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |natgw_identity |String |natgw-s9mqj5vzj8d*** |NAT 网关的 ID。 | | | | | | \ |dnat_rule_identity |String |dnatrule-758q5**** |DNAT 规则的 ID。 | | | | | | \ |dnat_rule_name |String |test01 |DNAT 规则的名称。 | | | | | | \ |status |String |running |DNAT 规则的状态： |\ | | | | |\ | | | |* **creating**：创建中。 |\ | | | |* **running**：运行中。 |\ | | | |* **updating**：更新中。 |\ | | | |* **deleting**：删除中。 | | | | | | \ |port_config |String |exact |端口设置： |\ | | | | |\ | | | |* **exact**：指定端口。 |\ | | | |* **any**：任意端口。仅开通相关权限的用户可使用该功能。 | | | | | | \ |protocol |String |tcp |协议： |\ | | | | |\ | | | |* **tcp**：TCP 协议。 |\ | | | |* **udp**：UDP 协议。 |\ | | | |* **any**：任意协议。仅开通相关权限的用户可使用该功能。 | | | | | | \ |eip |[DnatEIP](/docs/6499/81081#dnateip) |请参见下文说明 |DNAT 规则关联的弹性公网 IP。 | | | | | | \ |private_ip |String |10.\*\*.\*\*.2 |弹性公网 IP 对应的私网 IP 地址。 | | | | | | \ |public_port |Integer |22 |公网端口。 | | | | | | \ |private_port |Integer |22 |私网端口。 | | | | | | \ |create_time |Integer |1735615207 |创建时间，以 UNIX 时间戳格式显示。单位：秒。 | | | | | | \ |update_time |Integer |1735615207 |更新时间，以 UNIX 时间戳格式显示。单位：秒。 | ### DnatEIP | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |eip_identity |String |eip-j8lf9c**** |弹性公网 IP 的 ID。 | | | | | | \ |eip_addr |String |42.\*\*.\*\*.181 |弹性公网 IP 地址。 | ### SnatRule | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |natgw_identity |String |natgw-s9mqj5vzj8d*** |NAT 网关的 ID。 | | | | | | \ |snat_rule_identity |String |snatrule-rb2mrpp2fp9**** |SNAT 规则的 ID。 | | | | | | \ |snat_rule_name |String |test1 |SNAT 规则的名称。 | | | | | | \ |status |String |running |SNAT 规则的状态： |\ | | | | |\ | | | |* **creating**：创建中。 |\ | | | |* **running**：运行中。 |\ | | | |* **updating**：更新中。 |\ | | | |* **deleting**：删除中。 | | | | | | \ |backend_type |String |vpc |SNAT 规则作用的范围： |\ | | | | |\ | | | |* **vpc**：私有网络。 |\ | | | |* **custom**：自定义网段。仅开通相关权限的用户可使用该功能。 | | | | | | \ |custom_cidr |String |10.\*\*.\*\*.0/24 |自定义的网段。 |\ | | | |该参数仅在 **backend_type** 参数的值为 **custom** 时返回。 | | | | | | \ |eip_list |[][SnatEIP](/docs/6499/81081#snateip) |请参见下文说明 |SNAT 规则关联的弹性公网 IP 的列表。 | | | | | | \ |create_time |Integer |1735611770 |创建时间，以 UNIX 时间戳格式显示。单位：秒。 | | | | | | \ |update_time |Integer |1735611902 |更新时间，以 UNIX 时间戳格式显示。单位：秒。 | ### SnatEIP | | | | | \ |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |eip_identity |String |eip-9gr7f4**** |弹性公网 IP 的 ID。 | | | | | | \ |eip_addr |String |42.\*\*.\*\*.183 |弹性公网 IP 地址。 | ## 边缘监控 ### DataPair | | | | | \ |**名称** |**类型** |**示例值** |**描述** | |---|---|---|---| | | | | | \ |value |Float64 |1 |监控指标的值。 | | | | | | \ |timestamp |Integer |1664326800000 |时间戳。单位：毫秒。 | | | | | | \ |is_loss |Boolean |false |用于区分 **value** 值为 **0** 的情况：数据缺失或实际数据值为 0。 |\ | | | | |\ | | | |* **false**：数据正常。当前时间戳对应的数据值为 0。 |\ | | | |* **true**：当前时间戳对应的监控指标数据缺失。 |

边缘计算节点