ListComponents - DataWorks - Alibaba Cloud Documentation Center

Retrieves a list of components.

Operation description

This API operation is available for all DataWorks editions.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
dataworks:ListComponents	list	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	long	No	The ID of the workspace associated with the data source. You can call the ListProjects operation to obtain the workspace ID.	100001
Name	string	No	The name of the data source.	xm_create_test
PageNumber	integer	No	The page number for pagination.	1
PageSize	integer	No	The number of entries per page. Default value: 10. Maximum value: 100.	1000

Response parameters

Parameter	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Use this ID for troubleshooting.	952795279527ab****
PagingInfo	object	The pagination information.
TotalCount	integer	The total number of entries.	100
PageNumber	integer	The page number.	1
PageSize	integer	The number of entries per page.	10
Components	array<object>	The UID of the user who created the dataset acceleration component. In Alibaba Cloud, this is the RAM user ID (or the Alibaba Cloud account ID if created by the account itself).
component	object	The UID of the user who created the dataset acceleration component. In Alibaba Cloud, this is the RAM user ID (or the Alibaba Cloud account ID if created by the account itself).
ModifyTime	string	The timestamp when the publishing process was modified.	2023-11-30T13:30:58Z
Script	object	The script information.
Path	string	The script path.	/
Runtime	object	The runtime.
Command	string	The command.	SQL_COMPONENT
Id	string	ID	348100
Owner	string	The owner.	252675537980665607
Description	string	The description.	vpc peering management_staging
CreateTime	string	The creation time.	2023-03-13 16:35:59
Outputs	array<object>	The output parameters.
Parameter	object	The node output.
DefaultValue	string	The default value.	32000
Type	string	The parameter type.	string
Description	string	The parameter description.	zdy
Name	string	The parameter name.	auto_updateAlertRule_test_bULIRo
ProjectId	long	The DataWorks workspace ID. To obtain the workspace ID, log on to the DataWorks console and navigate to the workspace configuration page. You must specify either this parameter or ProjectIdentifier to identify the target DataWorks workspace for this API call.	199925
ComponentId	string	The component ID. This parameter can be used in requests to query, modify, or delete director components.	12312313123
Inputs	array<object>	The input parameters.
Parameter	object	The variable element.
DefaultValue	string	The default value of the variable.	mdb.shard.2x.2xlarge.d
Type	string	The parameter type.	string
Description	string	The parameter description.	None
Name	string	The parameter name.	auto_updateAlertRule_test_bULIRo
Name	string	The resource name.	auto_updateAlertRule_test_lJd81f

Examples

Sample success responses

JSONformat

{
  "RequestId": "952795279527ab****",
  "PagingInfo": {
    "TotalCount": 100,
    "PageNumber": 1,
    "PageSize": 10,
    "Components": [
      {
        "ModifyTime": "2023-11-30T13:30:58Z",
        "Script": {
          "Path": "/",
          "Runtime": {
            "Command": "SQL_COMPONENT"
          },
          "Id": 348100
        },
        "Owner": 252675537980665600,
        "Description": "vpc peering management_staging",
        "CreateTime": "2023-03-13 16:35:59",
        "Outputs": [
          {
            "DefaultValue": 32000,
            "Type": "string",
            "Description": "zdy",
            "Name": "auto_updateAlertRule_test_bULIRo"
          }
        ],
        "ProjectId": 199925,
        "ComponentId": 12312313123,
        "Inputs": [
          {
            "DefaultValue": "mdb.shard.2x.2xlarge.d",
            "Type": "string",
            "Description": "None",
            "Name": "auto_updateAlertRule_test_bULIRo"
          }
        ],
        "Name": "auto_updateAlertRule_test_lJd81f"
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.