ディレクトリ情報をクエリする操作です。

デバッグ

OpenAPI Explorer は署名値を自動的に計算します。 OpenAPI Explorer を使用すると、API を簡単に設定できます。 OpenAPI Explorer は、各種 SDK のサンプルコードを動的に生成します。

リクエストパラメーター

パラメーター データ型 必須／任意 例 説明
Action String 必須 DescribeFlowCategory

実行したい操作。 値を DescribeFlowCategory に設定します。
Id String 必須 FC-075AB9477DAE ****

ディレクトリの ID。
ProjectId String 必須 FP-ABD24A6163D3 ****

プロジェクトの ID。
RegionId String 必須 リージョンの ID

プロジェクトが属するリージョンの ID。

レスポンスパラメーター

パラメーター データ型 例 説明
CategoryType String FILE

ディレクトリが参照するオブジェクトのタイプ。 有効値：

  • FOLDER: フォルダ
  • FILE: ファイル
GmtCreate Long 1542783867503

ディレクトリの作成時間。
GmtModified Long 1542783867503

ディレクトリの変更時間。
Id String FC-075AB9477DAE ****

ディレクトリの ID。
Name String my_category

ディレクトリの名前。
ObjectId String F-EB3021F73E51****

ワークフローやジョブの ID などの、ファイルの ID。 このパラメーターは、CategoryType の値が FILE の場合にのみ有効です。
ObjectType String FLOW

ファイルタイプ。 このパラメーターは、CategoryType の値が FILE の場合にのみ有効です。 有効値：FLOW、MR、SPARK、HIVE_SQL、HIVE、PIG、SQOOP、SPARK_SQL、SPARK_STREAMING、SHELL。
ParentId String FC-3A749C1F5D12****

親ディレクトリの ID。
ProjectId String FP-E3F1523F8FC1****

プロジェクトの ID。
RequestId String BCEDC663-43F1-4202-9C49-9D3D66EA93D7

リクエストの ID。
Type String FLOW

ディレクトリのタイプ。 有効値：

  • FLOW
  • JOB
  • ADHOC

例

リクエスト例


http(s)://[Endpoint]/? Action=DescribeFlowCategory
&Id=FC-075AB9477DAE****
&ProjectId=FP-ABD24A6163D3****
&RegionId=The ID of the region
&<Common request parameters>

通常のレスポンス例

XML 形式 

<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 形式 

{
	"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****"
	}
}

エラーコード

エラーコードについては、「API エラーセンター」をご参照ください。