You can call this operation to query workflow directories.

Debugging

Alibaba Cloud provides OpenAPI Explorer to simplify API usage. You can use OpenAPI Explorer to search for APIs, call APIs, and dynamically generate SDK example code.

Request parameters

Parameter Type Required Example Description
Action String Yes ListFlowCategory

The operation that you want to perform. Set this parameter to ListFlowCategory.

ProjectId String Yes FP-6E8E198E6C79****

The ID of the project.

RegionId String Yes cn-hangzhou

The ID of the region.

PageNumber Integer No 1

The number of the page to return.

PageSize Integer No 10

The number of entries to return on each page.

ParentId String No FC-6E8E198E6C79179C

The ID of the parent directory.

Root Boolean No false

Specifies whether to use the root directory.

Response parameters

Parameter Type Example Description
Categories

The list of directories.

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 associated entity, for example, job or workflow.

ObjectType String FLOW

The type of the associated entity. Valid values:

  • FLOW: workflow
  • JOB: job
ParentId String FC-DF781BBF3F2E8318

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 request


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

Sample success response

XML format

<ListFlowCategoryResponse>
  <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-D566F13A20A00D18</id>
		    <gmtCreate>1563848002000</gmtCreate>
		    <type>FLOW</type>
		    <projectId>FP-179332E88F52****</projectId>
		    <parentId>root_parent</parentId>
	  </Categories>
</ListFlowCategoryResponse>

JSON format

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

Error codes

For more information about error codes, see API Error Center.