You can call this operation to query a directory tree.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeFlowCategoryTree

The operation that you want to perform. Set the value to DescribeFlowCategoryTree.

ProjectId String Yes FP-ABD24A6163D3****

The ID of the project.

RegionId String Yes cn-hangzhou

The ID of the region to which your project belongs.

Type String Yes FLOW

The type of the directory. Valid values:

  • FLOW
  • JOB
  • ADHOC

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":{}}]}

The directory tree consists of node key-value pairs and children key-value pairs.

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

<DescribeFlowCategoryTreeResponse>
	  <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></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></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></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></childrenMap>
			      </FC-296E3BB9491E39F2>
		    </childrenMap>
	  </data>
	  <requestId>B12F5D42-52C2-47F2-8A2F-4D0D68E64E44</requestId>
</DescribeFlowCategoryTreeResponse>

JSON format

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

Error codes

For a list of error codes, visit the API Error Center.