控制台指南

最佳实践

开发者指南

数据湖存储

API 文档

SDK 文档

文档捉虫大赛火热进行中,好礼多多> HOT

简介

本文档提供关于获取工作流实例详情的 API 概览和 SDK 示例代码。

API 操作描述
获取工作流实例详情 用于获取工作流实例详情。

获取工作流实例详情

功能说明

用于获取工作流实例详情。

方法原型

public Guzzle\Service\Resource\Model getWorkflowInstance(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,
        'schema' => 'https', // 默认http
        'credentials' => array(
            'secretId' => $secretId,
            'secretKey' => $secretKey)));
try {
    // https://cloud.tencent.com/document/product/436/53992 获取工作流实例详情
    $result = $cosClient->getWorkflowInstance(array(
        'Bucket' => 'examplebucket-125000000', //存储桶名称,由BucketName-Appid 组成,可以在COS控制台查看 https://console.cloud.tencent.com/cos5/bucket
        'Key' => '', // RunId
    ));
    // 请求成功
    print_r($result);
} catch (\Exception $e) {
    // 请求失败
    echo($e);
}

参数说明

参数名称 类型 描述 是否必填
Bucket String 存储桶名称,格式:BucketName-APPID
Key String 需要查询的工作流实例 ID

返回结果示例

GuzzleHttp\Command\Result Object
(
    [Body] => GuzzleHttp\Psr7\Stream Object
        (
            [stream:GuzzleHttp\Psr7\Stream:private] => Resource id #88
            [size:GuzzleHttp\Psr7\Stream:private] => 
            [seekable:GuzzleHttp\Psr7\Stream:private] => 1
            [readable:GuzzleHttp\Psr7\Stream:private] => 1
            [writable:GuzzleHttp\Psr7\Stream:private] => 1
            [uri:GuzzleHttp\Psr7\Stream:private] => php://temp
            [customMetadata:GuzzleHttp\Psr7\Stream:private] => Array
                (
                )

        )

    [RequestId] => NjJhODJjOTZfNzgwYzdkNASDOIDUIOSDASDSLKJLDKGYyOTA=
    [ContentType] => application/xml
    [ContentLength] => 1947
    [Key] => i7fb6e17ceb90zx8cv09x7v98xc79v8x030d6f
    [Bucket] => examplebucket-125000000
    [Location] => examplebucket-125000000.ci.ap-guangzhou.myqcloud.com/workflowexecution/i7fb6e17ceb90zx8cv09x7v98xc79v8x030d6f
    [Response] => Array
        (
            [RequestId] => NjJhODJjOTZfNzgwYzdkNASDOIDUIOSDASDSLKJLDKGYyOTA=
            [WorkflowExecution] => Array
                (
                    [CreateTime] => 2022-06-14T11:17:19+08:00
                    [Object] => test01.png
                    [RunId] => i7fb6e17ceb90zx8cv09x7v98xc79v8x030d6f
                    [State] => Success
                    [Tasks] => Array
                        (
                            [Code] => Success
                            [CreateTime] => 2022-06-14T11:17:19+08:00
                            [EndTime] => 2022-06-14T11:17:19+08:00
                            [JobId] => c7fe16e8eeb90bcv098b90cb80957a7abbe
                            [Name] => PicProcess_16533788711116
                            [StartTime] => 2022-06-14T11:17:19+08:00
                            [State] => Success
                            [Type] => PicProcess
                        )

                    [Topology] => Array
                        (
                            [Dependencies] => Array
                                (
                                    [PicProcess_16533788711116] => End
                                    [Start] => PicProcess_16533788711116
                                )

                            [Nodes] => Array
                                (
                                    [PicProcess_16533788711116] => Array
                                        (
                                            [Operation] => Array
                                                (
                                                    [Output] => Array
                                                        (
                                                            [Bucket] => examplebucket-125000000
                                                            [Object] => ${InputPath}${InputName}_${RunId}.${ext}
                                                            [Region] => ap-guangzhou
                                                        )

                                                    [TemplateId] => t1648745f76c354e8a8c90zxd8cv98a09
                                                )

                                            [Type] => PicProcess
                                        )

                                    [Start] => Array
                                        (
                                            [Input] => Array
                                                (
                                                    [ExtFilter] => Array
                                                        (
                                                            [Image] => true
                                                            [State] => On
                                                        )

                                                    [NotifyConfig] => Array
                                                        (
                                                            [Event] => TaskFinish,WorkflowFinish
                                                            [ResultFormat] => JSON
                                                            [State] => On
                                                            [Type] => Url
                                                            [Url] => http://127.0.0.1/xxx
                                                        )

                                                    [ObjectPrefix] => /workflow/
                                                    [PicProcessQueueId] => pcf4d6e734d0bas8d09a8d09ad06ad0
                                                    [QueueId] => pcf4d6e734asdad09a8d09ad06ad0
                                                )

                                            [Type] => Start
                                        )

                                )

                        )

                    [WorkflowId] => w9938ed4b1435448asd890a8d09addebdd
                    [WorkflowName] => workflow-1
                )

        )

)

目录