All Products
Search
Document Center

CloudFlow:UpdateFlow

Last Updated:Jul 30, 2024

Updates a flow.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
fnf:UpdateFlowupdate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
NamestringYes

The name of the workflow.

flow
DefinitionstringNo

The definition of the workflow. The definition must comply with the flow definition language (FDL) syntax. Considering compatibility, the system supports the two workflow definition specifications.

Note In the preceding workflow definition example, Name:my_flow_name is the workflow name, which must be consistent with the input parameter Name
version: v1.0\ntype: flow\nname: test\nsteps:\n - type: pass\n name: mypass
DescriptionstringNo

The description of the flow.

test definition
TypestringNo

The type of the flow. Valid value: FDL.

FDL
RoleArnstringNo

The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, the flow execution engine assumes the role to call API operations of relevant services.

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

Response parameters

ParameterTypeDescriptionExample
object

The schema of response.

Typestring

The type of the flow.

FDL
Definitionstring

The flow definition, which follows the FDL syntax standard. Considering compatibility, the system supports the two flow definition specifications.

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

The Alibaba Cloud resource name (ARN) of the authorized role on which the execution of the flow relies. During the execution of the flow, the flow execution engine assumes the role to call API operations of relevant services.

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

The request ID.

testRequestID
Descriptionstring

The description of the flow.

test definition
ExternalStorageLocationstring

The path of the external storage.

/path
Namestring

The name of the flow.

flow
CreatedTimestring

The time when the flow was created.

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

The time when the flow was last modified.

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

The unique ID of the flow.

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

Examples

Sample success responses

JSONformat

{
  "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 definition",
  "ExternalStorageLocation": "/path",
  "Name": "flow",
  "CreatedTime": "2019-01-01T01:01:01.001Z",
  "LastModifiedTime": "2019-01-01T01:01:01.001Z",
  "Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****"
}

Error codes

HTTP status codeError codeError messageDescription
400ActionNotSupportedThe requested API operation '%s' is incorrect. Please check.-
400APIVersionNotSupportedThe requested API version '%s' is not supported yet. Please check.-
400InvalidArgumentParameter error.Parameter error.
400MissingRequiredHeaderThe HTTP header '%s' must be specified.The HTTP header '%s' must be specified.
400MissingRequiredParamsThe HTTP query '%s' must be specified.The HTTP query '%s' must be specified.
403AccessDeniedThe resources doesn't belong to you.-
403InvalidAccessKeyIDThe AccessKey ID %s is invalid.The AccessKey ID %s is invalid.
403RequestTimeTooSkewedThe difference between the request time %s and the current time %s is too large.The 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.The calculated signature of the request does not match the signature you provided. Check your AccessKey Secret and signing algorithm.
404FlowNotExistsFlow %s does not exist.Flow %s does not exist.
409ConcurrentUpdateErrorUpdate conflict, please retry.Update conflict, please retry.
412PreconditionFailedThe resource to be modified has been changed.The resource to be modified has been changed. Please try again later.
415UnsupportedMediaTypeThe content type must be "application/json".The content type must be "application/json".
429ResourceThrottledThe request is throttled. Please try again later.The request is throttled. Please try again later.
500InternalServerErrorAn internal error has occurred. Please retry.An internal error has occurred. Please retry.

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
2024-03-20The API operation is not deprecated.. The Error code has changed. The request parameters of the API has changedView Change Details