新建文件分发任务,将文件分发到指定业务下的多个云机实例,并可选择同时执行应用安装任务。
使用 POST 方式发起请求。
下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表,参考 公共请求参数。
字段 | 位置 | 类型 | 必填 | 说明 | 值 |
---|---|---|---|---|---|
Action | Query | String | 是 | 公共参数,OpenAPI 接口名称 | DistributeFileToInstances |
Version | Query | String | 是 | 公共参数,OpenAPI 接口版本 | 2020-10-25 |
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
product_id | String | 是 | 业务 ID,可在「云手机控制台-业务管理-业务详情」中获取 |
instance_ids | Array of String | 是 | 实例 ID 列表,可通过调用 ListInstance 接口获取 |
file_md5 | String | 是 | 文件的 MD5 值 |
file_format | String | 否 | 获取文件的方式:
|
volc_tos_file | Object | 否 | 保存文件的火山引擎对象存储信息,参考以下 TosInfo 结构说明 |
url_file | Object | 否 | 获取文件的 URL,参考以下 UrlFile 结构说明 |
file_dir | String | 否 | 在云机中存储文件的路径(默认:/data/file_ds ) |
after_distribution_action | Object | 否 | 文件分发完成后执行的操作,参考以下 AfterDistributionAction 结构说明 |
TosInfo 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
tos_bucket | String | 是 | 火山引擎对象存储中的存储桶名称,例如:test-bucket |
tos_file_path | String | 是 | 存储桶下的目录和应用安装文件名称(不能以 / 开头),例如:cloudphone/gameApk/wedance.apk |
endpoint | String | 是 | 火山引擎对象存储服务地址(地域节点),若为空,则使用默认值:tos-cn-beijing.volces.com |
region | String | 是 | 火山引擎对象存储服务区域,若为空,则使用默认值:cn-beijing |
UrlFile 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
url | String | 是 | 保存文件的 URL |
AfterDistributionAction 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
action | Integer | 是 | 操作类型,枚举值包括:
|
install_apk_param | Object | 否 | 应用安装参数,参考以下 InstallAPKParam 结构说明 |
InstallAPKParam 结构说明
字段 | 类型 | 必填 | 说明 |
---|---|---|---|
option_list | Array of Integer | 否 | 应用安装可选参数列表:
|
通用返回参数,请参考 ResponseMetadata 结构说明。
Result 字段包含以下参数:
字段 | 类型 | 说明 |
---|---|---|
failed_records | Array | 文件分发失败记录,参考以下 Failed Records 结构说明 |
distribution_job_id | String | 批量文件分发任务 ID,用于通过调用 GetFileDistributionJobDetail 或 GetFileDistributionResult 接口,获取任务执行结果 |
file_distribution_task_map | JSON Map | 文件分发任务 ID 列表 |
Failed Records 结构说明
字段 | 类型 | 说明 |
---|---|---|
id | String | 实例 ID |
msg | String | 操作失败的错误信息 |
POST https://open.volcengineapi.com?Action=DistributeFileToInstances &Version=2020-10-25 &<通过header传入的公共请求参数> { "product_id": "14677396781xxxxxxxx", "instance_ids": ["i-1773083627xxxxxx","i-1773098885xxxxxx"], "file_md5": "65258bd04c93e89df3fcd0xxxxxxxxxx", "file_format": "volc_tos", "volc_tos_file": { "tos_bucket": "cloudphone", "tos_file_path": "chess.apk", "endpoint": "tos-cn-beijing.volces.com", "region": "cn-beijing" }, "url_file": { "url": "https://xxx.xxx.com/gameAPK/chess.apk" }, "file_dir": "/data/file_ds", "after_distribution_action": { "action": 1, "install_apk_param": { "option_list": [2,6] } } }
{ "ResponseMetadata": { "Action": "DistributeFileToInstances", "Region": "cn-north-1", "RequestId": "20230928103609691C967F70A1AA63DC84", "Service": "iPaaS", "Version": "2020-10-25" }, "Result": { "distribution_job_id": "fdj-142xxxxxx", "file_distribution_task_map": { "i-1773083627xxxxxx": "fd-142xxxxxx", "i-1773098885xxxxxx": "fd-142xxxxxx" } } }