GetComponent API リファレンス - DataWorks

コンポーネント情報を取得します。

操作説明

DataWorks 基礎版以上のバージョンをご購入いただく必要があります。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

この操作の認証情報はありません。問題が発生した場合は、アカウントマネージャーにご連絡ください。

リクエストパラメーター

パラメーター	型	必須 / 任意	説明	例
ProjectId	integer	任意	DataWorks ワークスペース ID です。DataWorks コンソールにログインし、ワークスペースページで ID を確認できます。このパラメーターまたは ProjectIdentifier パラメーターのいずれかを設定して、操作対象の DataWorks ワークスペースを指定する必要があります。	10000
ComponentId	string	必須	コンポーネント ID です。	1112312312312

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ
RequestId	string	リクエスト ID	0000-ABCD-EFG****
Component	object	コンポーネントモジュールの JSON シリアル化形式。
ComponentId	string	データセット高速化コンポーネントの ID です。コンポーネント ID の取得方法については、「ListComponents」をご参照ください。	43cd873b-235c-44f8-be07-e4d4cf7e73b0
ProjectId	integer	DataWorks ワークスペース ID です。	64623
Name	string	パラメーター	dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id
Owner	string	タスクオーナーの ID です。	207316543660665792
CreateTime	string	作成時刻です。	2017-04-27T05:37:05Z
ModifyTime	string	更新時刻（ミリ秒単位のタイムスタンプ）です。	2024-01-26T07:44:21Z
Spec	string	このワークフローの FlowSpec 情報です。詳細については、「FlowSpec」をご参照ください。	{ "kind": "Component", "name": "com1", "spec": { "components": [ { "name": "test11", "id": "8196828925037*****", "owner": "054664", "description": "", "script": { "language": "odps-sql", "path": "test11", "content": "select '@@{bizdate}', '@@{my_input_table}'", "runtime": { "command": "SQL_COMPONENT" } }, "inputs": [ { "name": "bizdate", "type": "string" }, { "name": "my_input_table", "type": "string" } ], "outputs": [ { "name": "my_output_table1", "type": "string" } ] } ] } }
Description	string	説明です。	None
RegionId	string	リージョン ID（例：ap-southeast-1）です。リージョン ID はご利用のエンドポイントから自動的に解析されます。	cn-hangzhou

例

成功レスポンス

JSONJSON

{
  "RequestId": "0000-ABCD-EFG****",
  "Component": {
    "ComponentId": "43cd873b-235c-44f8-be07-e4d4cf7e73b0",
    "ProjectId": 64623,
    "Name": "dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id",
    "Owner": "207316543660665792",
    "CreateTime": "2017-04-27T05:37:05Z",
    "ModifyTime": "2024-01-26T07:44:21Z",
    "Spec": "{\n    \"kind\": \"Component\",\n    \"name\": \"com1\",\n    \"spec\": {\n        \"components\": [\n            {\n                \"name\": \"test11\",\n                \"id\": \"8196828925037*****\",\n                \"owner\": \"054664\",\n                \"description\": \"\",\n                \"script\": {\n                    \"language\": \"odps-sql\",\n                    \"path\": \"test11\",\n                    \"content\": \"select '@@{bizdate}', '@@{my_input_table}'\",\n                    \"runtime\": {\n                        \"command\": \"SQL_COMPONENT\"\n                    }\n                },\n                \"inputs\": [\n                    {\n                        \"name\": \"bizdate\",\n                        \"type\": \"string\"\n                    },\n                    {\n                        \"name\": \"my_input_table\",\n                        \"type\": \"string\"\n                    }\n                ],\n                \"outputs\": [\n                    {\n                        \"name\": \"my_output_table1\",\n                        \"type\": \"string\"\n                    }\n                ]\n            }\n        ]\n    }\n}",
    "Description": "None",
    "RegionId": "cn-hangzhou"
  }
}

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
404	InvalidComponent.NotFound	The specified Component does not exist.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。