Queries detailed information of a flow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFlow

The operation that you want to perform. Set the value to DescribeFlow.

RequestId String No testRequestId

The ID of the request. If you specify this parameter, the system uses this value as the ID of the request. If you do not specify this parameter, the system generates a value at random.

Name String Yes flow

The name of the flow.

Response parameters

Parameter Type Example Description
Type String FDL

The type of the flow. Set the value to FDL.

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

The definition of the flow. It must comply with the Flow Definition Language (FDL) syntax.

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

The ARN of the specified RAM role.

RequestId String testRequestId

The ID of the request.

Description String test flow

The description of the flow.

Name String flow

The name of the flow.

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

The time when the flow was created.

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

The time when the flow was last modified.

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

The unique ID of the flow.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeFlow
&RequestId=testRequestId
&Name=flow
&<Common request parameters>

Sample success responses

JSON format 

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****"
}

Error codes

HttpCode Error code Error message Description
400 EntityTooLarge The payload size exceeds maximum allowed size (%s bytes). The error message returned because the request message body is too large.
400 InvalidArgument Parameter error. The error message returned because the values specified for one or more request parameters are invalid. For more information, see the error message.
400 MissingRequiredHeader The HTTP header '%s' must be specified. The error message returned because a required request parameter is not specified. For more information, see the error message.
400 MissingRequiredParams The HTTP query '%s' must be specified. The error message returned because a required request parameter is not specified. For more information, see the error message.
403 InvalidAccessKeyID The AccessKey ID %s is invalid. The error message returned because the specified AccessKey ID is invalid.
403 RequestTimeTooSkewed The difference between the request time %s and the current time %s is too large. The error message returned because your request time is wrong. The request has been identified as invalid. For more information, see the "Common parameters" section.
403 SignatureNotMatch The request signature we calculated does not match the signature you provided. Check your access key and signing method. The error message returned because the request signature that the system calculates does not match the request signature that you provided. Check your signature algorithm and AccessKey secret.
404 FlowNotExists Flow %s does not exist. The error message returned because the requested resource does not exist. Make sure that you have created a flow.
412 PreconditionFailed The resource to be modified has been changed. The error message returned because resource view or check for updates failed, and the resource may be modified. Try again later.
415 UnsupportedMediaType The content type must be "application/json". The error message returned because the type of the request message body is wrong.
429 ResourceThrottled The request is throttled. Please try again later. The error message returned because the request is throttled for some reason. Try again later.
500 InternalServerError An internal error has occurred. Please retry. The error message returned because an internal server error has occurred. Try again later.

For a list of error codes, visit the API Error Center.