Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow in the Scheduled Workflow pane, and then click the workflow name. Right-click the MaxCompute folder and select Import Table.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | EstablishRelationTableToBusiness |
The operation that you want to perform. |
BusinessId | String | Yes | 1000001 |
The ID of the workflow. You can call the ListBusiness operation to query the ID. |
FolderId | String | Yes | 2eb6f9**** |
The ID of the folder. You can call the GetFolder or ListFolders operation to query the ID. |
RegionId | String | Yes | cn-zhangjiakou |
The region ID. |
TableGuid | String | Yes | odps.dw_project.tb1 |
The universally unique identifier (UUID) of the table. You can call the SearchMetaTables operation to query the UUID. |
ProjectId | Long | No | 10000 |
The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID. |
ProjectIdentifier | String | No | dw |
The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
ErrorCode | String | Invalid.Tenant.ConnectionNotExists |
The error code returned. |
ErrorMessage | String | The connection does not exist. |
The error message returned. |
HttpStatusCode | Integer | 200 |
The HTTP status code returned. |
RequestId | String | 0000-ABCD-EFG |
The ID of the request. You can troubleshoot issues based on the ID. |
Success | Boolean | true |
Indicates whether the request is successful. |
Examples
Sample requests
http(s)://[Endpoint]/?Action=EstablishRelationTableToBusiness
&BusinessId=1000001
&FolderId=2eb6f9****
&ProjectId=10000
&RegionId=cn-zhangjiakou
&TableGuid=odps.dw_project.tb1
&<Common request parameters>
Sample success responses
XML
format
<RequestId>0000-ABCD-EFG</RequestId>
<HttpStatusCode>200</HttpStatusCode>
<ErrorCode>Invalid.Tenant.ConnectionNotExists</ErrorCode>
<ErrorMessage>The connection does not exist.</ErrorMessage>
<Success>true</Success>
JSON
format
{
"RequestId": "0000-ABCD-EFG",
"HttpStatusCode": 200,
"ErrorCode": "Invalid.Tenant.ConnectionNotExists",
"ErrorMessage": "The connection does not exist.",
"Success": true
}
Error codes
HTTP status code | Error code | Error message | Description |
---|---|---|---|
500 | InternalError.System | An internal system error occurred. Try again later. | The error message returned because an internal error has occurred. Try again later. |
500 | InternalError.UserId.Missing | An internal system error occurred. Try again later. | The error message returned because an internal error has occurred. Try again later. |
429 | Throttling.Api | The request for this resource has exceeded your available limit. | The error message returned because the number of requests for the resource has exceeded the upper limit. |
429 | Throttling.System | The DataWorks system is busy. Try again later. | The error message returned because the DataWorks system is busy. Try again later. |
429 | Throttling.User | Your request is too frequent. Try again later. | The error message returned because excessive requests have been submitted within a short period of time. Try again later. |
403 | Forbidden.Access | Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition. | The error message returned because you are not allowed to perform this operation. Activate DataWorks Enterprise Edition or DataWorks Ultimate Edition. |
For a list of error codes, visit the API Error Center.