文档中心对象存储SDK 文档PHP SDK工作流接口获取工作流实例列表

获取工作流实例列表

最近更新时间：2023-11-23 19:42:41

本页目录：

简介
获取工作流实例列表

简介
本文档提供关于获取工作流实例列表的 API 概览和 SDK 示例代码。
API
操作描述
获取工作流实例列表
用于获取工作流实例列表
获取工作流实例列表
功能说明
用于获取工作流实例列表。
方法原型
public Guzzle\\Service\\Resource\\Model getWorkflowInstances(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 {
    // https://cloud.tencent.com/document/product/436/53993 获取工作流实例列表
    $result = $cosClient->getWorkflowInstances(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称，由BucketName-Appid 组成，可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'workflowId' => 'w9938ed4b1435448783xxxxxxxxxxxxxx',
//        'name' => '',
//        'orderByTime' => '',
//        'size' => '',
//        'states' => '',
//        'startCreationTime' => '',
//        'endCreationTime' => '',
//        'nextToken' => '',
    ));
    // 请求成功
    print_r($result);
} catch (\\Exception $e) {
    // 请求失败
    echo($e);
}
参数说明
Request 中的具体数据描述如下：
参数名称（关键字）
描述
类型
是否必选
workflowId
工作流 ID.
string
是
name
文件名称。
string
否
orderByTime
Desc 或者 Asc。默认为 Desc。
string
否
size
拉取的最大任务数。默认为10。最大为100。
string
否
states
工作流实例状态，以,分割支持多状态 All，Success，Failed，Running，Cancel。默认为 All。
string
否
startCreationTime
拉取创建时间大于该时间。格式为：%Y-%m-%dT%H:%m:%S%z。
String
否
endCreationTime
拉取创建时间小于该时间。格式为：%Y-%m-%dT%H:%m:%S%z。
String
否
nextToken
请求的上下文，用于翻页。下一页输入 token。
String
否
返回结果示例
GuzzleHttp\\Command\\Result Object
(
    [RequestId] => NjJhODAxZThfZmNjAJSIOPDJAOIJDOIAD5NWQ=
    [ContentType] => application/xml
    [ContentLength] => 1517
    [NextToken] => 214283246
    [WorkflowExecutionList] => Array
        (
            [0] => Array
                (
                    [RunId] => i7fb6e17ceb9011ec9eas7d9asf9sa8f90sdf6f
                    [WorkflowId] => w9938ed4b1435448783a2asd809a8ds0a9ddd
                    [State] => Success
                    [CreateTime] => 2022-06-14T11:17:19+08:00
                    [Object] => test01.png
                )
﻿
            [1] => Array
                (
                    [RunId] => i7fb6e17ceb9011ec9eas7d9asf9sa8f90sdf6f
                    [WorkflowId] => w9938ed4b1435448783a2asd809a8ds0a9ddd
                    [State] => Success
                    [CreateTime] => 2022-05-31T17:01:41+08:00
                    [Object] => test01.png
                )
﻿
            [2] => Array
                (
                    [RunId] => i7fb6e17ceb9011ec9eas7d9asf9sa8f90sdf6f
                    [WorkflowId] => w9938ed4b1435448783a2asd809a8ds0a9ddd
                    [State] => Success
                    [CreateTime] => 2022-05-31T11:48:41+08:00
                    [Object] => test01.png
                )
﻿
            [3] => Array
                (
                    [RunId] => i7fb6e17ceb9011ec9eas7d9asf9sa8f90sdf6f
                    [WorkflowId] => w9938ed4b1435448783a2asd809a8ds0a9ddd
                    [State] => Success
                    [CreateTime] => 2022-05-31T11:33:29+08:00
                    [Object] => test01.png
                )
﻿
        )
﻿
    [Bucket] => examplebucket-125000000
    [Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/workflowexecution
)
﻿

上一篇: 搜索工作流下一篇: 获取工作流实例详情

文档反馈

文档活动

目录