文档

DescribeFlow - 获取一个流程的相关信息

更新时间:

获取一个流程的相关信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

流程名称。

my_flow_name

返回参数

名称类型描述示例值
object

返回数据。

Typestring

流程类型。

FDL
Definitionstring

流程定义,遵循 Flow Definition Language (FDL)语法标准。考虑到向前兼容,当系统支持两种规范的流程定义规范。

旧版: " type: flow version: v1 name: my_flow_name steps: - type: pass name: mypass " 新版: " Type: StateMachine SpecVersion: v1 Name: my_flow_name StartAt: my_state States: - Type: Pass Name: my_state End: true "
RoleArnstring

流程执行依赖的授权角色资源描述符信息。用于在执行流程时,Serverless 工作流服务扮演该角色(AssumeRole)操作相关的流程资源。

acs:ram:${region}:${accountID}:${role}
RequestIdstring

请求 ID。

testRequestId
Descriptionstring

流程描述。

my test flow
Namestring

流程名称。

my_flow_name
CreatedTimestring

流程创建时间。

2019-01-01T01:01:01.001Z
LastModifiedTimestring

流程最近一次的更改时间。

2019-01-01T01:01:01.001Z
Idstring

流程的唯一 ID。

e589e092-e2c0-4dee-b306-3574ddfdddf5****
ExecutionModestring

执行模式,枚举类型,可以是 Express 和 Standard,空串等价于 Standard

Standard

示例

正常返回示例

JSON格式

{
  "Type": "FDL",
  "Definition": "旧版:\n\"\ntype: flow\nversion: v1\nname: my_flow_name\nsteps:\n  - type: pass\n    name: mypass\n\"\n\n新版:\n\"\nType: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n  - Type: Pass\n    Name: my_state\n    End: true\n\"",
  "RoleArn": "acs:ram:${region}:${accountID}:${role}",
  "RequestId": "testRequestId",
  "Description": "my test flow",
  "Name": "my_flow_name",
  "CreatedTime": "2019-01-01T01:01:01.001Z",
  "LastModifiedTime": "2019-01-01T01:01:01.001Z",
  "Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****",
  "ExecutionMode": "Standard"
}

错误码

HTTP status code错误码错误信息描述
400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
400EntityTooLargeThe payload size exceeds maximum allowed size (%s bytes).请求消息体过大。
400InvalidArgumentParameter error.请求参数错误。具体内容请参考实际错误信息。
400MissingRequiredHeaderThe HTTP header '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
400MissingRequiredParamsThe HTTP query '%s' must be specified.请求所需参数缺失。具体内容请参考实际错误信息。
403AccessDeniedThe resources doesn't belong to you.-
403InvalidAccessKeyIDThe AccessKey ID %s is invalid.AccessKey ID无效。
403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。
403SignatureNotMatchThe request signature we calculated does not match the signature you provided. Check your access key and signing method.您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。
404FlowNotExistsFlow %s does not exist.所请求资源不存在,请确保流程已创建。
412PreconditionFailedThe resource to be modified has been changed.资源查看或更新检查失败,该资源可能已被更改。请稍后重试。
415UnsupportedMediaTypeThe content type must be "application/json".请求消息体类型错误。
429ResourceThrottledThe request is throttled. Please try again later.因某些原因系统流量已达瓶颈。请稍后重试。
500InternalServerErrorAn internal error has occurred. Please retry.服务器内部错误。请稍后重试。

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

变更历史

变更时间变更内容概要操作
2024-03-20OpenAPI 错误码发生变更、OpenAPI 入参发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:412
    删除错误码:415
    删除错误码:429
    删除错误码:500
入参OpenAPI 入参发生变更
    删除入参:RequestId
2023-08-29OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
变更项变更内容
错误码OpenAPI 错误码发生变更
    删除错误码:400
    删除错误码:403
    删除错误码:404
    删除错误码:412
    删除错误码:415
    删除错误码:429
    删除错误码:500
出参OpenAPI 返回结构发生变更