更新时间:2024-03-05 GMT+08:00
分享

API触发启动工作流(Python SDK)

功能说明

API触发启动工作流。

接口约束

方法定义

WorkflowClient.asyncAPIStartWorkflow(graphName, bucket, object, inputs=None)

请求参数

表1 请求参数列表

名称

是否必选

参数类型

描述

graphName

str

参数解释

工作流名称

约束限制:

名称必须以字母或数字开头,只能由字母、数字、下划线和中划线组成,长度小于等于64个字符,且不能重名。

默认取值:

bucket

str

参数解释

桶名。

约束限制:

  • 桶的名字需全局唯一,不能与已有的任何桶名称重复,包括其他用户创建的桶。
  • 桶命名规则如下:
    • 3~63个字符,数字或字母开头,支持小写字母、数字、“-”、“.”。
    • 禁止使用IP地址。
    • 禁止以“-”或“.”开头及结尾。
    • 禁止两个“.”相邻(如:“my..bucket”)。
    • 禁止“.”和“-”相邻(如:“my-.bucket”和“my.-bucket”)。
  • 同一用户在同一个区域多次创建同名桶不会报错,创建的桶属性以第一次请求为准。

默认取值:

object

str

参数解释:

对象名。对象名是对象在存储桶中的唯一标识。对象名是对象在桶中的完整路径,路径中不包含桶名。

例如,您对象的访问地址为examplebucket.obs.cn-north-4.myhuaweicloud.com/folder/test.txt 中,对象名为folder/test.txt。

取值范围:

长度大于0且不超过1024的字符串。

默认取值:

inputs

map

参数解释

工作流中可修改参数列表

约束限制:

Map中的key必须是工作流中的parameter中的名字

默认取值:

返回结果

表2 返回结果

类型

说明

GetResult

参数解释:

SDK公共结果对象。

表3 GetResult

参数名称

参数类型

描述

status

int

参数解释:

HTTP状态码。

取值范围:

状态码是一组从2xx(成功)到4xx或5xx(错误)的数字代码,状态码表示了请求响应的状态。完整的状态码列表请参见状态码

默认取值:

reason

str

参数解释:

HTTP文本描述。

默认取值:

errorCode

str

参数解释:

OBS服务端错误码,当status参数小于300时为空。

默认取值:

errorMessage

str

参数解释:

OBS服务端错误描述,当status参数小于300时为空。

默认取值:

requestId

str

参数解释:

OBS服务端返回的请求ID。

默认取值:

indicator

str

参数解释:

OBS服务端返回的错误定位码。

默认取值:

hostId

str

参数解释:

请求的服务端ID,当status参数小于300时为空。

默认取值:

resource

str

参数解释:

发生错误时相关的桶或对象,当status参数小于300时为空。

默认取值:

header

list

参数解释:

响应消息头列表,由多个元组构成。每个元组均包含两个元素,代表响应头的键值对。

默认取值:

body

object

参数解释:

操作成功后的结果数据,当status大于300时为空。该值根据调用接口的不同而不同,参见“桶相关接口”章节和“对象相关接口”章节的详细描述。

默认取值:

表4 返回结果

GetResult.body类型

说明

表5

参数解释:

响应结果,详见表5

表5 AsyncAPIStartWorkflowResponse

参数名称

参数类型

描述

executionUrn

str

参数解释

运行实例的URN

默认取值:

startedAt

str

参数解释

运行实例启动时间

默认取值:

executionName

str

参数解释

运行实例的名字

默认取值:

代码样例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# 引入模块
from obs import WorkflowClient

# 创建WorkflowClient实例
workflowClient = WorkflowClient(
    access_key_id=os.getenv("AccessKeyID"),
    secret_access_key=os.getenv("SecretAccessKey"),
    server='https://your-endpoint'
)

# API触发启动工作流
try:
    resp = workflowClient.asyncAPIStartWorkflow('graphName', 'bucket', 'object', inputs='inputs')
      
    if resp.status < 300: 
        print('requestId:', resp.requestId) 
    else: 
        print('errorCode:', resp.errorCode) 
        print('errorMessage:', resp.errorMessage)
except:
    import traceback
    print(traceback.format_exc())

# 关闭workflowClient
workflowClient.close()

相关链接

  • 关于API触发启动工作流的API说明,请参见API异步启动工作流
  • API触发启动工作流过程中返回的错误码含义、问题原因及处理措施可参考OBS错误码
分享:

    相关文档

    相关产品