You can call this operation to query the information of a directory.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeFlowCategory |
The operation that you want to perform. Set the value to DescribeFlowCategory. |
Id | String | Yes | FC-075AB9477DAE**** |
The ID of the directory. |
ProjectId | String | Yes | FP-ABD24A6163D3**** |
The ID of the project. |
RegionId | String | Yes | The ID of the region |
The ID of the region to which your project belongs. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
CategoryType | String | FILE |
The type of the object to which the directory references. Valid values:
|
GmtCreate | Long | 1542783867503 |
The creation time of the directory. |
GmtModified | Long | 1542783867503 |
The modification time of the directory. |
Id | String | FC-075AB9477DAE**** |
The ID of the directory. |
Name | String | my_category |
The name of the directory. |
ObjectId | String | F-EB3021F73E51**** |
The ID of the file, such as the ID of a workflow or a job. This parameter is valid only when the value of CategoryType is FILE. |
ObjectType | String | FLOW |
The type of the file. This parameter is valid only when the value of CategoryType is FILE. Valid values: FLOW, MR, SPARK, HIVE_SQL, HIVE, PIG, SQOOP, SPARK_SQL, SPARK_STREAMING, and SHELL. |
ParentId | String | FC-3A749C1F5D12**** |
The ID of the parent directory. |
ProjectId | String | FP-E3F1523F8FC1**** |
The ID of the project. |
RequestId | String | BCEDC663-43F1-4202-9C49-9D3D66EA93D7 |
The ID of the request. |
Type | String | FLOW |
The type of the directory. Valid values:
|
Examples
Sample requests
http(s)://[Endpoint]/? Action=DescribeFlowCategory
&Id=FC-075AB9477DAE****
&ProjectId=FP-ABD24A6163D3****
&RegionId=The ID of the region
&<Common request parameters>
Sample success responses
XML
format
<DescribeFlowCategoryResponse>
<data>
<ParentId>FC-198D4E3ACA4F****</ParentId>
<ObjectType>FLOW</ObjectType>
<Type>FLOW</Type>
<GmtCreate>1541858202000</GmtCreate>
<RequestId>BBEB8FD9-3AA8-4D53-831C-037D9C53348E</RequestId>
<ObjectId>F-33FA7CD5E195****</ObjectId>
<ProjectId>FP-E3F1523F8FC1****</ProjectId>
<GmtModified>1541858767000</GmtModified>
<CategoryType>FILE</CategoryType>
<Id>FC-3A749C1F5D12****</Id>
<Name>myFlow</Name>
</data>
<requestId>BBEB8FD9-3AA8-4D53-831C-037D9C53348E</requestId>
</DescribeFlowCategoryResponse>
JSON
format
{
"requestId":"BBEB8FD9-3AA8-4D53-831C-037D9C53348E",
"data":{
"Name":"myFlow",
"CategoryType":"FILE",
"ParentId":"FC-198D4E3ACA4F****",
"ObjectType":"FLOW",
"Type":"FLOW",
"RequestId":"BBEB8FD9-3AA8-4D53-831C-037D9C53348E",
"Id":"FC-3A749C1F5D12****",
"GmtCreate":1541858202000,
"GmtModified":1541858767000,
"ProjectId":"FP-E3F1523F8FC1****",
"ObjectId":"F-33FA7CD5E195****"
}
}
Error codes
For a list of error codes, visit the API Error Center.