All Products
Search
Document Center

Logic Composer:GetFlow

Last Updated:Mar 01, 2024

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

Request parameters

ParameterTypeRequiredDescriptionExample
FlowIdstringYes

The ID of the workflow.

lc-uf6pvud38xl0ia

Response parameters

ParameterTypeDescriptionExample
object
UpdateTimestring

The time when the workflow was last updated.

2019-07-19T05:43:16.783Z
FlowSourcestring

The source of the workflow.

CloudConfig
CreateTimestring

The time when the workflow was created.

2019-07-19T05:43:16.783Z
FlowEditModestring

The edit mode of the workflow.

Locked
FlowDescriptionstring

The description of the workflow.

This is a workflow.
CurrentVersionIdinteger

The version ID of the workflow.

1
FlowNamestring

The name of the workflow.

test
FlowIdstring

The ID of the workflow.

lc-uf6pvud38xl0ia
RegionIdstring

The ID of the region where the workflow resides.

cn-shanghai
Definitionstring

The definition of the workflow.

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

The ID of the request.

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

The status of the workflow. Valid values:

  • Enabled: The workflow is enabled.
  • Disabled: The workflow is disabled.
Enabled
TemplateIdstring

The template ID.

tp-uf6tbvhheciyxl
ResourceGroupIdstring

The resource group ID.

rg-acfmzyxxxxxxx

Examples

Sample success responses

JSONformat

{
  "UpdateTime": "2019-07-19T05:43:16.783Z",
  "FlowSource": "CloudConfig",
  "CreateTime": "2019-07-19T05:43:16.783Z",
  "FlowEditMode": "Locked",
  "FlowDescription": "This is a workflow.\n",
  "CurrentVersionId": 1,
  "FlowName": "test",
  "FlowId": "lc-uf6pvud38xl0ia",
  "RegionId": "cn-shanghai",
  "Definition": "{\\\"schemaVersion\\\":\\\"2018-12-12\\\",\\\"actions\\\":{},\\\"version\\\":\\\"1.0.0\\\",\\\"triggers\\\":{}}",
  "RequestId": "ADB97A33-50E7-48A5-963D-ACBAE36D0BEC",
  "FlowStatus": "Enabled",
  "TemplateId": "tp-uf6tbvhheciyxl",
  "ResourceGroupId": "rg-acfmzyxxxxxxx"
}

Error codes

HTTP status codeError codeError messageDescription
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 changed. The response structure of the API has changedsee changesets
Change itemChange content
API DescriptionAPI Description Update.
Error CodesThe Error code has changed.
    delete Error Codes: 404
Output ParametersThe response structure of the API has changed.