UpdateFlow
Updates the content of a flow.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
fnf:UpdateFlow |
update |
*All Resource
|
None | None |
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| Name |
string |
Yes |
The name of the flow. |
my_flow_name |
| Definition |
string |
No |
The flow definition, which follows the Flow Definition Language (FDL) syntax standard. For forward compatibility, the system supports two flow definition specifications. Note
In the preceding flow definition examples, Name: my_flow_name specifies the flow name, which must be consistent with the Name request parameter. |
Legacy: " type: flow version: v1 name: my_flow_name steps: - type: pass name: mypass " Latest: " Type: StateMachine SpecVersion: v1 Name: my_flow_name StartAt: my_state States: - Type: Pass Name: my_state End: true " |
| Description |
string |
No |
The description of the flow. |
my test flow |
| Type |
string |
No |
The type of the flow. Valid values: FDL. |
FDL |
| RoleArn |
string |
No |
The resource descriptor of the authorized role on which the flow execution depends. When the flow is executed, the flow execution engine assumes this role to call related flow resource APIs. |
acs:ram:${region}:${accountID}:${role} |
| Environment |
object |
No |
The list of variables that can be accessed during flow execution. |
|
| Variables |
array<object> |
No |
The list of variables that can be accessed during flow execution. |
|
|
object |
No |
The list of variables that can be accessed during flow execution. |
||
| Name |
string |
No |
The name of the variable. |
key |
| Value |
string |
No |
The value of the variable. |
value |
| Description |
string |
No |
The description of the variable. |
description |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The returned data. |
||
| Type |
string |
The type of the flow. |
FDL |
| Definition |
string |
The flow definition, which follows the Flow Definition Language (FDL) syntax standard. For forward compatibility, the system supports two flow definition specifications. |
Legacy: "type: flow\nversion: v1\nname: my_flow_name\nsteps:\n - type: pass\n name: mypass" Latest: "Type: StateMachine\nSpecVersion: v1\nName: my_flow_name\nStartAt: my_state\nStates:\n - Type: Pass\n Name: my_state\n End: true" |
| RoleArn |
string |
The resource descriptor of the authorized role on which the flow execution depends. When the flow is executed, the flow execution engine assumes this role to call related flow resource APIs. |
acs:ram:${region}:${accountID}:${role} |
| RequestId |
string |
The ID of the request. |
testRequestID |
| Description |
string |
The description of the flow. |
my test flow |
| ExternalStorageLocation |
string |
The external storage location. |
/path |
| Name |
string |
The name of the flow. |
my_flow_name |
| CreatedTime |
string |
The time when the flow was created. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss.sssZ format. |
2019-01-01T01:01:01.001Z |
| LastModifiedTime |
string |
The time when the flow was last modified. The time is displayed in UTC and follows the ISO 8601 standard in the YYYY-MM-DDThh:mm:ss.sssZ format. |
2019-01-01T01:01:01.001Z |
| Id |
string |
The unique ID of the flow. |
e589e092-e2c0-4dee-b306-3574ddfdddf5**** |
| Environment |
object |
The list of variables that can be accessed during flow execution. |
|
| Variables |
array<object> |
The list of variables that can be accessed during flow execution. |
|
|
object |
The list of variables that can be accessed during flow execution. |
||
| Name |
string |
The name of the variable. |
key |
| Value |
string |
The value of the variable. |
value |
| Description |
string |
The description of the variable. |
description |
| ResourceGroupId |
string |
The ID of the resource group to which the flow belongs. |
rg-xxx |
Examples
Success response
JSON format
{
"Type": "FDL",
"Definition": "Legacy version:\n\"type: flow\\nversion: v1\\nname: my_flow_name\\nsteps:\\n - type: pass\\n name: mypass\"\n\nNew version:\n\"Type: StateMachine\\nSpecVersion: v1\\nName: my_flow_name\\nStartAt: my_state\\nStates:\\n - Type: Pass\\n Name: my_state\\n End: true\"",
"RoleArn": "acs:ram:${region}:${accountID}:${role}",
"RequestId": "testRequestID",
"Description": "my test flow",
"ExternalStorageLocation": "/path",
"Name": "my_flow_name",
"CreatedTime": "2019-01-01T01:01:01.001Z",
"LastModifiedTime": "2019-01-01T01:01:01.001Z",
"Id": "e589e092-e2c0-4dee-b306-3574ddfdddf5****",
"Environment": {
"Variables": [
{
"Name": "key",
"Value": "value",
"Description": "description"
}
]
},
"ResourceGroupId": "rg-xxx"
}
Error codes
|
HTTP status code |
Error code |
Error message |
Description |
|---|---|---|---|
| 400 | ActionNotSupported | The requested API operation '%s' is incorrect. Please check. | |
| 400 | APIVersionNotSupported | The requested API version '%s' is not supported yet. Please check. | |
| 400 | InvalidArgument | Parameter error. | Parameter error. |
| 400 | MissingRequiredHeader | The HTTP header '%s' must be specified. | The HTTP header '%s' must be specified. |
| 400 | MissingRequiredParams | The HTTP query '%s' must be specified. | The HTTP query '%s' must be specified. |
| 412 | PreconditionFailed | The resource to be modified has been changed. | The resource to be modified has been changed. Please try again later. |
| 500 | InternalServerError | An internal error has occurred. Please retry. | An internal error has occurred. Please retry. |
| 403 | AccessDenied | The resources doesn't belong to you. | |
| 403 | InvalidAccessKeyID | The AccessKey ID %s is invalid. | The AccessKey ID %s is invalid. |
| 403 | RequestTimeTooSkewed | The 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. |
| 403 | SignatureNotMatch | The 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. |
| 404 | FlowNotExists | Flow %s does not exist. | Flow %s does not exist. |
| 415 | UnsupportedMediaType | The content type must be "application/json". | The content type must be "application/json". |
| 429 | ResourceThrottled | The request is throttled. Please try again later. | The request is throttled. Please try again later. |
| 409 | ConcurrentUpdateError | Update conflict, please retry. | Update conflict, please retry. |
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.