Retrieves a list of components.
Operation description
You must purchase DataWorks Basic Edition or a higher edition to use this feature.
Try it now
Test
RAM authorization
Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectId |
integer |
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 elements
|
Element |
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). |
|
|
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). |
||
| 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. |
|
|
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 |
integer |
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. |
|
|
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
Success response
JSON format
{
"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": "252675537980665607",
"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
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.