You can call the DescribeFlowCategoryTree to query the information of a directory tree.

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 DescribeFlowCategoryTree

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 DescribeFlowCategoryTree.

ProjectId String Yes FP-ABD24A6163D3****

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

RegionId String Yes cn-hangzhou

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

Type String Yes FLOW

Directory type. The values are as follows:

  • FLOW (workflow)
  • JOB (JOB)
  • ADHOC: ad hoc query
Mode String No YARN

The mode of the model. The following values are supported:

  • YARN: submits the job from a worker node
  • LOCAL: submits the job from a header or gateway node
Keyword String No None

A reserved parameter.

CategoryId String No FC-5BD9575E3462****

The directory ID of the job.

Response parameters

Parameter Type Example Description
Data String {"node":{"categoryType":"FOLDER","gmtModified":1540344706000,"name":"FLOW","id":"FC-6B5B5BDAD3EFAB67","gmtCreate":1540344706000,"type":"FLOW","projectId":"FP-7A1018ADE9179EE1","parentId":"root_parent"},"children":[{"node":{"categoryType":"FILE","gmtModified":1542855766000,"name":"flow2","id":"FC-D30AC9A7795F03A1","gmtCreate":1542855766000,"type":"FLOW","projectId":"FP-7A1018ADE9179EE1","parentId":"FC-6B5B5BDAD3EFAB67","objectId":"F-E9DC5533695C989B","objectType":"FLOW"},"children":[],"childrenMap":{}},{"node":{"categoryType":"FILE","gmtModified":1540796206000,"name":"flow-hive","id":"FC-296E3BB9491E39F2","gmtCreate":1540796206000,"type":"FLOW","projectId":"FP-7A1018ADE9179EE1","parentId":"FC-6B5B5BDAD3EFAB67","objectId":"F-35683D0E45734E34","objectType":"FLOW"},"children":[],"childrenMap":{}}]}

Result, by node and children A tree structure.

RequestId String 5C5E4A6F-5140-4627-AB81-F3E0D06C5C36

The ID of the request.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeFlowCategoryTree
&ProjectId=FP-ABD24A6163D3****
&RegionId=cn-hangzhou
&Type=FLOW
&<common request parameters>

Sample success responses

XML format

<Data>
    <node>
        <categoryType>FOLDER</categoryType>
        <gmtModified>1540344706000</gmtModified>
        <name>FLOW</name>
        <id>FC-6B5B5BDAD3EF****</id>
        <gmtCreate>1540344706000</gmtCreate>
        <type>FLOW</type>
        <projectId>FP-7A1018ADE917****</projectId>
        <parentId>root_parent</parentId>
    </node>
    <children>
        <node>
            <categoryType>FILE</categoryType>
            <gmtModified>1542855766000</gmtModified>
            <name>flow2</name>
            <id>FC-D30AC9A7795F****</id>
            <gmtCreate>1542855766000</gmtCreate>
            <type>FLOW</type>
            <projectId>FP-7A1018ADE917****</projectId>
            <parentId>FC-6B5B5BDAD3EF****</parentId>
            <objectId>F-E9DC5533695C****</objectId>
            <objectType>FLOW</objectType>
        </node>
        <childrenMap/>
    </children>
    <children>
        <node>
            <categoryType>FILE</categoryType>
            <gmtModified>1540796206000</gmtModified>
            <name>flow-hive</name>
            <id>FC-296E3BB9491E****</id>
            <gmtCreate>1540796206000</gmtCreate>
            <type>FLOW</type>
            <projectId>FP-7A1018ADE917****</projectId>
            <parentId>FC-6B5B5BDAD3EF****</parentId>
            <objectId>F-35683D0E4573****</objectId>
            <objectType>FLOW</objectType>
        </node>
        <childrenMap/>
    </children>
    <childrenMap>
        <FC-D30AC9A7795F03A1>
            <node>
                <categoryType>FILE</categoryType>
                <gmtModified>1542855766000</gmtModified>
                <name>flow2</name>
                <id>FC-D30AC9A7795F****</id>
                <gmtCreate>1542855766000</gmtCreate>
                <type>FLOW</type>
                <projectId>FP-7A1018ADE917****</projectId>
                <parentId>FC-6B5B5BDAD3EF****</parentId>
                <objectId>F-E9DC5533695C****</objectId>
                <objectType>FLOW</objectType>
            </node>
            <childrenMap/>
        </FC-D30AC9A7795F03A1>
        <FC-296E3BB9491E39F2>
            <node>
                <categoryType>FILE</categoryType>
                <gmtModified>1540796206000</gmtModified>
                <name>flow-hive</name>
                <id>FC-296E3BB9491E****</id>
                <gmtCreate>1540796206000</gmtCreate>
                <type>FLOW</type>
                <projectId>FP-7A1018ADE917****</projectId>
                <parentId>FC-6B5B5BDAD3EF****</parentId>
                <objectId>F-35683D0E4573****</objectId>
                <objectType>FLOW</objectType>
            </node>
            <childrenMap/>
        </FC-296E3BB9491E39F2>
    </childrenMap>
</Data>
<RequestId>B12F5D42-52C2-47F2-8A2F-4D0D68E64E44</RequestId>

JSON Syntax

{
    "Data": {
        "node": {
            "categoryType": "FOLDER",
            "gmtModified": 1540344706000,
            "name": "FLOW",
            "id": "FC-6B5B5BDAD3EF****",
            "gmtCreate": 1540344706000,
            "type": "FLOW",
            "projectId": "FP-7A1018ADE917****",
            "parentId": "root_parent"
        },
        "children": [
            {
                "node": {
                    "categoryType": "FILE",
                    "gmtModified": 1542855766000,
                    "name": "flow2",
                    "id": "FC-D30AC9A7795F****",
                    "gmtCreate": 1542855766000,
                    "type": "FLOW",
                    "projectId": "FP-7A1018ADE917****",
                    "parentId": "FC-6B5B5BDAD3EF****",
                    "objectId": "F-E9DC5533695C****",
                    "objectType": "FLOW"
                },
                "children": [],
                "childrenMap": {}
            },
            {
                "node": {
                    "categoryType": "FILE",
                    "gmtModified": 1540796206000,
                    "name": "flow-hive",
                    "id": "FC-296E3BB9491E****",
                    "gmtCreate": 1540796206000,
                    "type": "FLOW",
                    "projectId": "FP-7A1018ADE917****",
                    "parentId": "FC-6B5B5BDAD3EF****",
                    "objectId": "F-35683D0E4573****",
                    "objectType": "FLOW"
                },
                "children": [],
                "childrenMap": {}
            }
        ],
        "childrenMap": {
            "FC-D30AC9A7795F03A1": {
                "node": {
                    "categoryType": "FILE",
                    "gmtModified": 1542855766000,
                    "name": "flow2",
                    "id": "FC-D30AC9A7795F****",
                    "gmtCreate": 1542855766000,
                    "type": "FLOW",
                    "projectId": "FP-7A1018ADE917****",
                    "parentId": "FC-6B5B5BDAD3EF****",
                    "objectId": "F-E9DC5533695C****",
                    "objectType": "FLOW"
                },
                "children": [],
                "childrenMap": {}
            },
            "FC-296E3BB9491E39F2": {
                "node": {
                    "categoryType": "FILE",
                    "gmtModified": 1540796206000,
                    "name": "flow-hive",
                    "id": "FC-296E3BB9491E****",
                    "gmtCreate": 1540796206000,
                    "type": "FLOW",
                    "projectId": "FP-7A1018ADE917****",
                    "parentId": "FC-6B5B5BDAD3EF****",
                    "objectId": "F-35683D0E4573****",
                    "objectType": "FLOW"
                },
                "children": [],
                "childrenMap": {}
            }
        }
    },
    "RequestId": "B12F5D42-52C2-47F2-8A2F-4D0D68E64E44"
}

Error codes

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