You can call this operation to view the detail of a category.

Request parameters

Name Type Required Example Description
Id String Yes FC-075AB9477DAE9AAC The ID of the category.
ProjectId String Yes FP-ABD24A6163D31274 The ID of the project.
RegionId String Yes cn-hangzhou The ID of the region.

Response parameters

Name Type Example Description
RequestId String BCEDC663-43F1-4202-9C49-9D3D66EA93D7 The ID of the request.
Id String FC-075AB9477DAE9AAC The ID of the category.
GmtCreate Long 1542783867503 The creation time.
GmtModified Long 1542783867503 The modification time.
Name String my_category The name of the category.
ParentId String FC-3A749C1F5D12BAAC The ID of the parent category.
Type String FLOW The type. Valid values: FLOW, JOB, and ADHOC.
CategoryType String FILE The type of the category. Valid values: FOLDER and FILE.
ObjectType String FLOW The type of the object. Valid values: FLOW, MR, SPARK, HIVE_SQL, HIVE, PIG, SQOOP, SPARK_SQL, SPARK_STREAMING, and SHELL.
ObjectId String String The ID of the object (workflow or job).
ProjectId String FP-E3F1523F8FC1D2E6 The ID of the project.

Examples

  • Sample requests
    
    /? Action=DescribeFlowCategory
    &Id=FC-075AB9477DAE9AAC
    &ProjectId=FP-ABD24A6163D31274
    &RegionId=region location id
    &<Common request parameters>
  • Successful response examples
    JSON format
    {
    	"code":"200",
    	"data":{
    		"CategoryType":"FILE",
    		"GmtCreate":1541858202000,
    		"GmtModified":1541858767000,
    		"Id":"FC-3A749C1F5D12BAAC",
    		"Name":"myFlow",
    		"ObjectId":"F-33FA7CD5E1957945",
    		"ObjectType":"FLOW",
    		"ParentId":"FC-198D4E3ACA4F75B3",
    		"ProjectId":"FP-E3F1523F8FC1D2E6",
    		"RequestId":"BBEB8FD9-3AA8-4D53-831C-037D9C53348E",
    		"Type":"FLOW"
    	},
    	"requestId":"BBEB8FD9-3AA8-4D53-831C-037D9C53348E",
    	"successResponse":true
    }
  • Error response examples
    JSON format
    {
    	"code":"FLOW_API_FAILED",
    	"message":"Project does not exist [FP-E3F1523F8FC1D2E]",
    	"requestId":"5C5E4A6F-5140-4627-AB81-F3E0D06C5C36",
    	"successResponse":false
    }

Error codes

View error codes.