【旧版】参数定义--云手机-火山引擎

文档中心

导航

【旧版】参数定义

最近更新时间：2024.06.18 16:30:35首次发布时间：2023.06.14 12:45:16

Configuration 定义

说明

火山引擎云手机资源套餐信息。

参数列表

字段

类型

说明

configuration_code

String

火山侧套餐 ID

configuration_name

String

火山侧套餐名称

configuration_type

Int32

火山侧套餐类型：

1（正式购买）
2（试用体验）

SubscribePreorder 定义

说明

并发实例资源订购配置单。

参数列表

字段	类型	必选	说明
configuration_code	string	是	火山侧套餐 ID，可选枚举值： ultimate（旗舰型） enhanced（加强型） common（通用型） sample（入门型） basic（基础型） elementary（低配型）
dc	string	否	实例所属机房，如果指定，则在订购指定机房中的实例。注：dc 和 region 至少需要指定一个值，dc 优先级高于 region
region	string	否	实例所属机房所在大区 ID，如果指定，则在指定大区内随机分配机房进行实例订购注：dc 和 region 至少需要指定一个值，dc 优先级高于 region
apply_num	int32	是	订购实例数
term	int32	否	订购实例的租期（单位：月，例如：“1.10 - 2.10” 为 1 个月租期，默认值：1）
server_type_code	string	否	规格
auto_create_pod	bool	否	是否自动创建实例

RenewResourcePreorder 定义

说明

并发实例资源续订配置单。

参数列表

字段	类型	必选	说明
resource_set_id	int64	是	资源组 ID，通过 ListPodResourceSet 接口获取
term	int32	是	续订实例的租期（单位：月；注：不是更改后的租期，是增加的租期）

PodResourceSet 定义

说明

实例资源组列表信息。

参数列表

字段	类型	说明
product_id	string	业务 ID
resource_set_id	string	实例资源组 ID
configuration_code	string	实例资源套餐 ID
charge_type	string	实例资源计费模式： pod_pre_monthly（预付费月结） pod_post_daily（后付费日结）
dc	string	机房
region	string	大区 ID
apply_num	int32	已订购实例总数
term	int32	订购实例的租期：预付费模式：租期数，单位：月后付费模式：0
expire_at	int64	实例资源到期时间：预付费模式：该资源组最早到期时间，unix 时间戳后付费模式：0

PodResource 定义

说明

实例资源详细信息。

参数列表

字段	类型	说明
product_id	string	业务 ID
configuration_code	string	实例资源套餐 ID
dc	string	机房
region	string	大区 ID
apply_num	int32	已订购实例总数
ready_num	int32	已预热完成实例总数（需在请求参数中指定 image_id）
online_num	int32	已开机实例总数
total_num	int32	已创建实例总数
total_data_size	int32	已创建实例数据分区总容量，单位 GB
expire_at	int32	实例资源到期时间：预付费模式：该资源组最早到期时间，unix 时间戳后付费模式：0

ResourceQuota 定义

说明

业务资源配额。

参数列表

字段	类型	说明
storage_quota	int32	业务维度实例数据分区存储总上限，单位 GB（超过上限后无法再创建实例，需联系客服进行上限调整）