Update API GetCreateWorkflowInstancesResult: add response parameters Body.Result.WorkflowTaskInstanceIds.

Author: sdk-team

dataworks-public-20240518/ChangeLog.md

@@ -1,3 +1,11 @@
+2025-10-29 Version: 4.4.1
+- Update API GetCreateWorkflowInstancesResult: add response parameters Body.Result.WorkflowTaskInstanceIds.
+- Update API GetWorkflowInstance: add response parameters Body.WorkflowInstance.Owner.
+- Update API GetWorkflowInstance: add response parameters Body.WorkflowInstance.WorkflowTaskInstanceId.
+- Update API ListWorkflowInstances: add response parameters Body.PagingInfo.WorkflowInstances.$.Owner.
+- Update API ListWorkflowInstances: add response parameters Body.PagingInfo.WorkflowInstances.$.WorkflowTaskInstanceId.
+
+
 2025-10-09 Version: 4.4.0
 - Support API CreateComponent.
 - Support API DeleteComponent.

dataworks-public-20240518/core/Client.cs

@@ -10,7 +10,7 @@ namespace AlibabaCloud.SDK.Dataworks_public20240518.Models
 {
     public class AddEntityIntoMetaCollectionRequest : TeaModel {
         /// <summary>
-        /// <para>The entity ID. Currently, entities can only be tables. You can call the ListTables operation to query the ID.</para>
+        /// <para>The entity ID. Currently, only table entities are supported. You can call the ListTables operation to obtain the ID.</para>
         /// <para>This parameter is required.</para>
         /// 
         /// <b>Example:</b>
@@ -21,7 +21,7 @@ public class AddEntityIntoMetaCollectionRequest : TeaModel {
         public string Id { get; set; }
 
         /// <summary>
-        /// <para>The collection ID. You can call the ListMetaCollections operation to query the ID.</para>
+        /// <para>The collection ID. You can refer to the return result of the ListMetaCollections operation.</para>
         /// <para>This parameter is required.</para>
         /// 
         /// <b>Example:</b>
@@ -31,6 +31,12 @@ public class AddEntityIntoMetaCollectionRequest : TeaModel {
         [Validation(Required=false)]
         public string MetaCollectionId { get; set; }
 
+        /// <summary>
+        /// <para>Remarks added when adding the entity to a collection. This parameter is currently valid only for album collections.</para>
+        /// 
+        /// <b>Example:</b>
+        /// <para>test</para>
+        /// </summary>
         [NameInMap("Remark")]
         [Validation(Required=false)]
         public string Remark { get; set; }

dataworks-public-20240518/core/Models/AddEntityIntoMetaCollectionRequest.cs

@@ -10,7 +10,7 @@ namespace AlibabaCloud.SDK.Dataworks_public20240518.Models
 {
     public class AddEntityIntoMetaCollectionResponseBody : TeaModel {
         /// <summary>
-        /// <para>Id of the request</para>
+        /// <para>The request ID.</para>
         /// 
         /// <b>Example:</b>
         /// <para>C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490</para>

dataworks-public-20240518/core/Models/AddEntityIntoMetaCollectionResponseBody.cs

@@ -20,21 +20,21 @@ public class BatchUpdateTasksRequest : TeaModel {
         public string Comment { get; set; }
 
         /// <summary>
-        /// <para>The tasks.</para>
+        /// <para>The list of tasks.</para>
         /// </summary>
         [NameInMap("Tasks")]
         [Validation(Required=false)]
         public List<BatchUpdateTasksRequestTasks> Tasks { get; set; }
         public class BatchUpdateTasksRequestTasks : TeaModel {
             /// <summary>
-            /// <para>The information about the associated data source.</para>
+            /// <para>Associated data source information.</para>
             /// </summary>
             [NameInMap("DataSource")]
             [Validation(Required=false)]
             public BatchUpdateTasksRequestTasksDataSource DataSource { get; set; }
             public class BatchUpdateTasksRequestTasksDataSource : TeaModel {
                 /// <summary>
-                /// <para>The name of the data source.</para>
+                /// <para>The data source name.</para>
                 /// 
                 /// <b>Example:</b>
                 /// <para>odps_test</para>
@@ -56,10 +56,10 @@ public class BatchUpdateTasksRequestTasksDataSource : TeaModel {
             public string Description { get; set; }
 
             /// <summary>
-            /// <para>The environment of the workspace. Valid values:</para>
+            /// <para>The project environment.</para>
             /// <list type="bullet">
-            /// <item><description>Prod: production environment</description></item>
-            /// <item><description>Dev: development environment</description></item>
+            /// <item><description>Prod: Production</description></item>
+            /// <item><description>Dev: Development</description></item>
             /// </list>
             /// 
             /// <b>Example:</b>
@@ -101,7 +101,7 @@ public class BatchUpdateTasksRequestTasksDataSource : TeaModel {
             public string Owner { get; set; }
 
             /// <summary>
-            /// <para>The rerun interval. Unit: seconds.</para>
+            /// <para>The retry interval in seconds.</para>
             /// 
             /// <b>Example:</b>
             /// <para>60</para>
@@ -113,9 +113,9 @@ public class BatchUpdateTasksRequestTasksDataSource : TeaModel {
             /// <summary>
             /// <para>The rerun mode. Valid values:</para>
             /// <list type="bullet">
-            /// <item><description>AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.</description></item>
-            /// <item><description>FailureAllowed: The task can be rerun only after it fails to run.</description></item>
-            /// <item><description>AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.</description></item>
+            /// <item><description>AllDenied: The task cannot be rerun.</description></item>
+            /// <item><description>FailureAllowed: The task can be rerun only after it fails.</description></item>
+            /// <item><description>AllAllowed: The task can always be rerun.</description></item>
             /// </list>
             /// 
             /// <b>Example:</b>
@@ -126,7 +126,7 @@ public class BatchUpdateTasksRequestTasksDataSource : TeaModel {
             public string RerunMode { get; set; }
 
             /// <summary>
-            /// <para>The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.</para>
+            /// <para>The number of retry attempts. Takes effect when the task is configured to allow reruns.</para>
             /// 
             /// <b>Example:</b>
             /// <para>3</para>
@@ -136,7 +136,7 @@ public class BatchUpdateTasksRequestTasksDataSource : TeaModel {
             public int? RerunTimes { get; set; }
 
             /// <summary>
-            /// <para>The configurations of the runtime environment, such as the resource group information.</para>
+            /// <para>Runtime environment configurations, such as resource group information.</para>
             /// </summary>
             [NameInMap("RuntimeResource")]
             [Validation(Required=false)]
@@ -153,7 +153,7 @@ public class BatchUpdateTasksRequestTasksRuntimeResource : TeaModel {
                 public string Cu { get; set; }
 
                 /// <summary>
-                /// <para>The ID of the image configured for task running.</para>
+                /// <para>The image ID used in the task runtime configuration.</para>
                 /// 
                 /// <b>Example:</b>
                 /// <para>i-xxxxxx</para>
@@ -163,7 +163,7 @@ public class BatchUpdateTasksRequestTasksRuntimeResource : TeaModel {
                 public string Image { get; set; }
 
                 /// <summary>
-                /// <para>The ID of the resource group for scheduling configured for task running.</para>
+                /// <para>The identifier of the scheduling resource group used in the task runtime configuration.</para>
                 /// 
                 /// <b>Example:</b>
                 /// <para>S_res_group_524258031846018_1684XXXXXXXXX</para>
@@ -175,7 +175,7 @@ public class BatchUpdateTasksRequestTasksRuntimeResource : TeaModel {
             }
 
             /// <summary>
-            /// <para>The tags.</para>
+            /// <para>The list of task tags.</para>
             /// </summary>
             [NameInMap("Tags")]
             [Validation(Required=false)]
@@ -205,7 +205,7 @@ public class BatchUpdateTasksRequestTasksTags : TeaModel {
             }
 
             /// <summary>
-            /// <para>The timeout period of task running. Unit: seconds.</para>
+            /// <para>The task execution timeout in seconds. The value should be greater than 3600.</para>
             /// 
             /// <b>Example:</b>
             /// <para>3600</para>
@@ -215,14 +215,14 @@ public class BatchUpdateTasksRequestTasksTags : TeaModel {
             public int? Timeout { get; set; }
 
             /// <summary>
-            /// <para>The trigger method.</para>
+            /// <para>The task trigger configurations.</para>
             /// </summary>
             [NameInMap("Trigger")]
             [Validation(Required=false)]
             public BatchUpdateTasksRequestTasksTrigger Trigger { get; set; }
             public class BatchUpdateTasksRequestTasksTrigger : TeaModel {
                 /// <summary>
-                /// <para>The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.</para>
+                /// <para>The cron expression. Takes effect when type=Scheduler.</para>
                 /// 
                 /// <b>Example:</b>
                 /// <para>00 00 00 * * ?</para>
@@ -232,7 +232,7 @@ public class BatchUpdateTasksRequestTasksTrigger : TeaModel {
                 public string Cron { get; set; }
 
                 /// <summary>
-                /// <para>The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the <c>yyyy-mm-dd hh:mm:ss</c>.</para>
+                /// <para>The expiration time of periodic triggering. Takes effect only when type is set to Scheduler. The value of this parameter is in the<c>yyyy-mm-dd hh:mm:ss</c> format.</para>
                 /// 
                 /// <b>Example:</b>
                 /// <para>9999-01-01 00:00:00</para>
@@ -257,7 +257,7 @@ public class BatchUpdateTasksRequestTasksTrigger : TeaModel {
                 public string Recurrence { get; set; }
 
                 /// <summary>
-                /// <para>The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the <c>yyyy-mm-dd hh:mm:ss</c>.</para>
+                /// <para>The time when periodic triggering takes effect. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the <c>yyyy-mm-dd hh:mm:ss</c> format.</para>
                 /// 
                 /// <b>Example:</b>
                 /// <para>1970-01-01 00:00:00</para>
@@ -269,8 +269,8 @@ public class BatchUpdateTasksRequestTasksTrigger : TeaModel {
                 /// <summary>
                 /// <para>The trigger type. Valid values:</para>
                 /// <list type="bullet">
-                /// <item><description>Scheduler: scheduling cycle-based trigger</description></item>
-                /// <item><description>Manual: manual trigger</description></item>
+                /// <item><description>Scheduler: periodically triggered</description></item>
+                /// <item><description>Manual</description></item>
                 /// </list>
                 /// 
                 /// <b>Example:</b>

dataworks-public-20240518/core/Models/BatchUpdateTasksRequest.cs

@@ -20,7 +20,7 @@ public class BatchUpdateTasksShrinkRequest : TeaModel {
         public string Comment { get; set; }
 
         /// <summary>
-        /// <para>The tasks.</para>
+        /// <para>The list of tasks.</para>
         /// </summary>
         [NameInMap("Tasks")]
         [Validation(Required=false)]

dataworks-public-20240518/core/Models/BatchUpdateTasksShrinkRequest.cs

@@ -10,6 +10,7 @@ namespace AlibabaCloud.SDK.Dataworks_public20240518.Models
 {
     public class CreateBusinessRequest : TeaModel {
         /// <summary>
+        /// <para>The name of the workflow. Workflow names must be unique within the same workspace.</para>
         /// <para>This parameter is required.</para>
         /// 
         /// <b>Example:</b>
@@ -19,11 +20,19 @@ public class CreateBusinessRequest : TeaModel {
         [Validation(Required=false)]
         public string BusinessName { get; set; }
 
+        /// <summary>
+        /// <para>The description of the workflow.</para>
+        /// 
+        /// <b>Example:</b>
+        /// <para>test</para>
+        /// </summary>
         [NameInMap("Description")]
         [Validation(Required=false)]
         public string Description { get; set; }
 
         /// <summary>
+        /// <para>The Alibaba Cloud account ID of the person responsible for the workflow. You can view the account ID by hovering over the user avatar in the top-right corner of the <a href="https://workbench.data.aliyun.com/console">DataWorks console</a>. If this parameter is not specified, the account ID of the API caller is used by default.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>1000000000001</para>
         /// </summary>
@@ -32,6 +41,8 @@ public class CreateBusinessRequest : TeaModel {
         public string Owner { get; set; }
 
         /// <summary>
+        /// <para>The ID of the DataWorks workspace. You can view the workspace ID on the workspace management page in the <a href="https://workbench.data.aliyun.com/console">DataWorks console</a>.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>10000</para>
         /// </summary>
@@ -40,6 +51,8 @@ public class CreateBusinessRequest : TeaModel {
         public long? ProjectId { get; set; }
 
         /// <summary>
+        /// <para>The unique identifier of the DataWorks workspace, This is the identifier shown in the workspace switch at the top of the Data Studio page. Either this parameter or ProjectId must be specified to determine which DataWorks project this API call operates on.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>dw_project</para>
         /// </summary>
@@ -48,6 +61,12 @@ public class CreateBusinessRequest : TeaModel {
         public string ProjectIdentifier { get; set; }
 
         /// <summary>
+        /// <para>The module to which the workflow belongs. Valid values:</para>
+        /// <list type="bullet">
+        /// <item><description>NORMAL: Data Studio</description></item>
+        /// <item><description>MANUAL_BIZ: Manually triggered workflow</description></item>
+        /// </list>
+        /// 
         /// <b>Example:</b>
         /// <para>NORMAL</para>
         /// </summary>

dataworks-public-20240518/core/Models/CreateBusinessRequest.cs

@@ -10,6 +10,8 @@ namespace AlibabaCloud.SDK.Dataworks_public20240518.Models
 {
     public class CreateBusinessResponseBody : TeaModel {
         /// <summary>
+        /// <para>The workflow ID.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>100001</para>
         /// </summary>
@@ -18,6 +20,13 @@ public class CreateBusinessResponseBody : TeaModel {
         public long? BusinessId { get; set; }
 
         /// <summary>
+        /// <para>The error code.</para>
+        /// <list type="bullet">
+        /// <item><description>Request succeeded: The ErrorCode field is not returned.</description></item>
+        /// <item><description>Request failed: The ErrorCode field is returned.</description></item>
+        /// </list>
+        /// <para>For more information, see the error code section.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>Invalid.Tenant.ConnectionNotExists</para>
         /// </summary>
@@ -26,6 +35,8 @@ public class CreateBusinessResponseBody : TeaModel {
         public string ErrorCode { get; set; }
 
         /// <summary>
+        /// <para>The error message.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>The connection does not exist.</para>
         /// </summary>
@@ -34,6 +45,8 @@ public class CreateBusinessResponseBody : TeaModel {
         public string ErrorMessage { get; set; }
 
         /// <summary>
+        /// <para>The HTTP status code.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>200</para>
         /// </summary>
@@ -42,6 +55,8 @@ public class CreateBusinessResponseBody : TeaModel {
         public int? HttpStatusCode { get; set; }
 
         /// <summary>
+        /// <para>The unique ID of this request. You can troubleshoot issues based on the ID.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>0000-ABCD-EFG****</para>
         /// </summary>
@@ -50,6 +65,12 @@ public class CreateBusinessResponseBody : TeaModel {
         public string RequestId { get; set; }
 
         /// <summary>
+        /// <para>Indicates whether the call succeeded. Valid values:</para>
+        /// <list type="bullet">
+        /// <item><description>true</description></item>
+        /// <item><description>false</description></item>
+        /// </list>
+        /// 
         /// <b>Example:</b>
         /// <para>true</para>
         /// </summary>

dataworks-public-20240518/core/Models/CreateBusinessResponseBody.cs

@@ -10,6 +10,8 @@ namespace AlibabaCloud.SDK.Dataworks_public20240518.Models
 {
     public class CreateComponentRequest : TeaModel {
         /// <summary>
+        /// <para>The client token that is used to ensure the idempotence of the request.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>1AFAE64E-D1BE-432B-A9****</para>
         /// </summary>
@@ -18,6 +20,7 @@ public class CreateComponentRequest : TeaModel {
         public string ClientToken { get; set; }
 
         /// <summary>
+        /// <para>The DataWorks workspace ID. You can call the <a href="https://help.aliyun.com/document_detail/2852607.html">ListProjects</a> operation to obtain the ID.</para>
         /// <para>This parameter is required.</para>
         /// 
         /// <b>Example:</b>
@@ -28,6 +31,7 @@ public class CreateComponentRequest : TeaModel {
         public long? ProjectId { get; set; }
 
         /// <summary>
+        /// <para>The FlowSpec information for this UDF function. For more information, see <a href="https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md">FlowSpec</a>.</para>
         /// <para>This parameter is required.</para>
         /// 
         /// <b>Example:</b>

dataworks-public-20240518/core/Models/CreateComponentRequest.cs

@@ -10,6 +10,8 @@ namespace AlibabaCloud.SDK.Dataworks_public20240518.Models
 {
     public class CreateComponentResponseBody : TeaModel {
         /// <summary>
+        /// <para>The ID of the dataset acceleration component. To obtain the component ID, see <a href="https://help.aliyun.com/document_detail/2979566.html">ListComponents</a>.</para>
+        /// 
         /// <b>Example:</b>
         /// <para>123123123123123</para>
         /// </summary>