调用DescribeFlowCategoryTree接口,获取目录树。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeFlowCategoryTree

系统规定参数。取值:DescribeFlowCategoryTree

ProjectId String FP-ABD24A6163D3****

项目ID。

RegionId String cn-hangzhou

地域ID。

Type String FLOW

目录类型,取值如下:

  • FLOW(工作流)
  • JOB(作业)
  • ADHOC(临时查询)
Mode String FULL

模型模式,支持如下取值:

  • FULL:默认模式,可以不填, 获取完整的目录树。
  • STEP:获取下一级目录列表, 需要设置父目录id。
  • LOCATION:定位模式, 获取给定目录的最小展开树。
  • SEARCH:搜索模式, 过滤包含关键字的目录项目。
Keyword String SQL

检索关键字

CategoryId String FC-5BD9575E3462****
  • STEP模式下:上级目录id, 获取根目录id时不设置
  • LOCATION模式下:需要定位的目录id

返回数据

名称 类型 示例值 描述
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":{}}]}

结果, 由node和children构成的树状结构。

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

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeFlowCategoryTree
&ProjectId=FP-ABD24A6163D3****
&RegionId=cn-hangzhou
&Type=FLOW
&Mode=FULL
&Keyword=SQL
&CategoryId=FC-5BD9575E3462****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeFlowCategoryTreeResponse>
    <Data>{"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":{}}]}</Data>
    <RequestId>5C5E4A6F-5140-4627-AB81-F3E0D06C5C36</RequestId>
</DescribeFlowCategoryTreeResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "Data" : "{\"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\":{}}]}",
  "RequestId" : "5C5E4A6F-5140-4627-AB81-F3E0D06C5C36"
}

错误码

访问错误中心查看更多错误码。

访问错误中心查看更多错误码。