查询批量文件分发任务详情 GetFileDistributionJobDetail--云手机-火山引擎

文档中心

立即注册

导航

查询批量文件分发任务详情 GetFileDistributionJobDetail

最近更新时间：2024.05.09 17:19:41首次发布时间：2023.10.11 20:05:07

根据文件分发任务 ID（job_id）或文件分发执行 ID（distribution\_task\_id），查询批量文件分发任务执行的详情。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考公共请求参数。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetFileDistributionJobDetail
Version	Query	String	是	公共参数，OpenAPI 接口版本	2020-10-25

Body 参数

字段	类型	必填	说明
product_id	String	是	业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
job_id	String	否	批量文件分发任务 ID（与 distribution_task_id 二选一），可通过调用 DistributeFileToInstances 接口获取（返回结果 `distribution_job_id` 的值）
distribution_task_id	String	否	文件分发执行 ID（与 job_id 二选一），可通过调用 DistributeFileToInstances 或 DistributeFile 接口获取

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段	类型	说明
tasks	Array of Tasks	任务列表，参考以下 Tasks 结构说明
job_id	String	批量分发文件任务 ID
job_status	Integer	批量分发文件任务执行状态
job_status_str	String	批量分发文件任务执行状态说明

Tasks 结构说明

字段	类型	说明
instance_id	String	实例 ID
distribution_task_id	String	文件分发任务 ID
job_id	String	批量文件分发任务 ID（非批量分发请求时，该字段为空）
status	String	任务执行状态信息，枚举值如下： Initial（初始化中） DownloadPending（下载任务等待调度） DownloadQueued（下载任务调度中） DownloadRunning（下载任务执行中） DownloadSucceed（下载成功） DownloadFailed（下载任务失败） DistributePending（分发任务等待调度） DistributeQueued（分发任务待调度） DistributeRunning（分发任务执行中） DistributeSucceed（分发成功） DistributeFailed（分发任务失败） AfterDistributionHookPending: 分发后任务待调度 AfterDistributionHookRunning: 分发后任务执行中 AfterDistributionHookSucceed: 分发后任务成功 AfterDistributionHookFailed: 分发后任务失败 UnknownErr（未知错误） AllSucceed（全部执行完成）
msg	String	任务执行成功或失败的返回信息
file_path	String	文件保存在实例中的绝对路径，例：/data/file_ds/test.jpg
create_at	Int64	任务创建时间，秒级时间戳，例：1669975702
update_at	Int64	任务更新时间，秒级时间戳，例：1669975903

示例

请求示例

POST https://open.volcengineapi.com?Action=GetFileDistributionJobDetail
&Version=2020-10-25
&<通过header传入的公共请求参数>

{
    "product_id": "14677396781xxxxxxxx",
    "job_id": "fdj-142xxxxxx"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "GetFileDistributionJobDetail",
        "Region": "cn-north-1",
        "RequestId": "20230928105336005FA5B780B39FD7E788",
        "Service": "iPaaS",
        "Version": "2020-10-25"
    },
    "Result": {
        "job_id": "fdj-142xxxxxx",
        "job_status": 11,
        "job_status_str": "AllSucceed",
        "tasks": [
            {
                "distribution_task_id": "fd-142xxxxxx",
                "instance_id": "i-1778170173xxxxxx",
                "job_id": "fdj-142xxxxxx",
                "status": "AllSucceed",
                "msg": "Succeed",
                "file_path": "/data/file_ds/chess.apk",
                "create_at": 1695868570,
                "update_at": 1695868616
            },
            {
                "distribution_task_id": "fd-142xxxxxx",
                "instance_id": "i-1778170173xxxxxx",
                "job_id": "fdj-142xxxxxx",
                "status": "AllSucceed",
                "msg": "Succeed",
                "file_path": "/data/file_ds/chess.apk",
                "create_at": 1695868570,
                "update_at": 1695868637
            }
        ]
    }
}