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

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFlow

系统规定参数。取值:DescribeFlow

RequestId String testRequestId

请求ID。如果您指定了该值,系统将使用该值作为本次请求的ID;如果您不指定,系统将随机生成。

Name String flow

流程名称。

返回数据

名称 类型 示例值 描述
Type String FDL

流程类型。取值:FDL

Definition String version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass

流程定义,遵循FDL语法标准。

RoleArn String acs:ram::${accountID}:${role}

流程执行所需资源描述符信息。

RequestId String testRequestId

请求ID。

Description String test flow

流程描述。

Name String flow

流程名称。

CreatedTime String 2019-01-01T01:01:01.001Z

流程创建时间。

LastModifiedTime String 2019-01-01T01:01:01.001Z

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

Id String e589e092-e2c0-4dee-b306-3574ddfdddf5****

流程的唯一ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFlow
&RequestId=testRequestId
&Name=flow
&公共请求参数

正常返回示例

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Type" : "FDL",
  "Definition" : "version: v1.0\\ntype: flow\\nname: test\\nsteps:\\n - type: pass\\n name: mypass",
  "RoleArn" : "acs:ram::${accountID}:${role}",
  "RequestId" : "testRequestId",
  "Description" : "test flow",
  "Name" : "flow",
  "CreatedTime" : "2019-01-01T01:01:01.001Z",
  "LastModifiedTime" : "2019-01-01T01:01:01.001Z",
  "Id" : "e589e092-e2c0-4dee-b306-3574ddfdddf5****"
}

错误码

HttpCode 错误码 错误信息 描述
400 EntityTooLarge The payload size exceeds maximum allowed size (%s bytes). 请求消息体过大。
400 InvalidArgument Parameter error. 请求参数错误。具体内容请参考实际错误信息。
400 MissingRequiredHeader The HTTP header '%s' must be specified. 请求所需参数缺失。具体内容请参考实际错误信息。
400 MissingRequiredParams The HTTP query '%s' must be specified. 请求所需参数缺失。具体内容请参考实际错误信息。
403 InvalidAccessKeyID The AccessKey ID %s is invalid. AccessKey ID无效。
403 RequestTimeTooSkewed The difference between the request time %s and the current time %s is too large. 您的请求时间不正确,该请求已被识别为无效。请参考通用参数一节。
403 SignatureNotMatch The request signature we calculated does not match the signature you provided. Check your access key and signing method. 您发起请求的签名与我们计算不一致,请检查您的签名算法及AccessKey Secret。
404 FlowNotExists Flow %s does not exist. 所请求资源不存在,请确保流程已创建。
412 PreconditionFailed The resource to be modified has been changed. 资源查看或更新检查失败,该资源可能已被更改。请稍后重试。
415 UnsupportedMediaType The content type must be "application/json". 请求消息体类型错误。
429 ResourceThrottled The request is throttled. Please try again later. 因某些原因系统流量已达瓶颈。请稍后重试。
500 InternalServerError An internal error has occurred. Please retry. 服务器内部错误。请稍后重试。

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