You can call ListFlowCategory operation to query workflow directories.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. You can use OpenAPI Explorer to search for API operations, call API operations, and dynamically generate SDK sample code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListFlowCategory

The operation that you want to perform. This parameter is required for API requests that you create by piecing together HTTP or HTTPS URLs. Set the value to ListFlowCategory.

ProjectId String Yes FP-6E8E198E6C79****

The ID of the project. You can call ListFlowProject View the ID of the project.

RegionId String Yes cn-hangzhou

The region ID of the instance. You can call DescribeRegions To view the latest list of Alibaba Cloud regions.

ParentId String No FC-6E8E198E6C79****

The ID of the parent directory. You can call DescribeFlowCategory View data on the Member Management page.

Root Boolean No false

Specifies whether the directory to be queried is a root directory.

PageNumber Integer No 1

The number of the page returned.

PageSize Integer No 10

The number of entries returned on each page.

Response parameters

Parameter Type Example Description
Categories Array of Category

The list of directories.

Category
CategoryType String FILE

The node type of the directory. Valid values:

  • FILE: file
  • FOLDER: folder
GmtCreate Long 1563848015000

The time when the directory was created.

GmtModified Long 1563848015000

The time when the directory was modified.

Id String FC-DF781BBF3F2E8317

The ID of the directory.

Name String Test

The name of the directory.

ObjectId String F-0B30759C146EA1E7

The ID of the entity. For example, jobs and workflows.

ObjectType String FLOW

The type of the associated entity. Valid values:

  • FLOW: workflow
  • JOB: job
ParentId String FC-DF781BBF3F2E****

The ID of the parent directory.

ProjectId String FP-179332E88F52****

The ID of the project.

Type String FLOW

The type of the directory. Valid values:

  • FLOW: workflow
  • JOB: job
PageNumber Integer 1

The number of the page returned.

PageSize Integer 10

The number of entries returned on each page.

RequestId String 5ECD6EA1-838E-4BDF-96C8-AEAA40F04F48

The ID of the request.

Total Integer 100

The total number of directories.

Examples

Sample requests

http(s)://[Endpoint]/?Action=ListFlowCategory
&ProjectId=FP-6E8E198E6C79****
&RegionId=cn-hangzhou
&<common request parameters>

Sample success responses

XML format

<PageSize>10</PageSize>
<RequestId>BCF52B64-007F-4883-BAEA-0499106D07C2</RequestId>
<PageNumber>1</PageNumber>
<Total>1</Total>
<Categories>
    <categoryType>FOLDER</categoryType>
    <gmtModified>1563848002000</gmtModified>
    <name>FLOW</name>
    <id>FC-D566F13A20A0****</id>
    <gmtCreate>1563848002000</gmtCreate>
    <type>FLOW</type>
    <projectId>FP-179332E88F52****</projectId>
    <parentId>root_parent</parentId>
</Categories>

JSON Syntax

{
    "PageSize": 10,
    "RequestId": "BCF52B64-007F-4883-BAEA-0499106D07C2",
    "PageNumber": 1,
    "Total": 1,
    "Categories": [
        {
            "categoryType": "FOLDER",
            "gmtModified": 1563848002000,
            "name": "FLOW",
            "id": "FC-D566F13A20A0****",
            "gmtCreate": 1563848002000,
            "type": "FLOW",
            "projectId": "FP-179332E88F52****",
            "parentId": "root_parent"
        }
    ]
}

Error code

The port number of a client that accesses a Error CenterFor more information, see error codes.