GetComponent API Reference - DataWorks - Alibaba Cloud - DataWorks

Gets component information.

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this feature.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	No	The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.	10000
ComponentId	string	Yes	The component ID.	1112312312312

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	Id of the request	0000-ABCD-EFG****
Component	object	JSON serialization of the component module.
ComponentId	string	The ID of the dataset acceleration component. For information on how to obtain the component ID, see ListComponents.	43cd873b-235c-44f8-be07-e4d4cf7e73b0
ProjectId	integer	The DataWorks workspace ID.	64623
Name	string	Parameter	dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id
Owner	string	The ID of the task owner.	207316543660665792
CreateTime	string	The creation time.	2017-04-27T05:37:05Z
ModifyTime	string	The modification time (millisecond-level timestamp).	2024-01-26T07:44:21Z
Spec	string	The FlowSpec information for this workflow. For more information, see 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	The description.	None
RegionId	string	The region ID, such as ap-southeast-1. The region ID is automatically parsed from your endpoint.	cn-hangzhou

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
404	InvalidComponent.NotFound	The specified Component does not exist.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.