All Products
Search
Document Center

Logic Composer:UpdateFlow

Last Updated:Mar 01, 2024

Updates information about a workflow.

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
composer:UpdateFlowWrite
  • Flow
    acs:composer:{#regionId}:{#accountId}:flow/{#FlowId}
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
FlowIdstringYes

The ID of the workflow whose information you want to update.

lc-uf6axpwfcw4ubx
FlowNamestringNo

The new name that you want to specify for the workflow.

test
FlowDescriptionstringNo

The new description that you want to specify for the workflow.

This is the description of the workflow.
DefinitionstringNo

The new definition that you want to specify for the workflow.

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

Response parameters

ParameterTypeDescriptionExample
object
CurrentVersionIdinteger

The version ID of the workflow after the update.

ve-uf6bwdtvid7o25
RequestIdstring

The ID of the request.

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

Indicates whether the operation was successful. Valid values:

  • true: The operation was successful.
  • false: The operation failed.
true

Examples

Sample success responses

JSONformat

{
  "CurrentVersionId": 0,
  "RequestId": "ADB97A33-50E7-48A5-963D-ACBAE36D0BEC",
  "Success": true
}

Error codes

HTTP status codeError codeError messageDescription
400InvalidDefinition.FormatThe specified workflow definition is incorrectly formatted. It must be valid JSON content.The content of the workflow is invalid. The content must be in the JSON format.
400InvalidParameter.DefinitionThe specified definition is invalid.The specified definition is invalid.
400InvalidParameter.Description.LengthThe specified description cannot be more than 255 characters in length.The specified description cannot be more than 255 characters in length.
400InvalidParameter.NameThe specified name is invalid.The specified name is invalid.
400InvalidParameter.Name.LengthThe specified name cannot be more than 100 characters in length.The specified name cannot be more than 100 characters in length.
403NoPermissionYou are not authorized to perform this operation. %s.You are not authorized to perform this operation.
404InvalidFlow.NotFoundThe specified workflow does not exist. Verify the availability of the workflow.The specified workflow does not exist. Make sure the workflow is available.

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

Change history

Change timeSummary of changesOperation
2022-11-21API Description Update. The Error code has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    Added Error Codes: 400
    Added Error Codes: 403
    Added Error Codes: 404