帮你快速理解、总结文档立即下载
文档中心>对象存储>SDK 文档>PHP SDK>任务接口>查询任务列表

查询任务列表

最近更新时间：2024-11-07 14:44:22
我的收藏

本页目录：

简介

本文档提供关于查询任务列表的 API 概览和 SDK 示例代码。
API
操作描述
拉取符合条件的任务。

查询任务列表

功能说明

拉取符合条件的任务。

方法原型

public Guzzle\\Service\\Resource\\Model describeMediaJobs(array $args = array());

请求示例

<?php

require dirname(__FILE__) . '/../vendor/autoload.php';

$secretId = "SECRETID"; //替换为用户的 secretId，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$secretKey = "SECRETKEY"; //替换为用户的 secretKey，请登录访问管理控制台进行查看和管理，https://console.cloud.tencent.com/cam/capi
$region = "ap-beijing"; //替换为用户的 region，已创建桶归属的 region 可以在控制台查看，https://console.cloud.tencent.com/cos5/bucket
$cosClient = new Qcloud\\Cos\\Client(
    array(
        'region' => $region,
        'scheme' => 'https', //协议头部，默认为 http
        'credentials'=> array(
            'secretId'  => $secretId ,
            'secretKey' => $secretKey)));
try {
    $result = $cosClient->describeMediaJobs(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Tag' => 'Transcode', // 任务 的Tag
        'QueueId' => 'paaf4fce5521a40888a3034a5dxxxxxxx', // queueId
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

Request 中的具体数据描述如下：
节点名称（关键字）
父节点
描述
类型
是否必选
QueueId
无
拉取该队列 ID 下的任务
String
否
Tag
无
任务的 Tag
String
是
WorkflowId
无
触发该任务的工作流ID
String
否
InventoryTriggerJobId
无
触发该任务的存量触发任务 ID
String
否
InputObject
无
该任务的输入文件名，暂仅支持精确匹配
String
否
OrderByTime
无
Desc 或者 Asc。默认为 Desc
String
否
NextToken
无
请求的上下文，用于翻页。上次返回的值
String
否
Size
无
拉取的最大任务数。默认为10。最大为100
Integer
否
States
无
拉取该状态的任务，以,分割，支持多状态：All、Submitted、Running、Success、Failed、Pause、Cancel。默认为 All
String
否
StartCreationTime
无
拉取创建时间大于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z，示例：2001-01-01T00:00:00+0800
String
否
EndCreationTime
无
拉取创建时间小于该时间的任务。格式为：%Y-%m-%dT%H:%m:%S%z，示例：2001-01-01T23:59:59+0800
String
否

返回结果示例

GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjRkMWUNjRjMjIxODBfMzUxNGSIOJOIDAJOIDg=
    [ContentType] => application/xml
    [ContentLength] => 92
    [Bucket] => examplebucket-125000000
    [Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/jobs
    [Response] => Array
        (
            [JobsDetail] => Array
                (
                )

            [NextToken] => Array
                (
                )

        )

)

中国站