文档

GetFlow - 获取工作流详情

更新时间:

查询一个工作流的具体信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
composer:GetFlowRead
  • Flow
    acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}

请求参数

名称类型必填描述示例值
FlowIdstring

工作流 ID

lc-uf6pvud38xl0ia

返回参数

名称类型描述示例值
object
UpdateTimestring

最后更新时间

2019-07-19T05:43:16.783Z
FlowSourcestring

工作流来源

CloudConfig
CreateTimestring

创建时间

2019-07-19T05:43:16.783Z
FlowEditModestring

编辑模式

Locked
FlowDescriptionstring

工作流的描述

这是一个工作流
CurrentVersionIdstring

工作流编排实例的版本 ID

ve-uf6bwdtvid7o25
FlowNamestring

工作流编排实例的名称

test
FlowIdstring

工作流编排实例的 ID

lc-uf6pvud38xl0ia
RegionIdstring

地域 ID

cn-shanghai
Definitionstring

工作流定义

{\"schemaVersion\":\"2018-12-12\",\"actions\":{},\"version\":\"1.0.0\",\"triggers\":{}}
RequestIdstring

请求 ID

ADB97A33-50E7-48A5-963D-ACBAE36D0BEC
FlowStatusstring

状态。

  • Enabled:启用
  • Disabled:已禁用
Enabled
TemplateIdstring

模板 ID

tp-uf6tbvhheciyxl
ResourceGroupIdstring

资源组 ID

rg-acfmzyxxxxxxx

示例

正常返回示例

JSON格式

{
  "UpdateTime": "2019-07-19T05:43:16.783Z",
  "FlowSource": "CloudConfig",
  "CreateTime": "2019-07-19T05:43:16.783Z",
  "FlowEditMode": "Locked",
  "FlowDescription": "这是一个工作流",
  "CurrentVersionId": "ve-uf6bwdtvid7o25",
  "FlowName": "test",
  "FlowId": "lc-uf6pvud38xl0ia",
  "RegionId": "cn-shanghai",
  "Definition": "{\\\"schemaVersion\\\":\\\"2018-12-12\\\",\\\"actions\\\":{},\\\"version\\\":\\\"1.0.0\\\",\\\"triggers\\\":{}}",
  "RequestId": "ADB97A33-50E7-48A5-963D-ACBAE36D0BEC",
  "FlowStatus": "Enabled",
  "TemplateId": "tp-uf6tbvhheciyxl",
  "ResourceGroupId": "rg-acfmzyxxxxxxx"
}

错误码

HTTP status code错误码错误信息描述
404InvalidFlow.NotFoundThe specified workflow does not exist. Verify the availability of the workflow.指定的流程不存在,请确认该流程的状态是否可用。

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-11-21OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
API 描述OpenAPI 描述信息更新
错误码OpenAPI 错误码发生变更
    删除错误码:404
出参OpenAPI 返回结构发生变更