在指定业务下,订购云机资源。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | CreateDevices |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2023-08-01 |
X-iPaaS-Idempotent-Token | Query | String | 是 | 幂等 Token | 可通过调用 AcquireIdempotentToken 接口获取 |
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
ProductId | String | 是 | 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取 |
Region | String | 否 | 地域 / 区域,希望订购的云资源所在大区,已开服地域:
注意:需要与 DC 参数二选一 |
DC | Array of String | 否 | 机房 ID 或可用区 ID,希望订购的云资源所在大区下的具体机房或可用区(已开服机房或可用区,可参考 优先推荐的 DC 列表 或联系火山引擎云手机技术支持团队;若不填写,则系统会在对应区域下随机匹配一个机房/可用区进行订购) |
DeviceType | String | 是 | 云资源类型,可选项:
|
DevicePackageId | String | 是 | 云资源套餐规格,可选项可参考 实例套餐规格说明 |
DeviceCount | Integer | 是 | 需要订购的云资源数量 注:若需批量订购云资源,建议先联系您的客户经理或火山引擎云手机技术支持提前确认并获取更多优惠信息 |
DeviceCharge | Object | 是 | 云资源计费配置信息,参考以下 DeviceCharge 结构说明 |
DeviceName | String | 否 | 云资源名称,可自定义名称,不填写则默认与初始化的云资源 ID 保持一致(若订购多台云资源时,会在名称中加后缀递增) |
ImageConfig | Object | 是 | 镜像配置信息,参考以下 ImageConfig 结构说明 |
NetConfig | Object | 是 | 网络配置信息,参考以下 NetConfig 结构说明 |
DeviceCharge 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
DeviceChargeMode | Object | 是 | 计算资源计费配置,参考以下 DeviceChargeMode 结构说明 |
NetworkChargeMode | Object | 是 | 网络资源计费配置,参考以下 NetworkChargeMode 结构说明 |
DeviceChargeMode 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
DeviceChargeType | Integer | 是 | 云资源(计算资源)计费模式,可选项:
|
PeriodTerm | Integer | 否 | 订购周期数,单位:月;当选择 “包年包月” 计费模式时,需要填写;如果是后付费计费模式,可不填或填写0; |
RenewType | Integer | 否 | 续费类型,当选择 “包年包月” 计费模式时,需要填写,可选项:
|
NetworkChargeMode 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
BandWidthChargeType | String | 是 | 公网资源(公网带宽/流量)计费模式,可选项:
|
ImageConfig 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
ImageId | String | 否 | 镜像 ID:
|
IsPublicImage | Boolean | 否 | 是否为公共镜像标识,当 ImageId 为 AOSP 镜像 ID 时,对应选项说明如下:
|
NetConfig 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
ISP | Integer | 是 | 线路运营商,可选项:
注:部分机房仅支持限定的线路运营商,在填写 DC 时可进行确认,优先推荐三线机房(可填写 7 ) |
Bandwidth | Integer | 否 | 公网带宽峰值,针对初始化后的单路实例进行峰值限速,单位:Mbps,可选值:2 ~ 100之间;如不指定,默认值为5;如有更高峰值配置需求,请联系火山引擎云手机技术支持 |
NatId | Integer | 否 | 网络 NAT 配置,非必填;不填或不指定时,默认按照平台的配置执行;部分有定向网络配置需求的客户可联系平台沟通加白,可选项:
|
通用返回参数,请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
OrderNo | String | 生成的云机资源订购订单号 |
InstanceNo | Array of String | 对应火山引擎费用中心资源实例 ID |
POST https://open.volcengineapi.com?Action=CreateDevices &Version=2023-08-01 &X-iPaaS-Idempotent-Token=iPaaS.Idempotent.Token &<通过header传入的公共请求参数> { "ProductId": "1686668620060xxxxxx", "DC": ["tjtj-ctcucm-02"], "Region": "cn-north", "DeviceType": "container", "DevicePackageId": "", "NetConfig": { "ISP": 1, "Bandwidth": 4 }, "ImageConfig": { "ImageId": "img-75628290", "IsPublicImage": true }, "DeviceCharge": { "DeviceChargeMode": { "DeviceChargeType": 1, "PeriodTerm": 2, "RenewType": 1 }, "DeviceChargeMode": { "BandWidthChargeType": "daily_peak" } } }
{ "ResponseMetadata": { "Action": "CreateDevices", "Region": "cn-north-1", "RequestId": "2021122810471701021216810313006DA3", "Service": "iPaaS", "Version": "2023-08-01" }, "Result": { "OrderNo": "", "InstanceNo": [""] } }