智能创作
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 智能创作 > 服务端 API > 任务管理相关接口 > 获取任务详情

获取任务详情

最近更新时间：2024-03-15 16:02:02

我的收藏

本页目录：

1. 接口描述

接口请求域名： cme.tencentcloudapi.com 。

获取任务详情信息，包含下面几个部分：

  • 任务基础信息：包括任务状态、错误信息、创建时间等；
  • 导出项目输出信息：包括输出的素材 Id 等。

    • 默认接口请求频率限制：20次/秒。

    推荐使用 API Explorer
    点击调试
    API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

    2. 输入参数

    以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。

    参数名称 必选 类型 描述
    Action 是 String 公共参数，本接口取值：DescribeTaskDetail。
    Version 是 String 公共参数，本接口取值：2019-10-29。
    Region 否 String 公共参数，本接口不需要传递此参数。
    Platform 是 String 平台 Id，指定访问的平台。关于平台概念，请参见文档 平台。
    示例值：test
    TaskId 是 String 任务 Id。
    示例值：1400-tfusion-ct0
    Operator 否 String 操作者。如不填，默认为 cmeid_system，表示平台管理员操作，可以获取任意任务信息。如果指定操作者，则操作者需要是任务发起者。
    示例值：85b8cdac-8e18-430a-aeae-08076ac26a11

    3. 输出参数

    参数名称 类型 描述
    Status String 任务状态，取值有：
  • PROCESSING：处理中：
  • SUCCESS：成功；
  • FAIL：失败。

    • 示例值：SUCCESS
    Progress Integer 任务进度，取值为：0~100。
    示例值：100
    ErrCode Integer 错误码。
  • 0：成功；
  • 其他值：失败。

    • 示例值：0
    ErrMsg String 错误信息。
    示例值：Success.
    TaskType String 任务类型，取值有：
  • VIDEO_EDIT_PROJECT_EXPORT：视频编辑项目导出。

    • 示例值：VIDEO_EDIT_PROJECT_EXPORT
    VideoEditProjectOutput VideoEditProjectOutput 导出项目输出信息。仅当 TaskType 为 VIDEO_EDIT_PROJECT_EXPORT 时有效。
    注意：此字段可能返回 null，表示取不到有效值。
    CreateTime String 创建时间，格式按照 ISO 8601 标准表示。
    示例值：2020-04-28T18:16:58Z
    RequestId String 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

    4. 示例

    示例1 获取任务详情

    获取任务详情。

    输入示例

    POST / HTTP/1.1
Host: cme.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeTaskDetail
<公共请求参数>

{
    "Platform": "test",
    "TaskId": "181xxxxxxxx9-procedurev2-b718fcee09a72470bf665cf55351d810t0"
}

    输出示例

    {
    "Response": {
        "CreateTime": "2020-04-28T18:16:58Z",
        "ErrCode": 0,
        "ErrMsg": "Success.",
        "Progress": 100,
        "RequestId": "85b8cdac-8e18-430a-aeae-08076ac26a11",
        "Status": "SUCCESS",
        "TaskType": "VIDEO_EDIT_PROJECT_EXPORT",
        "VideoEditProjectOutput": {
            "MaterialId": "6866c9a7-a2ca-4d",
            "MetaData": {
                "AudioStreamInfoSet": [
                    {
                        "Bitrate": 46552,
                        "Codec": "aac",
                        "SamplingRate": 16000
                    }
                ],
                "Bitrate": 6917072,
                "Container": "mov,mp4,m4a,3gp,3g2,mj2",
                "Duration": 346.55999755859375,
                "Height": 1080,
                "Rotate": 0,
                "Size": 299688882,
                "VideoStreamInfoSet": [
                    {
                        "Bitrate": 6870520,
                        "Codec": "h264",
                        "Fps": 25,
                        "Height": 1080,
                        "Width": 1920
                    }
                ],
                "Width": 1920
            },
            "URL": "http://cmedemo.vod2.myqcloud.com/xxxxx/cemdemo.mp4",
            "VodFileId": "5285890802029089"
        }
    }
}

    5. 开发者资源

    腾讯云 API 平台

    腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

    API Inspector

    用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

    SDK

    云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

    命令行工具

    6. 错误码

    以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。

    错误码 描述
    InternalError 内部错误。
    InvalidParameterValue.Platform 平台参数取值错误。
    InvalidParameterValue.TaskId 任务 Id 无效。
    ResourceNotFound 资源不存在。
    ResourceNotFound.Platform 平台不存在。
    UnauthorizedOperation 未授权操作。
    中国站