@alicloud/dataworks-public20240518 9.1.1 → 9.2.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (561) hide show
  1. package/dist/client.d.ts +542 -500
  2. package/dist/client.js +603 -501
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/AbolishPipelineRunRequest.d.ts +3 -3
  5. package/dist/models/AbolishPipelineRunResponseBody.d.ts +3 -5
  6. package/dist/models/AbolishPipelineRunResponseBody.js.map +1 -1
  7. package/dist/models/AddEntityIntoMetaCollectionRequest.d.ts +3 -3
  8. package/dist/models/ApproveProcessInstanceRequest.d.ts +5 -5
  9. package/dist/models/ApproveProcessInstanceResponseBody.d.ts +1 -1
  10. package/dist/models/AttachDataQualityRulesToEvaluationTaskRequest.d.ts +4 -3
  11. package/dist/models/AttachDataQualityRulesToEvaluationTaskRequest.js.map +1 -1
  12. package/dist/models/AttachDataQualityRulesToEvaluationTaskResponseBody.d.ts +3 -2
  13. package/dist/models/AttachDataQualityRulesToEvaluationTaskResponseBody.js.map +1 -1
  14. package/dist/models/AttachDataQualityRulesToEvaluationTaskShrinkRequest.d.ts +4 -3
  15. package/dist/models/AttachDataQualityRulesToEvaluationTaskShrinkRequest.js.map +1 -1
  16. package/dist/models/BatchCreateMetaEntitiesRequest.d.ts +9 -11
  17. package/dist/models/BatchCreateMetaEntitiesRequest.js.map +1 -1
  18. package/dist/models/BatchCreateMetaEntitiesResponseBody.d.ts +3 -3
  19. package/dist/models/BatchCreateMetaEntitiesShrinkRequest.d.ts +1 -1
  20. package/dist/models/BatchDeleteMetaEntitiesRequest.d.ts +1 -1
  21. package/dist/models/BatchDeleteMetaEntitiesResponseBody.d.ts +3 -3
  22. package/dist/models/BatchDeleteMetaEntitiesShrinkRequest.d.ts +1 -1
  23. package/dist/models/BatchUpdateTasksRequest.d.ts +29 -39
  24. package/dist/models/BatchUpdateTasksRequest.js.map +1 -1
  25. package/dist/models/BatchUpdateTasksResponseBody.d.ts +2 -2
  26. package/dist/models/BatchUpdateTasksShrinkRequest.d.ts +1 -1
  27. package/dist/models/CancelAgentSessionRequest.d.ts +1 -1
  28. package/dist/models/CancelAgentSessionResponseBody.d.ts +2 -2
  29. package/dist/models/CancelAgentSessionShrinkRequest.d.ts +1 -1
  30. package/dist/models/Catalog.d.ts +0 -37
  31. package/dist/models/Catalog.js.map +1 -1
  32. package/dist/models/CloneDataSourceRequest.d.ts +2 -2
  33. package/dist/models/CloneDataSourceResponseBody.d.ts +2 -2
  34. package/dist/models/Column.d.ts +3 -3
  35. package/dist/models/CrawlerType.d.ts +0 -39
  36. package/dist/models/CrawlerType.js.map +1 -1
  37. package/dist/models/CreateAlertRuleRequest.d.ts +62 -90
  38. package/dist/models/CreateAlertRuleRequest.js.map +1 -1
  39. package/dist/models/CreateAlertRuleResponseBody.d.ts +2 -2
  40. package/dist/models/CreateAlertRuleShrinkRequest.d.ts +5 -5
  41. package/dist/models/CreateComponentRequest.d.ts +3 -3
  42. package/dist/models/CreateComponentResponseBody.d.ts +1 -1
  43. package/dist/models/CreateComputeResourceRequest.d.ts +5 -5
  44. package/dist/models/CreateComputeResourceResponseBody.d.ts +2 -2
  45. package/dist/models/CreateCrawlerRequest.d.ts +39 -0
  46. package/dist/models/CreateCrawlerRequest.js.map +1 -1
  47. package/dist/models/CreateCrawlerResponseBody.d.ts +10 -0
  48. package/dist/models/CreateCrawlerResponseBody.js.map +1 -1
  49. package/dist/models/CreateCrawlerShrinkRequest.d.ts +25 -0
  50. package/dist/models/CreateCrawlerShrinkRequest.js.map +1 -1
  51. package/dist/models/CreateDataQualityAlertRuleRequest.d.ts +8 -16
  52. package/dist/models/CreateDataQualityAlertRuleRequest.js.map +1 -1
  53. package/dist/models/CreateDataQualityAlertRuleResponseBody.d.ts +1 -1
  54. package/dist/models/CreateDataQualityAlertRuleShrinkRequest.d.ts +2 -2
  55. package/dist/models/CreateDataQualityEvaluationTaskInstanceRequest.d.ts +8 -8
  56. package/dist/models/CreateDataQualityEvaluationTaskInstanceResponseBody.d.ts +1 -1
  57. package/dist/models/CreateDataQualityEvaluationTaskInstanceShrinkRequest.d.ts +6 -6
  58. package/dist/models/CreateDataQualityEvaluationTaskRequest.d.ts +64 -104
  59. package/dist/models/CreateDataQualityEvaluationTaskRequest.js.map +1 -1
  60. package/dist/models/CreateDataQualityEvaluationTaskResponseBody.d.ts +1 -1
  61. package/dist/models/CreateDataQualityEvaluationTaskShrinkRequest.d.ts +9 -15
  62. package/dist/models/CreateDataQualityEvaluationTaskShrinkRequest.js.map +1 -1
  63. package/dist/models/CreateDataQualityRuleTemplateRequest.d.ts +28 -25
  64. package/dist/models/CreateDataQualityRuleTemplateRequest.js.map +1 -1
  65. package/dist/models/CreateDataQualityRuleTemplateResponseBody.d.ts +2 -2
  66. package/dist/models/CreateDataQualityRuleTemplateShrinkRequest.d.ts +7 -6
  67. package/dist/models/CreateDataQualityRuleTemplateShrinkRequest.js.map +1 -1
  68. package/dist/models/CreateDataQualityScanRunRequest.d.ts +9 -11
  69. package/dist/models/CreateDataQualityScanRunRequest.js.map +1 -1
  70. package/dist/models/CreateDataQualityScanRunResponseBody.d.ts +1 -1
  71. package/dist/models/CreateDataQualityScanRunShrinkRequest.d.ts +3 -3
  72. package/dist/models/CreateDataSourceRequest.d.ts +12 -16
  73. package/dist/models/CreateDataSourceRequest.js.map +1 -1
  74. package/dist/models/CreateDataSourceResponseBody.d.ts +2 -2
  75. package/dist/models/CreateDatasetRequest.d.ts +27 -53
  76. package/dist/models/CreateDatasetRequest.js.map +1 -1
  77. package/dist/models/CreateDatasetResponseBody.d.ts +1 -1
  78. package/dist/models/CreateDatasetShrinkRequest.d.ts +15 -42
  79. package/dist/models/CreateDatasetShrinkRequest.js.map +1 -1
  80. package/dist/models/CreateDatasetVersionRequest.d.ts +13 -12
  81. package/dist/models/CreateDatasetVersionRequest.js.map +1 -1
  82. package/dist/models/CreateDatasetVersionResponseBody.d.ts +1 -1
  83. package/dist/models/CreateDatasetVersionShrinkRequest.d.ts +13 -12
  84. package/dist/models/CreateDatasetVersionShrinkRequest.js.map +1 -1
  85. package/dist/models/CreateDialarmRuleRequest.d.ts +28 -46
  86. package/dist/models/CreateDialarmRuleRequest.js.map +1 -1
  87. package/dist/models/CreateDialarmRuleResponseBody.d.ts +2 -2
  88. package/dist/models/CreateDialarmRuleShrinkRequest.d.ts +9 -14
  89. package/dist/models/CreateDialarmRuleShrinkRequest.js.map +1 -1
  90. package/dist/models/CreateDijobRequest.d.ts +141 -211
  91. package/dist/models/CreateDijobRequest.js.map +1 -1
  92. package/dist/models/CreateDijobResponseBody.d.ts +3 -3
  93. package/dist/models/CreateDijobShrinkRequest.d.ts +25 -29
  94. package/dist/models/CreateDijobShrinkRequest.js.map +1 -1
  95. package/dist/models/CreateFunctionRequest.d.ts +2 -2
  96. package/dist/models/CreateFunctionResponseBody.d.ts +2 -2
  97. package/dist/models/CreateMcpServerRequest.d.ts +7 -7
  98. package/dist/models/CreateMcpServerResponseBody.d.ts +4 -2
  99. package/dist/models/CreateMcpServerResponseBody.js.map +1 -1
  100. package/dist/models/CreateMcpServerShrinkRequest.d.ts +3 -3
  101. package/dist/models/CreateNodeRequest.d.ts +17 -18
  102. package/dist/models/CreateNodeRequest.js.map +1 -1
  103. package/dist/models/CreateNodeResponseBody.d.ts +3 -3
  104. package/dist/models/CreateProjectMemberRequest.d.ts +5 -5
  105. package/dist/models/CreateProjectMemberResponseBody.d.ts +1 -1
  106. package/dist/models/CreateProjectMemberShrinkRequest.d.ts +5 -5
  107. package/dist/models/CreateProjectRequest.d.ts +16 -16
  108. package/dist/models/CreateProjectResponseBody.d.ts +4 -3
  109. package/dist/models/CreateProjectResponseBody.js.map +1 -1
  110. package/dist/models/CreateProjectShrinkRequest.d.ts +16 -16
  111. package/dist/models/CreateResourceAdvanceRequest.d.ts +4 -5
  112. package/dist/models/CreateResourceAdvanceRequest.js.map +1 -1
  113. package/dist/models/CreateResourceGroupRequest.d.ts +14 -10
  114. package/dist/models/CreateResourceGroupRequest.js.map +1 -1
  115. package/dist/models/CreateResourceGroupResponseBody.d.ts +5 -5
  116. package/dist/models/CreateResourceGroupShrinkRequest.d.ts +14 -10
  117. package/dist/models/CreateResourceGroupShrinkRequest.js.map +1 -1
  118. package/dist/models/CreateResourceRequest.d.ts +4 -5
  119. package/dist/models/CreateResourceRequest.js.map +1 -1
  120. package/dist/models/CreateResourceResponseBody.d.ts +2 -2
  121. package/dist/models/CreateWorkflowDefinitionRequest.d.ts +7 -2
  122. package/dist/models/CreateWorkflowDefinitionRequest.js.map +1 -1
  123. package/dist/models/CreateWorkflowDefinitionResponseBody.d.ts +3 -3
  124. package/dist/models/DataQualityRule.d.ts +0 -9
  125. package/dist/models/DataQualityRule.js.map +1 -1
  126. package/dist/models/Database.d.ts +7 -43
  127. package/dist/models/Database.js.map +1 -1
  128. package/dist/models/DeleteAlertRuleRequest.d.ts +1 -1
  129. package/dist/models/DeleteAlertRuleResponseBody.d.ts +2 -2
  130. package/dist/models/DeleteCertificateRequest.d.ts +2 -2
  131. package/dist/models/DeleteCertificateResponseBody.d.ts +2 -2
  132. package/dist/models/DeleteComponentRequest.d.ts +3 -3
  133. package/dist/models/DeleteCrawlerRequest.d.ts +2 -0
  134. package/dist/models/DeleteCrawlerRequest.js.map +1 -1
  135. package/dist/models/DeleteCrawlerResponseBody.d.ts +10 -0
  136. package/dist/models/DeleteCrawlerResponseBody.js.map +1 -1
  137. package/dist/models/DeleteDatasetResponseBody.d.ts +1 -1
  138. package/dist/models/DeleteNetworkRequest.d.ts +1 -1
  139. package/dist/models/DeleteNetworkResponseBody.d.ts +1 -1
  140. package/dist/models/DeleteProjectMemberRequest.d.ts +2 -2
  141. package/dist/models/DeleteProjectMemberResponseBody.d.ts +1 -1
  142. package/dist/models/DeleteWorkflowDefinitionRequest.d.ts +3 -3
  143. package/dist/models/DeleteWorkflowDefinitionResponseBody.d.ts +4 -4
  144. package/dist/models/DeployFileRequest.d.ts +10 -4
  145. package/dist/models/DeployFileRequest.js.map +1 -1
  146. package/dist/models/DeployFileResponseBody.d.ts +3 -4
  147. package/dist/models/DeployFileResponseBody.js.map +1 -1
  148. package/dist/models/ExecPipelineRunStageRequest.d.ts +3 -3
  149. package/dist/models/ExecPipelineRunStageResponseBody.d.ts +5 -10
  150. package/dist/models/ExecPipelineRunStageResponseBody.js.map +1 -1
  151. package/dist/models/ExecuteAdhocWorkflowInstanceRequest.d.ts +27 -33
  152. package/dist/models/ExecuteAdhocWorkflowInstanceRequest.js.map +1 -1
  153. package/dist/models/ExecuteAdhocWorkflowInstanceResponseBody.d.ts +1 -1
  154. package/dist/models/ExecuteAdhocWorkflowInstanceShrinkRequest.d.ts +7 -9
  155. package/dist/models/ExecuteAdhocWorkflowInstanceShrinkRequest.js.map +1 -1
  156. package/dist/models/GetAlertRuleRequest.d.ts +1 -1
  157. package/dist/models/GetAlertRuleResponseBody.d.ts +66 -90
  158. package/dist/models/GetAlertRuleResponseBody.js.map +1 -1
  159. package/dist/models/GetBusinessRequest.d.ts +3 -3
  160. package/dist/models/GetBusinessResponseBody.d.ts +10 -11
  161. package/dist/models/GetBusinessResponseBody.js.map +1 -1
  162. package/dist/models/GetCatalogRequest.d.ts +7 -5
  163. package/dist/models/GetCatalogRequest.js.map +1 -1
  164. package/dist/models/GetCatalogResponseBody.d.ts +1 -1
  165. package/dist/models/GetCrawlerRequest.d.ts +2 -0
  166. package/dist/models/GetCrawlerRequest.js.map +1 -1
  167. package/dist/models/GetCrawlerResponseBody.d.ts +88 -0
  168. package/dist/models/GetCrawlerResponseBody.js.map +1 -1
  169. package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.d.ts +82 -0
  170. package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.js.map +1 -1
  171. package/dist/models/GetDataSourceRequest.d.ts +1 -1
  172. package/dist/models/GetDataSourceResponseBody.d.ts +17 -22
  173. package/dist/models/GetDataSourceResponseBody.js.map +1 -1
  174. package/dist/models/GetDeploymentPackageRequest.d.ts +10 -4
  175. package/dist/models/GetDeploymentPackageRequest.js.map +1 -1
  176. package/dist/models/GetDeploymentPackageResponseBody.d.ts +39 -35
  177. package/dist/models/GetDeploymentPackageResponseBody.js.map +1 -1
  178. package/dist/models/GetDijobLogRequest.d.ts +6 -7
  179. package/dist/models/GetDijobLogRequest.js.map +1 -1
  180. package/dist/models/GetDijobLogResponseBody.d.ts +2 -2
  181. package/dist/models/GetFileVersionRequest.d.ts +4 -4
  182. package/dist/models/GetFileVersionResponseBody.d.ts +32 -48
  183. package/dist/models/GetFileVersionResponseBody.js.map +1 -1
  184. package/dist/models/GetImageRequest.d.ts +1 -1
  185. package/dist/models/GetImageResponseBody.d.ts +28 -50
  186. package/dist/models/GetImageResponseBody.js.map +1 -1
  187. package/dist/models/GetJobStatusRequest.d.ts +1 -1
  188. package/dist/models/GetJobStatusResponseBody.d.ts +18 -18
  189. package/dist/models/GetLineageRelationshipRequest.d.ts +1 -1
  190. package/dist/models/GetLineageRelationshipResponseBody.d.ts +1 -1
  191. package/dist/models/GetPipelineRunRequest.d.ts +3 -3
  192. package/dist/models/GetPipelineRunResponseBody.d.ts +36 -48
  193. package/dist/models/GetPipelineRunResponseBody.js.map +1 -1
  194. package/dist/models/GetProjectRequest.d.ts +2 -2
  195. package/dist/models/GetProjectResponseBody.d.ts +23 -31
  196. package/dist/models/GetProjectResponseBody.js.map +1 -1
  197. package/dist/models/GetResourceGroupRequest.d.ts +1 -1
  198. package/dist/models/GetResourceGroupResponseBody.d.ts +33 -44
  199. package/dist/models/GetResourceGroupResponseBody.js.map +1 -1
  200. package/dist/models/GetSnapshotRequest.d.ts +23 -0
  201. package/dist/models/GetSnapshotRequest.js +58 -0
  202. package/dist/models/GetSnapshotRequest.js.map +1 -0
  203. package/dist/models/GetSnapshotResponse.d.ts +19 -0
  204. package/dist/models/GetSnapshotResponse.js +69 -0
  205. package/dist/models/GetSnapshotResponse.js.map +1 -0
  206. package/dist/models/GetSnapshotResponseBody.d.ts +151 -0
  207. package/dist/models/GetSnapshotResponseBody.js +126 -0
  208. package/dist/models/GetSnapshotResponseBody.js.map +1 -0
  209. package/dist/models/KillSemanticJobRequest.d.ts +3 -3
  210. package/dist/models/LineageEntity.d.ts +2 -7
  211. package/dist/models/LineageEntity.js.map +1 -1
  212. package/dist/models/LineageRelationship.d.ts +2 -2
  213. package/dist/models/ListAgentSessionArtifactsRequest.d.ts +5 -5
  214. package/dist/models/ListAgentSessionArtifactsResponseBody.d.ts +9 -9
  215. package/dist/models/ListAgentSessionArtifactsShrinkRequest.d.ts +1 -1
  216. package/dist/models/ListAgentsRequest.d.ts +3 -3
  217. package/dist/models/ListAgentsResponseBody.d.ts +3 -3
  218. package/dist/models/ListAgentsShrinkRequest.d.ts +2 -2
  219. package/dist/models/ListCrawlerRunsRequest.d.ts +17 -0
  220. package/dist/models/ListCrawlerRunsRequest.js.map +1 -1
  221. package/dist/models/ListCrawlerRunsResponseBody.d.ts +42 -0
  222. package/dist/models/ListCrawlerRunsResponseBody.js.map +1 -1
  223. package/dist/models/ListCrawlersRequest.d.ts +25 -0
  224. package/dist/models/ListCrawlersRequest.js.map +1 -1
  225. package/dist/models/ListCrawlersResponseBody.d.ts +76 -0
  226. package/dist/models/ListCrawlersResponseBody.js.map +1 -1
  227. package/dist/models/ListCrawlersShrinkRequest.d.ts +25 -0
  228. package/dist/models/ListCrawlersShrinkRequest.js.map +1 -1
  229. package/dist/models/ListDataQualityRuleTemplatesRequest.d.ts +8 -7
  230. package/dist/models/ListDataQualityRuleTemplatesRequest.js.map +1 -1
  231. package/dist/models/ListDataQualityRuleTemplatesResponseBody.d.ts +30 -27
  232. package/dist/models/ListDataQualityRuleTemplatesResponseBody.js.map +1 -1
  233. package/dist/models/ListDataQualityRulesRequest.d.ts +6 -6
  234. package/dist/models/ListDataQualityRulesResponseBody.d.ts +65 -65
  235. package/dist/models/ListDeploymentPackageFilesRequest.d.ts +13 -15
  236. package/dist/models/ListDeploymentPackageFilesRequest.js.map +1 -1
  237. package/dist/models/ListDeploymentPackageFilesResponseBody.d.ts +48 -69
  238. package/dist/models/ListDeploymentPackageFilesResponseBody.js.map +1 -1
  239. package/dist/models/ListDeploymentPackageFilesShrinkRequest.d.ts +13 -15
  240. package/dist/models/ListDeploymentPackageFilesShrinkRequest.js.map +1 -1
  241. package/dist/models/ListDeploymentPackagesRequest.d.ts +13 -17
  242. package/dist/models/ListDeploymentPackagesRequest.js.map +1 -1
  243. package/dist/models/ListDeploymentPackagesResponseBody.d.ts +13 -16
  244. package/dist/models/ListDeploymentPackagesResponseBody.js.map +1 -1
  245. package/dist/models/ListDownstreamTaskInstancesRequest.d.ts +1 -1
  246. package/dist/models/ListDownstreamTaskInstancesResponseBody.d.ts +73 -182
  247. package/dist/models/ListDownstreamTaskInstancesResponseBody.js.map +1 -1
  248. package/dist/models/ListFileVersionsRequest.d.ts +5 -5
  249. package/dist/models/ListFileVersionsResponseBody.d.ts +19 -21
  250. package/dist/models/ListFileVersionsResponseBody.js.map +1 -1
  251. package/dist/models/ListFilesRequest.d.ts +20 -25
  252. package/dist/models/ListFilesRequest.js.map +1 -1
  253. package/dist/models/ListFilesResponseBody.d.ts +32 -40
  254. package/dist/models/ListFilesResponseBody.js.map +1 -1
  255. package/dist/models/ListFoldersRequest.d.ts +8 -4
  256. package/dist/models/ListFoldersRequest.js.map +1 -1
  257. package/dist/models/ListFoldersResponseBody.d.ts +11 -12
  258. package/dist/models/ListFoldersResponseBody.js.map +1 -1
  259. package/dist/models/ListFunctionsRequest.d.ts +9 -14
  260. package/dist/models/ListFunctionsRequest.js.map +1 -1
  261. package/dist/models/ListFunctionsResponseBody.d.ts +35 -43
  262. package/dist/models/ListFunctionsResponseBody.js.map +1 -1
  263. package/dist/models/ListLineageRelationshipsRequest.d.ts +1 -1
  264. package/dist/models/ListLineagesRequest.d.ts +11 -13
  265. package/dist/models/ListLineagesRequest.js.map +1 -1
  266. package/dist/models/ListLineagesResponseBody.d.ts +5 -5
  267. package/dist/models/ListNodesRequest.d.ts +17 -21
  268. package/dist/models/ListNodesRequest.js.map +1 -1
  269. package/dist/models/ListNodesResponseBody.d.ts +78 -122
  270. package/dist/models/ListNodesResponseBody.js.map +1 -1
  271. package/dist/models/ListResourcesRequest.d.ts +7 -10
  272. package/dist/models/ListResourcesRequest.js.map +1 -1
  273. package/dist/models/ListResourcesResponseBody.d.ts +22 -28
  274. package/dist/models/ListResourcesResponseBody.js.map +1 -1
  275. package/dist/models/ListRoutesRequest.d.ts +6 -8
  276. package/dist/models/ListRoutesRequest.js.map +1 -1
  277. package/dist/models/ListRoutesResponseBody.d.ts +9 -9
  278. package/dist/models/ListSnapshotsRequest.d.ts +59 -0
  279. package/dist/models/ListSnapshotsRequest.js +66 -0
  280. package/dist/models/ListSnapshotsRequest.js.map +1 -0
  281. package/dist/models/ListSnapshotsResponse.d.ts +19 -0
  282. package/dist/models/ListSnapshotsResponse.js +69 -0
  283. package/dist/models/ListSnapshotsResponse.js.map +1 -0
  284. package/dist/models/ListSnapshotsResponseBody.d.ts +143 -0
  285. package/dist/models/ListSnapshotsResponseBody.js +124 -0
  286. package/dist/models/ListSnapshotsResponseBody.js.map +1 -0
  287. package/dist/models/ListWorkflowInstancesRequest.d.ts +20 -26
  288. package/dist/models/ListWorkflowInstancesRequest.js.map +1 -1
  289. package/dist/models/ListWorkflowInstancesResponseBody.d.ts +33 -39
  290. package/dist/models/ListWorkflowInstancesResponseBody.js.map +1 -1
  291. package/dist/models/ListWorkflowInstancesShrinkRequest.d.ts +20 -26
  292. package/dist/models/ListWorkflowInstancesShrinkRequest.js.map +1 -1
  293. package/dist/models/Partition.d.ts +0 -18
  294. package/dist/models/Partition.js.map +1 -1
  295. package/dist/models/RevokeMemberProjectRolesRequest.d.ts +4 -4
  296. package/dist/models/RevokeMemberProjectRolesResponseBody.d.ts +1 -1
  297. package/dist/models/RevokeMemberProjectRolesShrinkRequest.d.ts +4 -4
  298. package/dist/models/RunCrawlerRequest.d.ts +2 -0
  299. package/dist/models/RunCrawlerRequest.js.map +1 -1
  300. package/dist/models/RunCrawlerResponseBody.d.ts +20 -0
  301. package/dist/models/RunCrawlerResponseBody.js.map +1 -1
  302. package/dist/models/Schema.d.ts +9 -19
  303. package/dist/models/Schema.js.map +1 -1
  304. package/dist/models/StartWorkflowInstancesRequest.d.ts +1 -1
  305. package/dist/models/StartWorkflowInstancesResponseBody.d.ts +2 -2
  306. package/dist/models/StartWorkflowInstancesShrinkRequest.d.ts +1 -1
  307. package/dist/models/StopCrawlerRequest.d.ts +2 -0
  308. package/dist/models/StopCrawlerRequest.js.map +1 -1
  309. package/dist/models/StopCrawlerResponseBody.d.ts +14 -0
  310. package/dist/models/StopCrawlerResponseBody.js.map +1 -1
  311. package/dist/models/StopTaskInstancesRequest.d.ts +2 -2
  312. package/dist/models/StopTaskInstancesResponseBody.d.ts +2 -2
  313. package/dist/models/StopTaskInstancesShrinkRequest.d.ts +2 -2
  314. package/dist/models/SuccessInfoValue.d.ts +1 -1
  315. package/dist/models/Table.d.ts +10 -3
  316. package/dist/models/Table.js.map +1 -1
  317. package/dist/models/UpdateCrawlerRequest.d.ts +35 -0
  318. package/dist/models/UpdateCrawlerRequest.js.map +1 -1
  319. package/dist/models/UpdateCrawlerResponseBody.d.ts +10 -0
  320. package/dist/models/UpdateCrawlerResponseBody.js.map +1 -1
  321. package/dist/models/UpdateCrawlerShrinkRequest.d.ts +21 -0
  322. package/dist/models/UpdateCrawlerShrinkRequest.js.map +1 -1
  323. package/dist/models/UpdateDataAssetTagRequest.d.ts +4 -4
  324. package/dist/models/UpdateDataAssetTagResponseBody.d.ts +1 -1
  325. package/dist/models/UpdateDataAssetTagShrinkRequest.d.ts +4 -4
  326. package/dist/models/UpdateDataQualityAlertRuleRequest.d.ts +10 -18
  327. package/dist/models/UpdateDataQualityAlertRuleRequest.js.map +1 -1
  328. package/dist/models/UpdateDataQualityAlertRuleResponseBody.d.ts +1 -1
  329. package/dist/models/UpdateDataQualityAlertRuleShrinkRequest.d.ts +4 -4
  330. package/dist/models/UpdateMcpServerRequest.d.ts +5 -5
  331. package/dist/models/UpdateMcpServerResponseBody.d.ts +6 -4
  332. package/dist/models/UpdateMcpServerResponseBody.js.map +1 -1
  333. package/dist/models/UpdateMcpServerShrinkRequest.d.ts +3 -3
  334. package/dist/models/UpdateProjectRoleRequest.d.ts +12 -33
  335. package/dist/models/UpdateProjectRoleRequest.js.map +1 -1
  336. package/dist/models/UpdateProjectRoleShrinkRequest.d.ts +3 -3
  337. package/dist/models/model.d.ts +10 -0
  338. package/dist/models/model.js +56 -36
  339. package/dist/models/model.js.map +1 -1
  340. package/package.json +1 -1
  341. package/src/client.ts +613 -501
  342. package/src/models/AbolishPipelineRunRequest.ts +3 -3
  343. package/src/models/AbolishPipelineRunResponseBody.ts +3 -5
  344. package/src/models/AddEntityIntoMetaCollectionRequest.ts +3 -3
  345. package/src/models/ApproveProcessInstanceRequest.ts +5 -5
  346. package/src/models/ApproveProcessInstanceResponseBody.ts +1 -1
  347. package/src/models/AttachDataQualityRulesToEvaluationTaskRequest.ts +4 -3
  348. package/src/models/AttachDataQualityRulesToEvaluationTaskResponseBody.ts +3 -2
  349. package/src/models/AttachDataQualityRulesToEvaluationTaskShrinkRequest.ts +4 -3
  350. package/src/models/BatchCreateMetaEntitiesRequest.ts +9 -11
  351. package/src/models/BatchCreateMetaEntitiesResponseBody.ts +3 -3
  352. package/src/models/BatchCreateMetaEntitiesShrinkRequest.ts +1 -1
  353. package/src/models/BatchDeleteMetaEntitiesRequest.ts +1 -1
  354. package/src/models/BatchDeleteMetaEntitiesResponseBody.ts +3 -3
  355. package/src/models/BatchDeleteMetaEntitiesShrinkRequest.ts +1 -1
  356. package/src/models/BatchUpdateTasksRequest.ts +29 -39
  357. package/src/models/BatchUpdateTasksResponseBody.ts +2 -2
  358. package/src/models/BatchUpdateTasksShrinkRequest.ts +1 -1
  359. package/src/models/CancelAgentSessionRequest.ts +1 -1
  360. package/src/models/CancelAgentSessionResponseBody.ts +2 -2
  361. package/src/models/CancelAgentSessionShrinkRequest.ts +1 -1
  362. package/src/models/Catalog.ts +0 -37
  363. package/src/models/CloneDataSourceRequest.ts +2 -2
  364. package/src/models/CloneDataSourceResponseBody.ts +2 -2
  365. package/src/models/Column.ts +3 -3
  366. package/src/models/CrawlerType.ts +0 -39
  367. package/src/models/CreateAlertRuleRequest.ts +62 -90
  368. package/src/models/CreateAlertRuleResponseBody.ts +2 -2
  369. package/src/models/CreateAlertRuleShrinkRequest.ts +5 -5
  370. package/src/models/CreateComponentRequest.ts +3 -3
  371. package/src/models/CreateComponentResponseBody.ts +1 -1
  372. package/src/models/CreateComputeResourceRequest.ts +5 -5
  373. package/src/models/CreateComputeResourceResponseBody.ts +2 -2
  374. package/src/models/CreateCrawlerRequest.ts +39 -0
  375. package/src/models/CreateCrawlerResponseBody.ts +10 -0
  376. package/src/models/CreateCrawlerShrinkRequest.ts +25 -0
  377. package/src/models/CreateDataQualityAlertRuleRequest.ts +8 -16
  378. package/src/models/CreateDataQualityAlertRuleResponseBody.ts +1 -1
  379. package/src/models/CreateDataQualityAlertRuleShrinkRequest.ts +2 -2
  380. package/src/models/CreateDataQualityEvaluationTaskInstanceRequest.ts +8 -8
  381. package/src/models/CreateDataQualityEvaluationTaskInstanceResponseBody.ts +1 -1
  382. package/src/models/CreateDataQualityEvaluationTaskInstanceShrinkRequest.ts +6 -6
  383. package/src/models/CreateDataQualityEvaluationTaskRequest.ts +64 -104
  384. package/src/models/CreateDataQualityEvaluationTaskResponseBody.ts +1 -1
  385. package/src/models/CreateDataQualityEvaluationTaskShrinkRequest.ts +9 -15
  386. package/src/models/CreateDataQualityRuleTemplateRequest.ts +28 -25
  387. package/src/models/CreateDataQualityRuleTemplateResponseBody.ts +2 -2
  388. package/src/models/CreateDataQualityRuleTemplateShrinkRequest.ts +7 -6
  389. package/src/models/CreateDataQualityScanRunRequest.ts +9 -11
  390. package/src/models/CreateDataQualityScanRunResponseBody.ts +1 -1
  391. package/src/models/CreateDataQualityScanRunShrinkRequest.ts +3 -3
  392. package/src/models/CreateDataSourceRequest.ts +12 -16
  393. package/src/models/CreateDataSourceResponseBody.ts +2 -2
  394. package/src/models/CreateDatasetRequest.ts +27 -53
  395. package/src/models/CreateDatasetResponseBody.ts +1 -1
  396. package/src/models/CreateDatasetShrinkRequest.ts +15 -42
  397. package/src/models/CreateDatasetVersionRequest.ts +13 -12
  398. package/src/models/CreateDatasetVersionResponseBody.ts +1 -1
  399. package/src/models/CreateDatasetVersionShrinkRequest.ts +13 -12
  400. package/src/models/CreateDialarmRuleRequest.ts +28 -46
  401. package/src/models/CreateDialarmRuleResponseBody.ts +2 -2
  402. package/src/models/CreateDialarmRuleShrinkRequest.ts +9 -14
  403. package/src/models/CreateDijobRequest.ts +141 -211
  404. package/src/models/CreateDijobResponseBody.ts +3 -3
  405. package/src/models/CreateDijobShrinkRequest.ts +25 -29
  406. package/src/models/CreateFunctionRequest.ts +2 -2
  407. package/src/models/CreateFunctionResponseBody.ts +2 -2
  408. package/src/models/CreateMcpServerRequest.ts +7 -7
  409. package/src/models/CreateMcpServerResponseBody.ts +4 -2
  410. package/src/models/CreateMcpServerShrinkRequest.ts +3 -3
  411. package/src/models/CreateNodeRequest.ts +17 -18
  412. package/src/models/CreateNodeResponseBody.ts +3 -3
  413. package/src/models/CreateProjectMemberRequest.ts +5 -5
  414. package/src/models/CreateProjectMemberResponseBody.ts +1 -1
  415. package/src/models/CreateProjectMemberShrinkRequest.ts +5 -5
  416. package/src/models/CreateProjectRequest.ts +16 -16
  417. package/src/models/CreateProjectResponseBody.ts +4 -3
  418. package/src/models/CreateProjectShrinkRequest.ts +16 -16
  419. package/src/models/CreateResourceAdvanceRequest.ts +4 -5
  420. package/src/models/CreateResourceGroupRequest.ts +14 -10
  421. package/src/models/CreateResourceGroupResponseBody.ts +5 -5
  422. package/src/models/CreateResourceGroupShrinkRequest.ts +14 -10
  423. package/src/models/CreateResourceRequest.ts +4 -5
  424. package/src/models/CreateResourceResponseBody.ts +2 -2
  425. package/src/models/CreateWorkflowDefinitionRequest.ts +7 -2
  426. package/src/models/CreateWorkflowDefinitionResponseBody.ts +3 -3
  427. package/src/models/DataQualityRule.ts +0 -9
  428. package/src/models/Database.ts +7 -43
  429. package/src/models/DeleteAlertRuleRequest.ts +1 -1
  430. package/src/models/DeleteAlertRuleResponseBody.ts +2 -2
  431. package/src/models/DeleteCertificateRequest.ts +2 -2
  432. package/src/models/DeleteCertificateResponseBody.ts +2 -2
  433. package/src/models/DeleteComponentRequest.ts +3 -3
  434. package/src/models/DeleteCrawlerRequest.ts +2 -0
  435. package/src/models/DeleteCrawlerResponseBody.ts +10 -0
  436. package/src/models/DeleteDatasetResponseBody.ts +1 -1
  437. package/src/models/DeleteNetworkRequest.ts +1 -1
  438. package/src/models/DeleteNetworkResponseBody.ts +1 -1
  439. package/src/models/DeleteProjectMemberRequest.ts +2 -2
  440. package/src/models/DeleteProjectMemberResponseBody.ts +1 -1
  441. package/src/models/DeleteWorkflowDefinitionRequest.ts +3 -3
  442. package/src/models/DeleteWorkflowDefinitionResponseBody.ts +4 -4
  443. package/src/models/DeployFileRequest.ts +10 -4
  444. package/src/models/DeployFileResponseBody.ts +3 -4
  445. package/src/models/ExecPipelineRunStageRequest.ts +3 -3
  446. package/src/models/ExecPipelineRunStageResponseBody.ts +5 -10
  447. package/src/models/ExecuteAdhocWorkflowInstanceRequest.ts +27 -33
  448. package/src/models/ExecuteAdhocWorkflowInstanceResponseBody.ts +1 -1
  449. package/src/models/ExecuteAdhocWorkflowInstanceShrinkRequest.ts +7 -9
  450. package/src/models/GetAlertRuleRequest.ts +1 -1
  451. package/src/models/GetAlertRuleResponseBody.ts +66 -90
  452. package/src/models/GetBusinessRequest.ts +3 -3
  453. package/src/models/GetBusinessResponseBody.ts +10 -11
  454. package/src/models/GetCatalogRequest.ts +7 -5
  455. package/src/models/GetCatalogResponseBody.ts +1 -1
  456. package/src/models/GetCrawlerRequest.ts +2 -0
  457. package/src/models/GetCrawlerResponseBody.ts +88 -0
  458. package/src/models/GetCrawlerTypeCapabilitiesResponseBody.ts +82 -0
  459. package/src/models/GetDataSourceRequest.ts +1 -1
  460. package/src/models/GetDataSourceResponseBody.ts +17 -22
  461. package/src/models/GetDeploymentPackageRequest.ts +10 -4
  462. package/src/models/GetDeploymentPackageResponseBody.ts +39 -35
  463. package/src/models/GetDijobLogRequest.ts +6 -7
  464. package/src/models/GetDijobLogResponseBody.ts +2 -2
  465. package/src/models/GetFileVersionRequest.ts +4 -4
  466. package/src/models/GetFileVersionResponseBody.ts +32 -48
  467. package/src/models/GetImageRequest.ts +1 -1
  468. package/src/models/GetImageResponseBody.ts +28 -50
  469. package/src/models/GetJobStatusRequest.ts +1 -1
  470. package/src/models/GetJobStatusResponseBody.ts +18 -18
  471. package/src/models/GetLineageRelationshipRequest.ts +1 -1
  472. package/src/models/GetLineageRelationshipResponseBody.ts +1 -1
  473. package/src/models/GetPipelineRunRequest.ts +3 -3
  474. package/src/models/GetPipelineRunResponseBody.ts +36 -48
  475. package/src/models/GetProjectRequest.ts +2 -2
  476. package/src/models/GetProjectResponseBody.ts +23 -31
  477. package/src/models/GetResourceGroupRequest.ts +1 -1
  478. package/src/models/GetResourceGroupResponseBody.ts +33 -44
  479. package/src/models/GetSnapshotRequest.ts +36 -0
  480. package/src/models/GetSnapshotResponse.ts +40 -0
  481. package/src/models/GetSnapshotResponseBody.ts +214 -0
  482. package/src/models/KillSemanticJobRequest.ts +3 -3
  483. package/src/models/LineageEntity.ts +2 -7
  484. package/src/models/LineageRelationship.ts +2 -2
  485. package/src/models/ListAgentSessionArtifactsRequest.ts +5 -5
  486. package/src/models/ListAgentSessionArtifactsResponseBody.ts +9 -9
  487. package/src/models/ListAgentSessionArtifactsShrinkRequest.ts +1 -1
  488. package/src/models/ListAgentsRequest.ts +3 -3
  489. package/src/models/ListAgentsResponseBody.ts +3 -3
  490. package/src/models/ListAgentsShrinkRequest.ts +2 -2
  491. package/src/models/ListCrawlerRunsRequest.ts +17 -0
  492. package/src/models/ListCrawlerRunsResponseBody.ts +42 -0
  493. package/src/models/ListCrawlersRequest.ts +25 -0
  494. package/src/models/ListCrawlersResponseBody.ts +76 -0
  495. package/src/models/ListCrawlersShrinkRequest.ts +25 -0
  496. package/src/models/ListDataQualityRuleTemplatesRequest.ts +8 -7
  497. package/src/models/ListDataQualityRuleTemplatesResponseBody.ts +30 -27
  498. package/src/models/ListDataQualityRulesRequest.ts +6 -6
  499. package/src/models/ListDataQualityRulesResponseBody.ts +65 -65
  500. package/src/models/ListDeploymentPackageFilesRequest.ts +14 -16
  501. package/src/models/ListDeploymentPackageFilesResponseBody.ts +48 -69
  502. package/src/models/ListDeploymentPackageFilesShrinkRequest.ts +14 -16
  503. package/src/models/ListDeploymentPackagesRequest.ts +13 -17
  504. package/src/models/ListDeploymentPackagesResponseBody.ts +13 -16
  505. package/src/models/ListDownstreamTaskInstancesRequest.ts +1 -1
  506. package/src/models/ListDownstreamTaskInstancesResponseBody.ts +73 -182
  507. package/src/models/ListFileVersionsRequest.ts +5 -5
  508. package/src/models/ListFileVersionsResponseBody.ts +19 -21
  509. package/src/models/ListFilesRequest.ts +20 -25
  510. package/src/models/ListFilesResponseBody.ts +32 -40
  511. package/src/models/ListFoldersRequest.ts +8 -4
  512. package/src/models/ListFoldersResponseBody.ts +11 -12
  513. package/src/models/ListFunctionsRequest.ts +9 -14
  514. package/src/models/ListFunctionsResponseBody.ts +35 -43
  515. package/src/models/ListLineageRelationshipsRequest.ts +1 -1
  516. package/src/models/ListLineagesRequest.ts +11 -13
  517. package/src/models/ListLineagesResponseBody.ts +5 -5
  518. package/src/models/ListNodesRequest.ts +17 -21
  519. package/src/models/ListNodesResponseBody.ts +78 -122
  520. package/src/models/ListResourcesRequest.ts +7 -10
  521. package/src/models/ListResourcesResponseBody.ts +22 -28
  522. package/src/models/ListRoutesRequest.ts +6 -8
  523. package/src/models/ListRoutesResponseBody.ts +9 -9
  524. package/src/models/ListSnapshotsRequest.ts +80 -0
  525. package/src/models/ListSnapshotsResponse.ts +40 -0
  526. package/src/models/ListSnapshotsResponseBody.ts +204 -0
  527. package/src/models/ListWorkflowInstancesRequest.ts +20 -26
  528. package/src/models/ListWorkflowInstancesResponseBody.ts +33 -39
  529. package/src/models/ListWorkflowInstancesShrinkRequest.ts +20 -26
  530. package/src/models/Partition.ts +0 -18
  531. package/src/models/RevokeMemberProjectRolesRequest.ts +4 -4
  532. package/src/models/RevokeMemberProjectRolesResponseBody.ts +1 -1
  533. package/src/models/RevokeMemberProjectRolesShrinkRequest.ts +4 -4
  534. package/src/models/RunCrawlerRequest.ts +2 -0
  535. package/src/models/RunCrawlerResponseBody.ts +20 -0
  536. package/src/models/Schema.ts +9 -19
  537. package/src/models/StartWorkflowInstancesRequest.ts +1 -1
  538. package/src/models/StartWorkflowInstancesResponseBody.ts +2 -2
  539. package/src/models/StartWorkflowInstancesShrinkRequest.ts +1 -1
  540. package/src/models/StopCrawlerRequest.ts +2 -0
  541. package/src/models/StopCrawlerResponseBody.ts +14 -0
  542. package/src/models/StopTaskInstancesRequest.ts +2 -2
  543. package/src/models/StopTaskInstancesResponseBody.ts +2 -2
  544. package/src/models/StopTaskInstancesShrinkRequest.ts +2 -2
  545. package/src/models/SuccessInfoValue.ts +1 -1
  546. package/src/models/Table.ts +10 -3
  547. package/src/models/UpdateCrawlerRequest.ts +35 -0
  548. package/src/models/UpdateCrawlerResponseBody.ts +10 -0
  549. package/src/models/UpdateCrawlerShrinkRequest.ts +21 -0
  550. package/src/models/UpdateDataAssetTagRequest.ts +4 -4
  551. package/src/models/UpdateDataAssetTagResponseBody.ts +1 -1
  552. package/src/models/UpdateDataAssetTagShrinkRequest.ts +4 -4
  553. package/src/models/UpdateDataQualityAlertRuleRequest.ts +10 -18
  554. package/src/models/UpdateDataQualityAlertRuleResponseBody.ts +1 -1
  555. package/src/models/UpdateDataQualityAlertRuleShrinkRequest.ts +4 -4
  556. package/src/models/UpdateMcpServerRequest.ts +5 -5
  557. package/src/models/UpdateMcpServerResponseBody.ts +6 -4
  558. package/src/models/UpdateMcpServerShrinkRequest.ts +3 -3
  559. package/src/models/UpdateProjectRoleRequest.ts +12 -33
  560. package/src/models/UpdateProjectRoleShrinkRequest.ts +3 -3
  561. package/src/models/model.ts +10 -0
package/dist/client.d.ts CHANGED
@@ -14,11 +14,10 @@ export default class Client extends OpenApi {
14
14
  [key: string]: string;
15
15
  }, endpoint: string): string;
16
16
  /**
17
- * Terminates the specified deployment process. This operation changes the status of the process to Terminated but does not delete the process. You can still query the process.
17
+ * Calls this operation to change the status of a specified deployment process to terminated. The deployment process is not deleted and can still be queried through query operations.
18
18
  *
19
19
  * @remarks
20
- * >Notice:
21
- * This API may not be available in earlier versions of the SDK. In that case, use the AbolishDeployment API, which accepts the same parameters.
20
+ * >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the AbolishDeployment operation. The parameters are the same as those described in this document.
22
21
  *
23
22
  * @param request - AbolishPipelineRunRequest
24
23
  * @param runtime - runtime options for this request RuntimeOptions
@@ -26,21 +25,20 @@ export default class Client extends OpenApi {
26
25
  */
27
26
  abolishPipelineRunWithOptions(request: $_model.AbolishPipelineRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AbolishPipelineRunResponse>;
28
27
  /**
29
- * Terminates the specified deployment process. This operation changes the status of the process to Terminated but does not delete the process. You can still query the process.
28
+ * Calls this operation to change the status of a specified deployment process to terminated. The deployment process is not deleted and can still be queried through query operations.
30
29
  *
31
30
  * @remarks
32
- * >Notice:
33
- * This API may not be available in earlier versions of the SDK. In that case, use the AbolishDeployment API, which accepts the same parameters.
31
+ * >Notice: This operation may not be available in earlier versions of the SDK. In this case, use the AbolishDeployment operation. The parameters are the same as those described in this document.
34
32
  *
35
33
  * @param request - AbolishPipelineRunRequest
36
34
  * @returns AbolishPipelineRunResponse
37
35
  */
38
36
  abolishPipelineRun(request: $_model.AbolishPipelineRunRequest): Promise<$_model.AbolishPipelineRunResponse>;
39
37
  /**
40
- * Adds an entity to a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to add an entity to a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.
38
+ * Adds a specified entity object to a Data Map collection. The collection object can be a Data Map category or a data album. The entity object currently supports only the data table type. To add an entity to a data album, the caller must have the AliyunDataWorksFullAccess permission, or be the creator or administrator of the album.
41
39
  *
42
40
  * @remarks
43
- * 1. DataWorks Professional Edition or a higher edition is required.
41
+ * 1. DataWorks Professional Edition or a more advanced edition is required.
44
42
  *
45
43
  * @param request - AddEntityIntoMetaCollectionRequest
46
44
  * @param runtime - runtime options for this request RuntimeOptions
@@ -48,10 +46,10 @@ export default class Client extends OpenApi {
48
46
  */
49
47
  addEntityIntoMetaCollectionWithOptions(request: $_model.AddEntityIntoMetaCollectionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AddEntityIntoMetaCollectionResponse>;
50
48
  /**
51
- * Adds an entity to a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to add an entity to a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.
49
+ * Adds a specified entity object to a Data Map collection. The collection object can be a Data Map category or a data album. The entity object currently supports only the data table type. To add an entity to a data album, the caller must have the AliyunDataWorksFullAccess permission, or be the creator or administrator of the album.
52
50
  *
53
51
  * @remarks
54
- * 1. DataWorks Professional Edition or a higher edition is required.
52
+ * 1. DataWorks Professional Edition or a more advanced edition is required.
55
53
  *
56
54
  * @param request - AddEntityIntoMetaCollectionRequest
57
55
  * @returns AddEntityIntoMetaCollectionResponse
@@ -102,7 +100,7 @@ export default class Client extends OpenApi {
102
100
  * @remarks
103
101
  * ## Request description
104
102
  * - This operation allows you to approve or reject a specified approval process instance by passing in the ProcessInstanceId and approval information (including ApprovalComment and ApprovalAction).
105
- * - ApprovalAction can be Agree or Deny, indicating approval or rejection respectively.
103
+ * - ApprovalAction can be `Agree` or `Deny`, indicating approval or rejection respectively.
106
104
  * - ApprovalComment is required and records the specific approval opinion.
107
105
  *
108
106
  * @param request - ApproveProcessInstanceRequest
@@ -116,7 +114,7 @@ export default class Client extends OpenApi {
116
114
  * @remarks
117
115
  * ## Request description
118
116
  * - This operation allows you to approve or reject a specified approval process instance by passing in the ProcessInstanceId and approval information (including ApprovalComment and ApprovalAction).
119
- * - ApprovalAction can be Agree or Deny, indicating approval or rejection respectively.
117
+ * - ApprovalAction can be `Agree` or `Deny`, indicating approval or rejection respectively.
120
118
  * - ApprovalComment is required and records the specific approval opinion.
121
119
  *
122
120
  * @param request - ApproveProcessInstanceRequest
@@ -172,10 +170,10 @@ export default class Client extends OpenApi {
172
170
  */
173
171
  associateProjectToResourceGroup(request: $_model.AssociateProjectToResourceGroupRequest): Promise<$_model.AssociateProjectToResourceGroupResponse>;
174
172
  /**
175
- * Associates data quality rules with a data quality monitoring task.
173
+ * Associates data quality rules with a data quality check task.
176
174
  *
177
175
  * @remarks
178
- * You must purchase DataWorks Basic Edition or higher to use this feature.
176
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
179
177
  *
180
178
  * @deprecated OpenAPI AttachDataQualityRulesToEvaluationTask is deprecated, please use dataworks-public::2024-05-18::UpdateDataQualityScan instead.
181
179
  *
@@ -185,10 +183,10 @@ export default class Client extends OpenApi {
185
183
  */
186
184
  attachDataQualityRulesToEvaluationTaskWithOptions(tmpReq: $_model.AttachDataQualityRulesToEvaluationTaskRequest, runtime: $dara.RuntimeOptions): Promise<$_model.AttachDataQualityRulesToEvaluationTaskResponse>;
187
185
  /**
188
- * Associates data quality rules with a data quality monitoring task.
186
+ * Associates data quality rules with a data quality check task.
189
187
  *
190
188
  * @remarks
191
- * You must purchase DataWorks Basic Edition or higher to use this feature.
189
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
192
190
  *
193
191
  * @deprecated OpenAPI AttachDataQualityRulesToEvaluationTask is deprecated, please use dataworks-public::2024-05-18::UpdateDataQualityScan instead.
194
192
  *
@@ -197,10 +195,10 @@ export default class Client extends OpenApi {
197
195
  */
198
196
  attachDataQualityRulesToEvaluationTask(request: $_model.AttachDataQualityRulesToEvaluationTaskRequest): Promise<$_model.AttachDataQualityRulesToEvaluationTaskResponse>;
199
197
  /**
200
- * Creates metadata entities in a batch. All entities within a batch must have the same entity type. This operation currently supports only custom types and extended table types, which represent databases and tables.
198
+ * Creates metadata entities in batches. All entities in the same batch must be of the same type. Currently, only custom entity types and extension table types (corresponding to Database/Table) are supported.
201
199
  *
202
200
  * @remarks
203
- * You must purchase DataWorks Professional Edition or a higher edition to use this operation.
201
+ * DataWorks Professional Edition or a higher edition is required.
204
202
  *
205
203
  * @param tmpReq - BatchCreateMetaEntitiesRequest
206
204
  * @param runtime - runtime options for this request RuntimeOptions
@@ -208,20 +206,20 @@ export default class Client extends OpenApi {
208
206
  */
209
207
  batchCreateMetaEntitiesWithOptions(tmpReq: $_model.BatchCreateMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchCreateMetaEntitiesResponse>;
210
208
  /**
211
- * Creates metadata entities in a batch. All entities within a batch must have the same entity type. This operation currently supports only custom types and extended table types, which represent databases and tables.
209
+ * Creates metadata entities in batches. All entities in the same batch must be of the same type. Currently, only custom entity types and extension table types (corresponding to Database/Table) are supported.
212
210
  *
213
211
  * @remarks
214
- * You must purchase DataWorks Professional Edition or a higher edition to use this operation.
212
+ * DataWorks Professional Edition or a higher edition is required.
215
213
  *
216
214
  * @param request - BatchCreateMetaEntitiesRequest
217
215
  * @returns BatchCreateMetaEntitiesResponse
218
216
  */
219
217
  batchCreateMetaEntities(request: $_model.BatchCreateMetaEntitiesRequest): Promise<$_model.BatchCreateMetaEntitiesResponse>;
220
218
  /**
221
- * Deletes multiple meta entities in a batch. This operation deletes custom meta entities and extended table-based objects, such as databases and tables. You cannot delete a column individually. Instead, you must delete the entire table to remove its associated columns.
219
+ * Deletes metadata entity objects in batches. Supports deleting custom entities and extension table type objects (Database/Table). Does not support deleting columns individually. You can delete associated Column objects by deleting the Table.
222
220
  *
223
221
  * @remarks
224
- * This operation requires DataWorks Professional Edition or higher.
222
+ * Requires DataWorks Professional Edition or a higher edition.
225
223
  *
226
224
  * @param tmpReq - BatchDeleteMetaEntitiesRequest
227
225
  * @param runtime - runtime options for this request RuntimeOptions
@@ -229,20 +227,20 @@ export default class Client extends OpenApi {
229
227
  */
230
228
  batchDeleteMetaEntitiesWithOptions(tmpReq: $_model.BatchDeleteMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchDeleteMetaEntitiesResponse>;
231
229
  /**
232
- * Deletes multiple meta entities in a batch. This operation deletes custom meta entities and extended table-based objects, such as databases and tables. You cannot delete a column individually. Instead, you must delete the entire table to remove its associated columns.
230
+ * Deletes metadata entity objects in batches. Supports deleting custom entities and extension table type objects (Database/Table). Does not support deleting columns individually. You can delete associated Column objects by deleting the Table.
233
231
  *
234
232
  * @remarks
235
- * This operation requires DataWorks Professional Edition or higher.
233
+ * Requires DataWorks Professional Edition or a higher edition.
236
234
  *
237
235
  * @param request - BatchDeleteMetaEntitiesRequest
238
236
  * @returns BatchDeleteMetaEntitiesResponse
239
237
  */
240
238
  batchDeleteMetaEntities(request: $_model.BatchDeleteMetaEntitiesRequest): Promise<$_model.BatchDeleteMetaEntitiesResponse>;
241
239
  /**
242
- * Performs incremental updates on multiple tasks at a time.
240
+ * Updates multiple nodes in batches by using incremental updates.
243
241
  *
244
242
  * @remarks
245
- * DataWorks Basic Edition or higher is required.
243
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
246
244
  *
247
245
  * @param tmpReq - BatchUpdateTasksRequest
248
246
  * @param runtime - runtime options for this request RuntimeOptions
@@ -250,21 +248,21 @@ export default class Client extends OpenApi {
250
248
  */
251
249
  batchUpdateTasksWithOptions(tmpReq: $_model.BatchUpdateTasksRequest, runtime: $dara.RuntimeOptions): Promise<$_model.BatchUpdateTasksResponse>;
252
250
  /**
253
- * Performs incremental updates on multiple tasks at a time.
251
+ * Updates multiple nodes in batches by using incremental updates.
254
252
  *
255
253
  * @remarks
256
- * DataWorks Basic Edition or higher is required.
254
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
257
255
  *
258
256
  * @param request - BatchUpdateTasksRequest
259
257
  * @returns BatchUpdateTasksResponse
260
258
  */
261
259
  batchUpdateTasks(request: $_model.BatchUpdateTasksRequest): Promise<$_model.BatchUpdateTasksResponse>;
262
260
  /**
263
- * Cancels an agent call in a specified session. This operation also supports interrupting an ongoing streaming response.
261
+ * Interrupts the Agent call for a specified session, supporting interruption during streaming responses.
264
262
  *
265
263
  * @remarks
266
- * ## Description
267
- * - This operation is used to actively interrupt an ongoing session, especially when the session is generating a streaming response.
264
+ * ## Request description
265
+ * - This operation is mainly used to actively interrupt an ongoing session, especially when the session is in a streaming response state.
268
266
  * - `sessionId` is a required parameter that identifies the specific session to cancel.
269
267
  *
270
268
  * @param tmpReq - CancelAgentSessionRequest
@@ -273,11 +271,11 @@ export default class Client extends OpenApi {
273
271
  */
274
272
  cancelAgentSessionWithOptions(tmpReq: $_model.CancelAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CancelAgentSessionResponse>;
275
273
  /**
276
- * Cancels an agent call in a specified session. This operation also supports interrupting an ongoing streaming response.
274
+ * Interrupts the Agent call for a specified session, supporting interruption during streaming responses.
277
275
  *
278
276
  * @remarks
279
- * ## Description
280
- * - This operation is used to actively interrupt an ongoing session, especially when the session is generating a streaming response.
277
+ * ## Request description
278
+ * - This operation is mainly used to actively interrupt an ongoing session, especially when the session is in a streaming response state.
281
279
  * - `sessionId` is a required parameter that identifies the specific session to cancel.
282
280
  *
283
281
  * @param request - CancelAgentSessionRequest
@@ -285,12 +283,12 @@ export default class Client extends OpenApi {
285
283
  */
286
284
  cancelAgentSession(request: $_model.CancelAgentSessionRequest): Promise<$_model.CancelAgentSessionResponse>;
287
285
  /**
288
- * Clones a data source to create a new data source with the same configurations.
286
+ * Clones a new data source based on an existing data source.
289
287
  *
290
288
  * @remarks
291
- * 1. This operation is available for all DataWorks editions.
292
- * 2. To call this operation, you must have one of the following roles in DataWorks:
293
- * - Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M
289
+ * 1. You must have purchased DataWorks Basic Edition or a higher edition.
290
+ * 2. You must have at least one of the following roles in the DataWorks workspace:
291
+ * - Tenant Owner, Storage Management Administrator, Project Owner, or O&M Engineer
294
292
  *
295
293
  * @param request - CloneDataSourceRequest
296
294
  * @param runtime - runtime options for this request RuntimeOptions
@@ -298,12 +296,12 @@ export default class Client extends OpenApi {
298
296
  */
299
297
  cloneDataSourceWithOptions(request: $_model.CloneDataSourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CloneDataSourceResponse>;
300
298
  /**
301
- * Clones a data source to create a new data source with the same configurations.
299
+ * Clones a new data source based on an existing data source.
302
300
  *
303
301
  * @remarks
304
- * 1. This operation is available for all DataWorks editions.
305
- * 2. To call this operation, you must have one of the following roles in DataWorks:
306
- * - Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M
302
+ * 1. You must have purchased DataWorks Basic Edition or a higher edition.
303
+ * 2. You must have at least one of the following roles in the DataWorks workspace:
304
+ * - Tenant Owner, Storage Management Administrator, Project Owner, or O&M Engineer
307
305
  *
308
306
  * @param request - CloneDataSourceRequest
309
307
  * @returns CloneDataSourceResponse
@@ -406,11 +404,10 @@ export default class Client extends OpenApi {
406
404
  */
407
405
  createBusiness(request: $_model.CreateBusinessRequest): Promise<$_model.CreateBusinessResponse>;
408
406
  /**
409
- * Creates components.
407
+ * Creates a component.
410
408
  *
411
409
  * @remarks
412
- * >Notice:
413
- * This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.
410
+ * >Notice: This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.
414
411
  *
415
412
  * @param request - CreateComponentRequest
416
413
  * @param runtime - runtime options for this request RuntimeOptions
@@ -418,23 +415,22 @@ export default class Client extends OpenApi {
418
415
  */
419
416
  createComponentWithOptions(request: $_model.CreateComponentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateComponentResponse>;
420
417
  /**
421
- * Creates components.
418
+ * Creates a component.
422
419
  *
423
420
  * @remarks
424
- * >Notice:
425
- * This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.
421
+ * >Notice: This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.
426
422
  *
427
423
  * @param request - CreateComponentRequest
428
424
  * @returns CreateComponentResponse
429
425
  */
430
426
  createComponent(request: $_model.CreateComponentRequest): Promise<$_model.CreateComponentResponse>;
431
427
  /**
432
- * Creates a computing resource in the specified workspace. The resource can be for a development environment or a production environment.
428
+ * Creates a compute resource in a specified workspace. The compute resource can be in the development environment or production environment.
433
429
  *
434
430
  * @remarks
435
- * DataWorks Basic Edition or a more advanced edition is required.
431
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
436
432
  * You must have at least one of the following roles in the DataWorks workspace:
437
- * Tenant Owner, Workspace Administrator, Project Owner, O\\&M
433
+ * Tenant Owner, Workspace Administrator, Project Owner, or O&M.
438
434
  *
439
435
  * @param request - CreateComputeResourceRequest
440
436
  * @param runtime - runtime options for this request RuntimeOptions
@@ -442,31 +438,31 @@ export default class Client extends OpenApi {
442
438
  */
443
439
  createComputeResourceWithOptions(request: $_model.CreateComputeResourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateComputeResourceResponse>;
444
440
  /**
445
- * Creates a computing resource in the specified workspace. The resource can be for a development environment or a production environment.
441
+ * Creates a compute resource in a specified workspace. The compute resource can be in the development environment or production environment.
446
442
  *
447
443
  * @remarks
448
- * DataWorks Basic Edition or a more advanced edition is required.
444
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
449
445
  * You must have at least one of the following roles in the DataWorks workspace:
450
- * Tenant Owner, Workspace Administrator, Project Owner, O\\&M
446
+ * Tenant Owner, Workspace Administrator, Project Owner, or O&M.
451
447
  *
452
448
  * @param request - CreateComputeResourceRequest
453
449
  * @returns CreateComputeResourceResponse
454
450
  */
455
451
  createComputeResource(request: $_model.CreateComputeResourceRequest): Promise<$_model.CreateComputeResourceResponse>;
456
452
  /**
457
- * 创建元数据采集器
453
+ * Creates a metadata crawler and configures the data source, collection scope, resource group, and scheduling method.
458
454
  *
459
455
  * @remarks
460
- * ## 使用场景
461
- * 为指定数据源创建元数据采集器,并配置采集范围、资源组、调度方式和扩展配置。
462
- * ## 推荐流程
463
- * 1. 调用 `GetCrawlerTypeCapabilities` 查询当前地域支持的采集器类型及其配置能力。
464
- * 2. 使用与 `Type` 匹配的数据源创建采集器。
465
- * 3. 创建成功后,调用 `RunCrawler` 手动运行,或通过周期调度自动运行。
466
- * ## 版本要求
467
- * 需要购买DataWorks基础版及以上版本才能使用。
468
- * ## 注意事项
469
- * 创建成功仅表示采集器配置已生成,不会立即执行元数据采集。
456
+ * ## Scenarios
457
+ * Creates a metadata crawler for a specified data source and configures the collection scope, resource group, scheduling method, and extended configurations.
458
+ * ## Recommended workflow
459
+ * 1. Call `GetCrawlerTypeCapabilities` to query the crawler types and their configuration capabilities supported in the current region.
460
+ * 2. Create a crawler by using a data source that matches the `Type` value. Before creating a crawler, ensure that the data source and the selected resource group pass the connectivity test by calling the `TestDataSourceConnectivity` API to avoid creating an invalid crawler.
461
+ * 3. After the crawler is created, call `RunCrawler` to manually run it, or configure periodic scheduling for automatic execution.
462
+ * ## Edition requirements
463
+ * DataWorks Basic Edition or a higher edition is required.
464
+ * ## Precautions
465
+ * A successful creation only indicates that the crawler configuration has been generated. Metadata collection is not immediately executed.
470
466
  *
471
467
  * @param tmpReq - CreateCrawlerRequest
472
468
  * @param runtime - runtime options for this request RuntimeOptions
@@ -474,19 +470,19 @@ export default class Client extends OpenApi {
474
470
  */
475
471
  createCrawlerWithOptions(tmpReq: $_model.CreateCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCrawlerResponse>;
476
472
  /**
477
- * 创建元数据采集器
473
+ * Creates a metadata crawler and configures the data source, collection scope, resource group, and scheduling method.
478
474
  *
479
475
  * @remarks
480
- * ## 使用场景
481
- * 为指定数据源创建元数据采集器,并配置采集范围、资源组、调度方式和扩展配置。
482
- * ## 推荐流程
483
- * 1. 调用 `GetCrawlerTypeCapabilities` 查询当前地域支持的采集器类型及其配置能力。
484
- * 2. 使用与 `Type` 匹配的数据源创建采集器。
485
- * 3. 创建成功后,调用 `RunCrawler` 手动运行,或通过周期调度自动运行。
486
- * ## 版本要求
487
- * 需要购买DataWorks基础版及以上版本才能使用。
488
- * ## 注意事项
489
- * 创建成功仅表示采集器配置已生成,不会立即执行元数据采集。
476
+ * ## Scenarios
477
+ * Creates a metadata crawler for a specified data source and configures the collection scope, resource group, scheduling method, and extended configurations.
478
+ * ## Recommended workflow
479
+ * 1. Call `GetCrawlerTypeCapabilities` to query the crawler types and their configuration capabilities supported in the current region.
480
+ * 2. Create a crawler by using a data source that matches the `Type` value. Before creating a crawler, ensure that the data source and the selected resource group pass the connectivity test by calling the `TestDataSourceConnectivity` API to avoid creating an invalid crawler.
481
+ * 3. After the crawler is created, call `RunCrawler` to manually run it, or configure periodic scheduling for automatic execution.
482
+ * ## Edition requirements
483
+ * DataWorks Basic Edition or a higher edition is required.
484
+ * ## Precautions
485
+ * A successful creation only indicates that the crawler configuration has been generated. Metadata collection is not immediately executed.
490
486
  *
491
487
  * @param request - CreateCrawlerRequest
492
488
  * @returns CreateCrawlerResponse
@@ -508,7 +504,10 @@ export default class Client extends OpenApi {
508
504
  */
509
505
  createCustomAttribute(request: $_model.CreateCustomAttributeRequest): Promise<$_model.CreateCustomAttributeResponse>;
510
506
  /**
511
- * Creates an alert rule for a synchronization task.
507
+ * Creates an alert rule for a data integration task.
508
+ *
509
+ * @remarks
510
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
512
511
  *
513
512
  * @param tmpReq - CreateDIAlarmRuleRequest
514
513
  * @param runtime - runtime options for this request RuntimeOptions
@@ -516,18 +515,21 @@ export default class Client extends OpenApi {
516
515
  */
517
516
  createDIAlarmRuleWithOptions(tmpReq: $_model.CreateDIAlarmRuleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDIAlarmRuleResponse>;
518
517
  /**
519
- * Creates an alert rule for a synchronization task.
518
+ * Creates an alert rule for a data integration task.
519
+ *
520
+ * @remarks
521
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
520
522
  *
521
523
  * @param request - CreateDIAlarmRuleRequest
522
524
  * @returns CreateDIAlarmRuleResponse
523
525
  */
524
526
  createDIAlarmRule(request: $_model.CreateDIAlarmRuleRequest): Promise<$_model.CreateDIAlarmRuleResponse>;
525
527
  /**
526
- * Create a new version of a data integration task.
528
+ * Creates a data integration task.
527
529
  *
528
530
  * @remarks
529
- * - This API requires DataWorks Basic Edition or a higher edition.
530
- * - This API creates a data integration synchronization task. Key parameters include `SourceDataSourceSettings`, `DestinationDataSourceSettings`, and `MigrationType`. The `TransformationRules` parameter defines transformation rules for synchronized tables, such as adding columns or replacing table names. The `TableMappings` parameter specifies which tables to synchronize and their mapping rules. The `JobSettings` parameter configures task settings, including column mapping and scheduling.
531
+ * - You must purchase DataWorks Basic Edition or a higher edition to use this feature.
532
+ * - This operation creates a data integration synchronization task. Parameters include the source configuration SourceDataSourceSettings and the destination configuration DestinationDataSourceSettings, the supported synchronization type MigrationType, transformation rules defined through TransformationRules for mapping operations such as adding columns and renaming tables, specific tables to synchronize and the mapping rules to apply defined in TableMappings, and task-level settings such as column mappings and scheduling configurations defined in JobSettings.
531
533
  *
532
534
  * @param tmpReq - CreateDIJobRequest
533
535
  * @param runtime - runtime options for this request RuntimeOptions
@@ -535,11 +537,11 @@ export default class Client extends OpenApi {
535
537
  */
536
538
  createDIJobWithOptions(tmpReq: $_model.CreateDIJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDIJobResponse>;
537
539
  /**
538
- * Create a new version of a data integration task.
540
+ * Creates a data integration task.
539
541
  *
540
542
  * @remarks
541
- * - This API requires DataWorks Basic Edition or a higher edition.
542
- * - This API creates a data integration synchronization task. Key parameters include `SourceDataSourceSettings`, `DestinationDataSourceSettings`, and `MigrationType`. The `TransformationRules` parameter defines transformation rules for synchronized tables, such as adding columns or replacing table names. The `TableMappings` parameter specifies which tables to synchronize and their mapping rules. The `JobSettings` parameter configures task settings, including column mapping and scheduling.
543
+ * - You must purchase DataWorks Basic Edition or a higher edition to use this feature.
544
+ * - This operation creates a data integration synchronization task. Parameters include the source configuration SourceDataSourceSettings and the destination configuration DestinationDataSourceSettings, the supported synchronization type MigrationType, transformation rules defined through TransformationRules for mapping operations such as adding columns and renaming tables, specific tables to synchronize and the mapping rules to apply defined in TableMappings, and task-level settings such as column mappings and scheduling configurations defined in JobSettings.
543
545
  *
544
546
  * @param request - CreateDIJobRequest
545
547
  * @returns CreateDIJobResponse
@@ -567,10 +569,10 @@ export default class Client extends OpenApi {
567
569
  */
568
570
  createDataAssetTag(request: $_model.CreateDataAssetTagRequest): Promise<$_model.CreateDataAssetTagResponse>;
569
571
  /**
570
- * Creates a data quality monitoring alert rule in a project.
572
+ * Creates a data quality monitoring alert rule in a specified project.
571
573
  *
572
574
  * @remarks
573
- * DataWorks Basic Edition or a higher edition is required.
575
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
574
576
  *
575
577
  * @param tmpReq - CreateDataQualityAlertRuleRequest
576
578
  * @param runtime - runtime options for this request RuntimeOptions
@@ -578,10 +580,10 @@ export default class Client extends OpenApi {
578
580
  */
579
581
  createDataQualityAlertRuleWithOptions(tmpReq: $_model.CreateDataQualityAlertRuleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataQualityAlertRuleResponse>;
580
582
  /**
581
- * Creates a data quality monitoring alert rule in a project.
583
+ * Creates a data quality monitoring alert rule in a specified project.
582
584
  *
583
585
  * @remarks
584
- * DataWorks Basic Edition or a higher edition is required.
586
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
585
587
  *
586
588
  * @param request - CreateDataQualityAlertRuleRequest
587
589
  * @returns CreateDataQualityAlertRuleResponse
@@ -591,7 +593,7 @@ export default class Client extends OpenApi {
591
593
  * Creates a DataWorks data quality monitor.
592
594
  *
593
595
  * @remarks
594
- * DataWorks Basic Edition or higher is required.
596
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
595
597
  *
596
598
  * @deprecated OpenAPI CreateDataQualityEvaluationTask is deprecated, please use dataworks-public::2024-05-18::CreateDataQualityScan instead.
597
599
  *
@@ -604,7 +606,7 @@ export default class Client extends OpenApi {
604
606
  * Creates a DataWorks data quality monitor.
605
607
  *
606
608
  * @remarks
607
- * DataWorks Basic Edition or higher is required.
609
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
608
610
  *
609
611
  * @deprecated OpenAPI CreateDataQualityEvaluationTask is deprecated, please use dataworks-public::2024-05-18::CreateDataQualityScan instead.
610
612
  *
@@ -613,10 +615,10 @@ export default class Client extends OpenApi {
613
615
  */
614
616
  createDataQualityEvaluationTask(request: $_model.CreateDataQualityEvaluationTaskRequest): Promise<$_model.CreateDataQualityEvaluationTaskResponse>;
615
617
  /**
616
- * Creates a data quality evaluation task instance.
618
+ * Creates a data quality check task instance.
617
619
  *
618
620
  * @remarks
619
- * You must purchase DataWorks Basic Edition or higher to use this operation.
621
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
620
622
  *
621
623
  * @deprecated OpenAPI CreateDataQualityEvaluationTaskInstance is deprecated, please use dataworks-public::2024-05-18::CreateDataQualityScanRun instead.
622
624
  *
@@ -626,10 +628,10 @@ export default class Client extends OpenApi {
626
628
  */
627
629
  createDataQualityEvaluationTaskInstanceWithOptions(tmpReq: $_model.CreateDataQualityEvaluationTaskInstanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataQualityEvaluationTaskInstanceResponse>;
628
630
  /**
629
- * Creates a data quality evaluation task instance.
631
+ * Creates a data quality check task instance.
630
632
  *
631
633
  * @remarks
632
- * You must purchase DataWorks Basic Edition or higher to use this operation.
634
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
633
635
  *
634
636
  * @deprecated OpenAPI CreateDataQualityEvaluationTaskInstance is deprecated, please use dataworks-public::2024-05-18::CreateDataQualityScanRun instead.
635
637
  *
@@ -666,7 +668,7 @@ export default class Client extends OpenApi {
666
668
  * Creates a rule template.
667
669
  *
668
670
  * @remarks
669
- * You must purchase DataWorks Basic Edition or above to use this feature.
671
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
670
672
  *
671
673
  * @deprecated OpenAPI CreateDataQualityRuleTemplate is deprecated, please use dataworks-public::2024-05-18::CreateDataQualityTemplate instead.
672
674
  *
@@ -679,7 +681,7 @@ export default class Client extends OpenApi {
679
681
  * Creates a rule template.
680
682
  *
681
683
  * @remarks
682
- * You must purchase DataWorks Basic Edition or above to use this feature.
684
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
683
685
  *
684
686
  * @deprecated OpenAPI CreateDataQualityRuleTemplate is deprecated, please use dataworks-public::2024-05-18::CreateDataQualityTemplate instead.
685
687
  *
@@ -709,10 +711,10 @@ export default class Client extends OpenApi {
709
711
  */
710
712
  createDataQualityScan(request: $_model.CreateDataQualityScanRequest): Promise<$_model.CreateDataQualityScanResponse>;
711
713
  /**
712
- * Triggers the specified data quality scan and returns the run ID.
714
+ * Triggers the execution of a specified data quality monitoring task and returns the run instance ID.
713
715
  *
714
716
  * @remarks
715
- * This operation is available only in DataWorks Basic Edition and later versions.
717
+ * DataWorks Basic Edition or a higher edition is required.
716
718
  *
717
719
  * @param tmpReq - CreateDataQualityScanRunRequest
718
720
  * @param runtime - runtime options for this request RuntimeOptions
@@ -720,10 +722,10 @@ export default class Client extends OpenApi {
720
722
  */
721
723
  createDataQualityScanRunWithOptions(tmpReq: $_model.CreateDataQualityScanRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataQualityScanRunResponse>;
722
724
  /**
723
- * Triggers the specified data quality scan and returns the run ID.
725
+ * Triggers the execution of a specified data quality monitoring task and returns the run instance ID.
724
726
  *
725
727
  * @remarks
726
- * This operation is available only in DataWorks Basic Edition and later versions.
728
+ * DataWorks Basic Edition or a higher edition is required.
727
729
  *
728
730
  * @param request - CreateDataQualityScanRunRequest
729
731
  * @returns CreateDataQualityScanRunResponse
@@ -751,7 +753,12 @@ export default class Client extends OpenApi {
751
753
  */
752
754
  createDataQualityTemplate(request: $_model.CreateDataQualityTemplateRequest): Promise<$_model.CreateDataQualityTemplateResponse>;
753
755
  /**
754
- * Adds a data source to the development environment or production environment of a workspace.
756
+ * Creates a data source in a specified project workspace for the development or production environment.
757
+ *
758
+ * @remarks
759
+ * 1. You must have purchased DataWorks Basic Edition or a higher edition.
760
+ * 2. You must have at least one of the following roles in the DataWorks project workspace:
761
+ * - Tenant Owner, Storage Management Administrator, Project Owner, or O&M
755
762
  *
756
763
  * @param request - CreateDataSourceRequest
757
764
  * @param runtime - runtime options for this request RuntimeOptions
@@ -759,7 +766,12 @@ export default class Client extends OpenApi {
759
766
  */
760
767
  createDataSourceWithOptions(request: $_model.CreateDataSourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDataSourceResponse>;
761
768
  /**
762
- * Adds a data source to the development environment or production environment of a workspace.
769
+ * Creates a data source in a specified project workspace for the development or production environment.
770
+ *
771
+ * @remarks
772
+ * 1. You must have purchased DataWorks Basic Edition or a higher edition.
773
+ * 2. You must have at least one of the following roles in the DataWorks project workspace:
774
+ * - Tenant Owner, Storage Management Administrator, Project Owner, or O&M
763
775
  *
764
776
  * @param request - CreateDataSourceRequest
765
777
  * @returns CreateDataSourceResponse
@@ -791,7 +803,7 @@ export default class Client extends OpenApi {
791
803
  */
792
804
  createDataSourceSharedRule(request: $_model.CreateDataSourceSharedRuleRequest): Promise<$_model.CreateDataSourceSharedRuleResponse>;
793
805
  /**
794
- * Creates a dataset. This operation is supported only in workspaces that the user has joined. Currently, only DataWorks datasets are supported. The maximum number of datasets allowed per tenant is 2,000.
806
+ * Creates a dataset. You can create a dataset only in a workspace that you have joined. Only DataWorks datasets are supported. The maximum number of datasets per tenant is 2000.
795
807
  *
796
808
  * @param tmpReq - CreateDatasetRequest
797
809
  * @param runtime - runtime options for this request RuntimeOptions
@@ -799,14 +811,14 @@ export default class Client extends OpenApi {
799
811
  */
800
812
  createDatasetWithOptions(tmpReq: $_model.CreateDatasetRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDatasetResponse>;
801
813
  /**
802
- * Creates a dataset. This operation is supported only in workspaces that the user has joined. Currently, only DataWorks datasets are supported. The maximum number of datasets allowed per tenant is 2,000.
814
+ * Creates a dataset. You can create a dataset only in a workspace that you have joined. Only DataWorks datasets are supported. The maximum number of datasets per tenant is 2000.
803
815
  *
804
816
  * @param request - CreateDatasetRequest
805
817
  * @returns CreateDatasetResponse
806
818
  */
807
819
  createDataset(request: $_model.CreateDatasetRequest): Promise<$_model.CreateDatasetResponse>;
808
820
  /**
809
- * Creates a dataset version. Currently supports DataWorks datasets only, with a maximum of 20 versions.
821
+ * Creates a dataset version. Currently, only DataWorks datasets are supported. The maximum number of versions is 20.
810
822
  *
811
823
  * @param tmpReq - CreateDatasetVersionRequest
812
824
  * @param runtime - runtime options for this request RuntimeOptions
@@ -814,7 +826,7 @@ export default class Client extends OpenApi {
814
826
  */
815
827
  createDatasetVersionWithOptions(tmpReq: $_model.CreateDatasetVersionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateDatasetVersionResponse>;
816
828
  /**
817
- * Creates a dataset version. Currently supports DataWorks datasets only, with a maximum of 20 versions.
829
+ * Creates a dataset version. Currently, only DataWorks datasets are supported. The maximum number of versions is 20.
818
830
  *
819
831
  * @param request - CreateDatasetVersionRequest
820
832
  * @returns CreateDatasetVersionResponse
@@ -851,11 +863,10 @@ export default class Client extends OpenApi {
851
863
  */
852
864
  createFolder(request: $_model.CreateFolderRequest): Promise<$_model.CreateFolderResponse>;
853
865
  /**
854
- * Creates a user-defined function (UDF) in DataStudio. The information about the UDF is described by using FlowSpec.
866
+ * Creates a UDF function in DataStudio. The UDF function information is described in FlowSpec format.
855
867
  *
856
868
  * @remarks
857
- * >Notice:
858
- * This API does not support batch operations. If you define more than one UDF in the FlowSpec, all UDFs except the first one are ignored.
869
+ * >Notice: This operation does not support batch operations. If more than one UDF function is defined in the FlowSpec, all functions after the first one are ignored.
859
870
  *
860
871
  * @param request - CreateFunctionRequest
861
872
  * @param runtime - runtime options for this request RuntimeOptions
@@ -863,11 +874,10 @@ export default class Client extends OpenApi {
863
874
  */
864
875
  createFunctionWithOptions(request: $_model.CreateFunctionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateFunctionResponse>;
865
876
  /**
866
- * Creates a user-defined function (UDF) in DataStudio. The information about the UDF is described by using FlowSpec.
877
+ * Creates a UDF function in DataStudio. The UDF function information is described in FlowSpec format.
867
878
  *
868
879
  * @remarks
869
- * >Notice:
870
- * This API does not support batch operations. If you define more than one UDF in the FlowSpec, all UDFs except the first one are ignored.
880
+ * >Notice: This operation does not support batch operations. If more than one UDF function is defined in the FlowSpec, all functions after the first one are ignored.
871
881
  *
872
882
  * @param request - CreateFunctionRequest
873
883
  * @returns CreateFunctionResponse
@@ -921,11 +931,11 @@ export default class Client extends OpenApi {
921
931
  * Creates an MCP Server.
922
932
  *
923
933
  * @remarks
924
- * ## Usage notes
925
- * - When you submit a request, the system verifies the availability of the MCP Server based on the connection configuration.
926
- * - If the MCP Server connection is unavailable, the API returns an error message.
927
- * - The `Name` must be unique at the tenant level, start with a lowercase letter, and contain only lowercase letters, digits, underscores (_), and hyphens (-).
928
- * - The `Visibility` parameter specifies the visibility level of the MCP Server. Valid values are `TENANT` (visible within the tenant), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). You must also provide the `VisibilityScope` parameter to define the scope based on the selected visibility level.
934
+ * ## Operation description
935
+ * - After submission, the system verifies the availability of the MCP Server based on the provided connection information.
936
+ * - If the MCP Server connection is unavailable, the operation returns the corresponding error message.
937
+ * - The Name field must start with a lowercase letter and can contain only lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the current account.
938
+ * - The Visibility field defines the visibility level of the MCP Server. Valid values: `TENANT` (visible within the account), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). Depending on the selected value, provide the corresponding `VisibilityScope` parameter to further specify the visibility scope.
929
939
  *
930
940
  * @param tmpReq - CreateMcpServerRequest
931
941
  * @param runtime - runtime options for this request RuntimeOptions
@@ -936,11 +946,11 @@ export default class Client extends OpenApi {
936
946
  * Creates an MCP Server.
937
947
  *
938
948
  * @remarks
939
- * ## Usage notes
940
- * - When you submit a request, the system verifies the availability of the MCP Server based on the connection configuration.
941
- * - If the MCP Server connection is unavailable, the API returns an error message.
942
- * - The `Name` must be unique at the tenant level, start with a lowercase letter, and contain only lowercase letters, digits, underscores (_), and hyphens (-).
943
- * - The `Visibility` parameter specifies the visibility level of the MCP Server. Valid values are `TENANT` (visible within the tenant), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). You must also provide the `VisibilityScope` parameter to define the scope based on the selected visibility level.
949
+ * ## Operation description
950
+ * - After submission, the system verifies the availability of the MCP Server based on the provided connection information.
951
+ * - If the MCP Server connection is unavailable, the operation returns the corresponding error message.
952
+ * - The Name field must start with a lowercase letter and can contain only lowercase letters, digits, underscores (_), and hyphens (-). The name must be unique within the current account.
953
+ * - The Visibility field defines the visibility level of the MCP Server. Valid values: `TENANT` (visible within the account), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). Depending on the selected value, provide the corresponding `VisibilityScope` parameter to further specify the visibility scope.
944
954
  *
945
955
  * @param request - CreateMcpServerRequest
946
956
  * @returns CreateMcpServerResponse
@@ -1010,11 +1020,10 @@ export default class Client extends OpenApi {
1010
1020
  */
1011
1021
  createNetwork(request: $_model.CreateNetworkRequest): Promise<$_model.CreateNetworkResponse>;
1012
1022
  /**
1013
- * Creates a node in DataStudio. The information about the node is described by using FlowSpec.
1023
+ * Creates a data development node in the new version of DataStudio.
1014
1024
  *
1015
1025
  * @remarks
1016
- * >Notice:
1017
- * This API does not support batch operations. If you define more than one node in the FlowSpec, all nodes except the first one are ignored.
1026
+ * >Notice: This operation does not support batch operations. If more than one node is defined in FlowSpec, all nodes after the first one are ignored.
1018
1027
  *
1019
1028
  * @param request - CreateNodeRequest
1020
1029
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1022,11 +1031,10 @@ export default class Client extends OpenApi {
1022
1031
  */
1023
1032
  createNodeWithOptions(request: $_model.CreateNodeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateNodeResponse>;
1024
1033
  /**
1025
- * Creates a node in DataStudio. The information about the node is described by using FlowSpec.
1034
+ * Creates a data development node in the new version of DataStudio.
1026
1035
  *
1027
1036
  * @remarks
1028
- * >Notice:
1029
- * This API does not support batch operations. If you define more than one node in the FlowSpec, all nodes except the first one are ignored.
1037
+ * >Notice: This operation does not support batch operations. If more than one node is defined in FlowSpec, all nodes after the first one are ignored.
1030
1038
  *
1031
1039
  * @param request - CreateNodeRequest
1032
1040
  * @returns CreateNodeResponse
@@ -1112,6 +1120,9 @@ export default class Client extends OpenApi {
1112
1120
  /**
1113
1121
  * Creates a workspace.
1114
1122
  *
1123
+ * @remarks
1124
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
1125
+ *
1115
1126
  * @param tmpReq - CreateProjectRequest
1116
1127
  * @param runtime - runtime options for this request RuntimeOptions
1117
1128
  * @returns CreateProjectResponse
@@ -1120,15 +1131,18 @@ export default class Client extends OpenApi {
1120
1131
  /**
1121
1132
  * Creates a workspace.
1122
1133
  *
1134
+ * @remarks
1135
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
1136
+ *
1123
1137
  * @param request - CreateProjectRequest
1124
1138
  * @returns CreateProjectResponse
1125
1139
  */
1126
1140
  createProject(request: $_model.CreateProjectRequest): Promise<$_model.CreateProjectResponse>;
1127
1141
  /**
1128
- * Adds a workspace member and assigns a workspace-level role to the member.
1142
+ * Adds a workspace member and grants workspace roles to the member.
1129
1143
  *
1130
1144
  * @remarks
1131
- * This API operation is available for all DataWorks editions.
1145
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
1132
1146
  *
1133
1147
  * @param tmpReq - CreateProjectMemberRequest
1134
1148
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1136,10 +1150,10 @@ export default class Client extends OpenApi {
1136
1150
  */
1137
1151
  createProjectMemberWithOptions(tmpReq: $_model.CreateProjectMemberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateProjectMemberResponse>;
1138
1152
  /**
1139
- * Adds a workspace member and assigns a workspace-level role to the member.
1153
+ * Adds a workspace member and grants workspace roles to the member.
1140
1154
  *
1141
1155
  * @remarks
1142
- * This API operation is available for all DataWorks editions.
1156
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
1143
1157
  *
1144
1158
  * @param request - CreateProjectMemberRequest
1145
1159
  * @returns CreateProjectMemberResponse
@@ -1161,11 +1175,10 @@ export default class Client extends OpenApi {
1161
1175
  */
1162
1176
  createProjectRole(request: $_model.CreateProjectRoleRequest): Promise<$_model.CreateProjectRoleResponse>;
1163
1177
  /**
1164
- * \\\\> You cannot use this API operation to create multiple file resources at a time. If you specify multiple file resources by using FlowSpec, the system creates only the first specified resource.
1178
+ * Creates a file resource for data development. The file resource information is defined in FlowSpec format.
1165
1179
  *
1166
1180
  * @remarks
1167
- * >Notice:
1168
- * This API does not support batch operations. If you define more than one resource file in the FlowSpec, all resource files except the first one are ignored.
1181
+ * >Notice: This operation does not support batch operations. If more than one resource file is defined in the FlowSpec, all resource files after the first one are ignored.
1169
1182
  *
1170
1183
  * @param request - CreateResourceRequest
1171
1184
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1173,11 +1186,10 @@ export default class Client extends OpenApi {
1173
1186
  */
1174
1187
  createResourceWithOptions(request: $_model.CreateResourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateResourceResponse>;
1175
1188
  /**
1176
- * \\\\> You cannot use this API operation to create multiple file resources at a time. If you specify multiple file resources by using FlowSpec, the system creates only the first specified resource.
1189
+ * Creates a file resource for data development. The file resource information is defined in FlowSpec format.
1177
1190
  *
1178
1191
  * @remarks
1179
- * >Notice:
1180
- * This API does not support batch operations. If you define more than one resource file in the FlowSpec, all resource files except the first one are ignored.
1192
+ * >Notice: This operation does not support batch operations. If more than one resource file is defined in the FlowSpec, all resource files after the first one are ignored.
1181
1193
  *
1182
1194
  * @param request - CreateResourceRequest
1183
1195
  * @returns CreateResourceResponse
@@ -1204,9 +1216,9 @@ export default class Client extends OpenApi {
1204
1216
  * Creates a resource group.
1205
1217
  *
1206
1218
  * @remarks
1207
- * 1. You must purchase DataWorks Basic Edition or higher to use this operation.
1208
- * 2. **Before you call this operation, make sure that you understand how general-purpose resource groups in DataWorks are billed and review the [pricing](https://help.aliyun.com/document_detail/2680173.html).**
1209
- * 3. **Before you call this operation, make sure that you have created the AliyunServiceRoleForDataWorks service-linked role.**
1219
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
1220
+ * 2. **Before you call this operation, make sure that you fully understand the billing of DataWorks common resource groups and the [pricing](https://help.aliyun.com/document_detail/2680173.html).**
1221
+ * 3. **Before you call this operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**
1210
1222
  *
1211
1223
  * @param tmpReq - CreateResourceGroupRequest
1212
1224
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1217,9 +1229,9 @@ export default class Client extends OpenApi {
1217
1229
  * Creates a resource group.
1218
1230
  *
1219
1231
  * @remarks
1220
- * 1. You must purchase DataWorks Basic Edition or higher to use this operation.
1221
- * 2. **Before you call this operation, make sure that you understand how general-purpose resource groups in DataWorks are billed and review the [pricing](https://help.aliyun.com/document_detail/2680173.html).**
1222
- * 3. **Before you call this operation, make sure that you have created the AliyunServiceRoleForDataWorks service-linked role.**
1232
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
1233
+ * 2. **Before you call this operation, make sure that you fully understand the billing of DataWorks common resource groups and the [pricing](https://help.aliyun.com/document_detail/2680173.html).**
1234
+ * 3. **Before you call this operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**
1223
1235
  *
1224
1236
  * @param request - CreateResourceGroupRequest
1225
1237
  * @returns CreateResourceGroupResponse
@@ -1357,11 +1369,10 @@ export default class Client extends OpenApi {
1357
1369
  */
1358
1370
  createUdfFile(request: $_model.CreateUdfFileRequest): Promise<$_model.CreateUdfFileResponse>;
1359
1371
  /**
1360
- * Creates a workflow in a directory of DataStudio.
1372
+ * Creates a workflow in a specified folder in DataStudio.
1361
1373
  *
1362
1374
  * @remarks
1363
- * >Notice:
1364
- * This API does not support batch operations. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored. In addition, nodes defined within the workflow definition are also ignored. Call the CreateNode API to create internal nodes one by one.
1375
+ * >Notice: This operation does not support batch operations. If more than one workflow is defined in FlowSpec, all workflows except the first one are ignored. In addition, nodes defined within the workflow are also ignored. Call the CreateNode operation to create internal nodes one by one.
1365
1376
  *
1366
1377
  * @param request - CreateWorkflowDefinitionRequest
1367
1378
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1369,11 +1380,10 @@ export default class Client extends OpenApi {
1369
1380
  */
1370
1381
  createWorkflowDefinitionWithOptions(request: $_model.CreateWorkflowDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateWorkflowDefinitionResponse>;
1371
1382
  /**
1372
- * Creates a workflow in a directory of DataStudio.
1383
+ * Creates a workflow in a specified folder in DataStudio.
1373
1384
  *
1374
1385
  * @remarks
1375
- * >Notice:
1376
- * This API does not support batch operations. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored. In addition, nodes defined within the workflow definition are also ignored. Call the CreateNode API to create internal nodes one by one.
1386
+ * >Notice: This operation does not support batch operations. If more than one workflow is defined in FlowSpec, all workflows except the first one are ignored. In addition, nodes defined within the workflow are also ignored. Call the CreateNode operation to create internal nodes one by one.
1377
1387
  *
1378
1388
  * @param request - CreateWorkflowDefinitionRequest
1379
1389
  * @returns CreateWorkflowDefinitionResponse
@@ -1457,8 +1467,8 @@ export default class Client extends OpenApi {
1457
1467
  * Deletes a certificate file.
1458
1468
  *
1459
1469
  * @remarks
1460
- * 1. This operation requires DataWorks Basic Edition or a later version.
1461
- * 2. This operation requires one of the following roles in the DataWorks workspace: Tenant Owner, Workspace Administrator, Project Owner, or O\\&M.
1470
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
1471
+ * 2. You must have at least one of the following roles in the DataWorks workspace: tenant owner, storage management administrator, project owner, or O&M engineer.
1462
1472
  *
1463
1473
  * @param request - DeleteCertificateRequest
1464
1474
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1469,8 +1479,8 @@ export default class Client extends OpenApi {
1469
1479
  * Deletes a certificate file.
1470
1480
  *
1471
1481
  * @remarks
1472
- * 1. This operation requires DataWorks Basic Edition or a later version.
1473
- * 2. This operation requires one of the following roles in the DataWorks workspace: Tenant Owner, Workspace Administrator, Project Owner, or O\\&M.
1482
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
1483
+ * 2. You must have at least one of the following roles in the DataWorks workspace: tenant owner, storage management administrator, project owner, or O&M engineer.
1474
1484
  *
1475
1485
  * @param request - DeleteCertificateRequest
1476
1486
  * @returns DeleteCertificateResponse
@@ -1480,8 +1490,7 @@ export default class Client extends OpenApi {
1480
1490
  * Deletes a component.
1481
1491
  *
1482
1492
  * @remarks
1483
- * >Notice:
1484
- * After a UDF is published, it cannot be deleted. You must unpublish the UDF before you can delete it.
1493
+ * >Notice: After a UDF function is published, it cannot be deleted. You must offline the function before deleting it.
1485
1494
  *
1486
1495
  * @param request - DeleteComponentRequest
1487
1496
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1492,8 +1501,7 @@ export default class Client extends OpenApi {
1492
1501
  * Deletes a component.
1493
1502
  *
1494
1503
  * @remarks
1495
- * >Notice:
1496
- * After a UDF is published, it cannot be deleted. You must unpublish the UDF before you can delete it.
1504
+ * >Notice: After a UDF function is published, it cannot be deleted. You must offline the function before deleting it.
1497
1505
  *
1498
1506
  * @param request - DeleteComponentRequest
1499
1507
  * @returns DeleteComponentResponse
@@ -1525,18 +1533,18 @@ export default class Client extends OpenApi {
1525
1533
  */
1526
1534
  deleteComputeResource(request: $_model.DeleteComputeResourceRequest): Promise<$_model.DeleteComputeResourceResponse>;
1527
1535
  /**
1528
- * 删除元数据采集器
1536
+ * Deletes a specified metadata crawler.
1529
1537
  *
1530
1538
  * @remarks
1531
- * ## 使用场景
1532
- * 删除不再使用的元数据采集器。
1533
- * ## 推荐流程
1534
- * 1. 调用 `ListCrawlers` 查询采集器 ID。
1535
- * 2. 确认采集器不再需要后调用本接口。
1536
- * ## 版本要求
1537
- * 需要购买DataWorks基础版及以上版本才能使用。
1538
- * ## 注意事项
1539
- * 删除成功后,该采集器不能继续查询、更新或运行。已采集元数据由系统清理,清理结果可能存在延迟。
1539
+ * ## Scenarios
1540
+ * Delete metadata crawlers that are no longer in use.
1541
+ * ## Recommended procedure
1542
+ * 1. Call `ListCrawlers` to query the crawler ID.
1543
+ * 2. After confirming that the crawler is no longer needed, call this operation.
1544
+ * ## Edition requirements
1545
+ * DataWorks Basic Edition or higher is required.
1546
+ * ## Precautions
1547
+ * After the crawler is deleted, it cannot be queried, updated, or run. The collected metadata is cleaned up by the system, and the cleanup result may be delayed.
1540
1548
  *
1541
1549
  * @param request - DeleteCrawlerRequest
1542
1550
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1544,18 +1552,18 @@ export default class Client extends OpenApi {
1544
1552
  */
1545
1553
  deleteCrawlerWithOptions(request: $_model.DeleteCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCrawlerResponse>;
1546
1554
  /**
1547
- * 删除元数据采集器
1555
+ * Deletes a specified metadata crawler.
1548
1556
  *
1549
1557
  * @remarks
1550
- * ## 使用场景
1551
- * 删除不再使用的元数据采集器。
1552
- * ## 推荐流程
1553
- * 1. 调用 `ListCrawlers` 查询采集器 ID。
1554
- * 2. 确认采集器不再需要后调用本接口。
1555
- * ## 版本要求
1556
- * 需要购买DataWorks基础版及以上版本才能使用。
1557
- * ## 注意事项
1558
- * 删除成功后,该采集器不能继续查询、更新或运行。已采集元数据由系统清理,清理结果可能存在延迟。
1558
+ * ## Scenarios
1559
+ * Delete metadata crawlers that are no longer in use.
1560
+ * ## Recommended procedure
1561
+ * 1. Call `ListCrawlers` to query the crawler ID.
1562
+ * 2. After confirming that the crawler is no longer needed, call this operation.
1563
+ * ## Edition requirements
1564
+ * DataWorks Basic Edition or higher is required.
1565
+ * ## Precautions
1566
+ * After the crawler is deleted, it cannot be queried, updated, or run. The collected metadata is cleaned up by the system, and the cleanup result may be delayed.
1559
1567
  *
1560
1568
  * @param request - DeleteCrawlerRequest
1561
1569
  * @returns DeleteCrawlerResponse
@@ -1634,10 +1642,10 @@ export default class Client extends OpenApi {
1634
1642
  */
1635
1643
  deleteDataAssetTag(request: $_model.DeleteDataAssetTagRequest): Promise<$_model.DeleteDataAssetTagResponse>;
1636
1644
  /**
1637
- * Deletes a data quality alert rule by ID.
1645
+ * Deletes a data quality monitoring alert rule based on the specified ID.
1638
1646
  *
1639
1647
  * @remarks
1640
- * DataWorks Basic Edition or a higher edition is required.
1648
+ * DataWorks Basic Edition or a more advanced edition is required.
1641
1649
  *
1642
1650
  * @param request - DeleteDataQualityAlertRuleRequest
1643
1651
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1645,10 +1653,10 @@ export default class Client extends OpenApi {
1645
1653
  */
1646
1654
  deleteDataQualityAlertRuleWithOptions(request: $_model.DeleteDataQualityAlertRuleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDataQualityAlertRuleResponse>;
1647
1655
  /**
1648
- * Deletes a data quality alert rule by ID.
1656
+ * Deletes a data quality monitoring alert rule based on the specified ID.
1649
1657
  *
1650
1658
  * @remarks
1651
- * DataWorks Basic Edition or a higher edition is required.
1659
+ * DataWorks Basic Edition or a more advanced edition is required.
1652
1660
  *
1653
1661
  * @param request - DeleteDataQualityAlertRuleRequest
1654
1662
  * @returns DeleteDataQualityAlertRuleResponse
@@ -1682,6 +1690,9 @@ export default class Client extends OpenApi {
1682
1690
  /**
1683
1691
  * Deletes a data quality monitoring rule.
1684
1692
  *
1693
+ * @remarks
1694
+ * 需要购买DataWorks基础版及以上版本才能使用
1695
+ *
1685
1696
  * @param request - DeleteDataQualityRuleRequest
1686
1697
  * @param runtime - runtime options for this request RuntimeOptions
1687
1698
  * @returns DeleteDataQualityRuleResponse
@@ -1690,6 +1701,9 @@ export default class Client extends OpenApi {
1690
1701
  /**
1691
1702
  * Deletes a data quality monitoring rule.
1692
1703
  *
1704
+ * @remarks
1705
+ * 需要购买DataWorks基础版及以上版本才能使用
1706
+ *
1693
1707
  * @param request - DeleteDataQualityRuleRequest
1694
1708
  * @returns DeleteDataQualityRuleResponse
1695
1709
  */
@@ -1818,7 +1832,7 @@ export default class Client extends OpenApi {
1818
1832
  */
1819
1833
  deleteDataSourceSharedRule(request: $_model.DeleteDataSourceSharedRuleRequest): Promise<$_model.DeleteDataSourceSharedRuleResponse>;
1820
1834
  /**
1821
- * Delete a dataset. Only DataWorks datasets are supported. This operation cascades to delete all associated dataset versions. Requires dataset creator or workspace administrator permissions.
1835
+ * Deletes a dataset. Only DataWorks datasets are supported. The corresponding dataset versions are cascade deleted. The operator must be the creator of the dataset or an administrator of the workspace to which the dataset belongs.
1822
1836
  *
1823
1837
  * @param request - DeleteDatasetRequest
1824
1838
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1826,7 +1840,7 @@ export default class Client extends OpenApi {
1826
1840
  */
1827
1841
  deleteDatasetWithOptions(request: $_model.DeleteDatasetRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteDatasetResponse>;
1828
1842
  /**
1829
- * Delete a dataset. Only DataWorks datasets are supported. This operation cascades to delete all associated dataset versions. Requires dataset creator or workspace administrator permissions.
1843
+ * Deletes a dataset. Only DataWorks datasets are supported. The corresponding dataset versions are cascade deleted. The operator must be the creator of the dataset or an administrator of the workspace to which the dataset belongs.
1830
1844
  *
1831
1845
  * @param request - DeleteDatasetRequest
1832
1846
  * @returns DeleteDatasetResponse
@@ -1995,10 +2009,10 @@ export default class Client extends OpenApi {
1995
2009
  */
1996
2010
  deleteMetaEntityDef(request: $_model.DeleteMetaEntityDefRequest): Promise<$_model.DeleteMetaEntityDefResponse>;
1997
2011
  /**
1998
- * Disassociates and deletes a network from a general resource group.
2012
+ * Disassociates and deletes a network resource from a general-purpose resource group.
1999
2013
  *
2000
2014
  * @remarks
2001
- * This API operation is available for all DataWorks editions.
2015
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
2002
2016
  *
2003
2017
  * @param request - DeleteNetworkRequest
2004
2018
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2006,10 +2020,10 @@ export default class Client extends OpenApi {
2006
2020
  */
2007
2021
  deleteNetworkWithOptions(request: $_model.DeleteNetworkRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteNetworkResponse>;
2008
2022
  /**
2009
- * Disassociates and deletes a network from a general resource group.
2023
+ * Disassociates and deletes a network resource from a general-purpose resource group.
2010
2024
  *
2011
2025
  * @remarks
2012
- * This API operation is available for all DataWorks editions.
2026
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
2013
2027
  *
2014
2028
  * @param request - DeleteNetworkRequest
2015
2029
  * @returns DeleteNetworkResponse
@@ -2110,10 +2124,10 @@ export default class Client extends OpenApi {
2110
2124
  */
2111
2125
  deleteProject(request: $_model.DeleteProjectRequest): Promise<$_model.DeleteProjectResponse>;
2112
2126
  /**
2113
- * Removes a workspace member and the workspace-level roles that are assigned to the member.
2127
+ * Removes a workspace member and the workspace roles granted to the member.
2114
2128
  *
2115
2129
  * @remarks
2116
- * This API operation is available for all DataWorks editions.
2130
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
2117
2131
  *
2118
2132
  * @param request - DeleteProjectMemberRequest
2119
2133
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2121,10 +2135,10 @@ export default class Client extends OpenApi {
2121
2135
  */
2122
2136
  deleteProjectMemberWithOptions(request: $_model.DeleteProjectMemberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteProjectMemberResponse>;
2123
2137
  /**
2124
- * Removes a workspace member and the workspace-level roles that are assigned to the member.
2138
+ * Removes a workspace member and the workspace roles granted to the member.
2125
2139
  *
2126
2140
  * @remarks
2127
- * This API operation is available for all DataWorks editions.
2141
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
2128
2142
  *
2129
2143
  * @param request - DeleteProjectMemberRequest
2130
2144
  * @returns DeleteProjectMemberResponse
@@ -2346,11 +2360,10 @@ export default class Client extends OpenApi {
2346
2360
  */
2347
2361
  deleteWorkflow(request: $_model.DeleteWorkflowRequest): Promise<$_model.DeleteWorkflowResponse>;
2348
2362
  /**
2349
- * Deletes a workflow from DataStudio.
2363
+ * Deletes a specified workflow in data development.
2350
2364
  *
2351
2365
  * @remarks
2352
- * >Notice:
2353
- * After a workflow definition is published, it cannot be deleted. You must unpublish the workflow definition before you can delete it.
2366
+ * >Notice: After a workflow is published, it cannot be deleted. You must offline the workflow before deleting it.
2354
2367
  *
2355
2368
  * @param request - DeleteWorkflowDefinitionRequest
2356
2369
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2358,18 +2371,17 @@ export default class Client extends OpenApi {
2358
2371
  */
2359
2372
  deleteWorkflowDefinitionWithOptions(request: $_model.DeleteWorkflowDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteWorkflowDefinitionResponse>;
2360
2373
  /**
2361
- * Deletes a workflow from DataStudio.
2374
+ * Deletes a specified workflow in data development.
2362
2375
  *
2363
2376
  * @remarks
2364
- * >Notice:
2365
- * After a workflow definition is published, it cannot be deleted. You must unpublish the workflow definition before you can delete it.
2377
+ * >Notice: After a workflow is published, it cannot be deleted. You must offline the workflow before deleting it.
2366
2378
  *
2367
2379
  * @param request - DeleteWorkflowDefinitionRequest
2368
2380
  * @returns DeleteWorkflowDefinitionResponse
2369
2381
  */
2370
2382
  deleteWorkflowDefinition(request: $_model.DeleteWorkflowDefinitionRequest): Promise<$_model.DeleteWorkflowDefinitionResponse>;
2371
2383
  /**
2372
- * Publish a file to the production environment.
2384
+ * Deploys a file to the production environment.
2373
2385
  *
2374
2386
  * @param request - DeployFileRequest
2375
2387
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2377,7 +2389,7 @@ export default class Client extends OpenApi {
2377
2389
  */
2378
2390
  deployFileWithOptions(request: $_model.DeployFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeployFileResponse>;
2379
2391
  /**
2380
- * Publish a file to the production environment.
2392
+ * Deploys a file to the production environment.
2381
2393
  *
2382
2394
  * @param request - DeployFileRequest
2383
2395
  * @returns DeployFileResponse
@@ -2557,11 +2569,12 @@ export default class Client extends OpenApi {
2557
2569
  */
2558
2570
  establishRelationTableToBusiness(request: $_model.EstablishRelationTableToBusinessRequest): Promise<$_model.EstablishRelationTableToBusinessResponse>;
2559
2571
  /**
2560
- * Executes a stage in a process.
2572
+ * Executes a specified stage of a publish flow.
2561
2573
  *
2562
2574
  * @remarks
2563
- * > The stages in a process are sequential. For more information, see the GetDeployment operation. Skipping or repeating a stage is not allowed.
2564
- * > The execution of a stage is asynchronous. The response of this operation indicates only whether a stage is triggered but does not indicate whether the execution of the stage is successful. You can call the GetDeployment operation to check whether the execution is successful.
2575
+ * >Notice: The stages of a publish flow are sequential. For more information, see the response of GetPipelineRun. You cannot skip or repeat a stage.
2576
+ * >Notice: The execution is asynchronous. The response only indicates that the stage is triggered, not that the stage is executed. Check the response of GetPipelineRun for the execution result.
2577
+ * >Notice: This operation may not be available in earlier SDK versions. In this case, use the ExecDeploymentStage operation. The parameters are the same as those described in this document.
2565
2578
  *
2566
2579
  * @param request - ExecPipelineRunStageRequest
2567
2580
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2569,21 +2582,22 @@ export default class Client extends OpenApi {
2569
2582
  */
2570
2583
  execPipelineRunStageWithOptions(request: $_model.ExecPipelineRunStageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ExecPipelineRunStageResponse>;
2571
2584
  /**
2572
- * Executes a stage in a process.
2585
+ * Executes a specified stage of a publish flow.
2573
2586
  *
2574
2587
  * @remarks
2575
- * > The stages in a process are sequential. For more information, see the GetDeployment operation. Skipping or repeating a stage is not allowed.
2576
- * > The execution of a stage is asynchronous. The response of this operation indicates only whether a stage is triggered but does not indicate whether the execution of the stage is successful. You can call the GetDeployment operation to check whether the execution is successful.
2588
+ * >Notice: The stages of a publish flow are sequential. For more information, see the response of GetPipelineRun. You cannot skip or repeat a stage.
2589
+ * >Notice: The execution is asynchronous. The response only indicates that the stage is triggered, not that the stage is executed. Check the response of GetPipelineRun for the execution result.
2590
+ * >Notice: This operation may not be available in earlier SDK versions. In this case, use the ExecDeploymentStage operation. The parameters are the same as those described in this document.
2577
2591
  *
2578
2592
  * @param request - ExecPipelineRunStageRequest
2579
2593
  * @returns ExecPipelineRunStageResponse
2580
2594
  */
2581
2595
  execPipelineRunStage(request: $_model.ExecPipelineRunStageRequest): Promise<$_model.ExecPipelineRunStageResponse>;
2582
2596
  /**
2583
- * Create a temporary workflow instance based on configurations.
2597
+ * Creates a temporary workflow instance based on the specified configuration.
2584
2598
  *
2585
2599
  * @remarks
2586
- * This API operation is available for all DataWorks editions.
2600
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
2587
2601
  *
2588
2602
  * @param tmpReq - ExecuteAdhocWorkflowInstanceRequest
2589
2603
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2591,10 +2605,10 @@ export default class Client extends OpenApi {
2591
2605
  */
2592
2606
  executeAdhocWorkflowInstanceWithOptions(tmpReq: $_model.ExecuteAdhocWorkflowInstanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ExecuteAdhocWorkflowInstanceResponse>;
2593
2607
  /**
2594
- * Create a temporary workflow instance based on configurations.
2608
+ * Creates a temporary workflow instance based on the specified configuration.
2595
2609
  *
2596
2610
  * @remarks
2597
- * This API operation is available for all DataWorks editions.
2611
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
2598
2612
  *
2599
2613
  * @param request - ExecuteAdhocWorkflowInstanceRequest
2600
2614
  * @returns ExecuteAdhocWorkflowInstanceResponse
@@ -2695,7 +2709,7 @@ export default class Client extends OpenApi {
2695
2709
  */
2696
2710
  getAgentSessionTokenUsage(request: $_model.GetAgentSessionTokenUsageRequest): Promise<$_model.GetAgentSessionTokenUsageResponse>;
2697
2711
  /**
2698
- * Queries a custom alert monitoring rule.
2712
+ * Retrieves a custom monitoring alert rule.
2699
2713
  *
2700
2714
  * @param request - GetAlertRuleRequest
2701
2715
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2703,7 +2717,7 @@ export default class Client extends OpenApi {
2703
2717
  */
2704
2718
  getAlertRuleWithOptions(request: $_model.GetAlertRuleRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetAlertRuleResponse>;
2705
2719
  /**
2706
- * Queries a custom alert monitoring rule.
2720
+ * Retrieves a custom monitoring alert rule.
2707
2721
  *
2708
2722
  * @param request - GetAlertRuleRequest
2709
2723
  * @returns GetAlertRuleResponse
@@ -2739,7 +2753,7 @@ export default class Client extends OpenApi {
2739
2753
  */
2740
2754
  getApplicationContents(request: $_model.GetApplicationContentsRequest): Promise<$_model.GetApplicationContentsResponse>;
2741
2755
  /**
2742
- * Queries the information about a workflow.
2756
+ * Queries the details of a business process by calling GetBusiness.
2743
2757
  *
2744
2758
  * @param request - GetBusinessRequest
2745
2759
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2747,17 +2761,17 @@ export default class Client extends OpenApi {
2747
2761
  */
2748
2762
  getBusinessWithOptions(request: $_model.GetBusinessRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetBusinessResponse>;
2749
2763
  /**
2750
- * Queries the information about a workflow.
2764
+ * Queries the details of a business process by calling GetBusiness.
2751
2765
  *
2752
2766
  * @param request - GetBusinessRequest
2753
2767
  * @returns GetBusinessResponse
2754
2768
  */
2755
2769
  getBusiness(request: $_model.GetBusinessRequest): Promise<$_model.GetBusinessResponse>;
2756
2770
  /**
2757
- * Queries the information about a catalog in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawlers are supported.
2771
+ * Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks catalog types are supported.
2758
2772
  *
2759
2773
  * @remarks
2760
- * 1. DataWorks Basic Edition or a higher edition is required.
2774
+ * 1. You must have DataWorks Basic Edition or a higher edition to use this feature.
2761
2775
  *
2762
2776
  * @param request - GetCatalogRequest
2763
2777
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2765,10 +2779,10 @@ export default class Client extends OpenApi {
2765
2779
  */
2766
2780
  getCatalogWithOptions(request: $_model.GetCatalogRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCatalogResponse>;
2767
2781
  /**
2768
- * Queries the information about a catalog in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawlers are supported.
2782
+ * Retrieves the details of a specified data catalog in DataWorks Data Map. Currently, DLF and StarRocks catalog types are supported.
2769
2783
  *
2770
2784
  * @remarks
2771
- * 1. DataWorks Basic Edition or a higher edition is required.
2785
+ * 1. You must have DataWorks Basic Edition or a higher edition to use this feature.
2772
2786
  *
2773
2787
  * @param request - GetCatalogRequest
2774
2788
  * @returns GetCatalogResponse
@@ -2865,19 +2879,19 @@ export default class Client extends OpenApi {
2865
2879
  */
2866
2880
  getComputeResource(request: $_model.GetComputeResourceRequest): Promise<$_model.GetComputeResourceResponse>;
2867
2881
  /**
2868
- * 获取元数据采集器详情
2882
+ * Queries the configuration, status, and latest run information of a specified metadata crawler.
2869
2883
  *
2870
2884
  * @remarks
2871
- * ## 使用场景
2872
- * 查询指定元数据采集器的配置、可用状态和最近一次运行信息。
2873
- * ## 推荐流程
2874
- * 1. 调用 `ListCrawlers` 查询采集器 ID。
2875
- * 2. 调用本接口获取采集器详情。
2876
- * 3. 如需查询完整运行历史,调用 `ListCrawlerRuns`。
2877
- * ## 版本要求
2878
- * 需要购买DataWorks基础版及以上版本才能使用。
2879
- * ## 注意事项
2880
- * 采集器尚未运行时,最近运行状态和任务实例 ID 可能为空。
2885
+ * ## Scenarios
2886
+ * Queries the configuration, availability status, and latest run information of a specified metadata crawler.
2887
+ * ## Recommended workflow
2888
+ * 1. Call `ListCrawlers` to query crawler IDs.
2889
+ * 2. Call this operation to retrieve crawler details.
2890
+ * 3. To query the complete run history, call `ListCrawlerRuns`.
2891
+ * ## Edition requirements
2892
+ * DataWorks Basic Edition or higher is required.
2893
+ * ## Precautions
2894
+ * If the crawler has not been run, the latest run status and task instance ID may be empty.
2881
2895
  *
2882
2896
  * @param request - GetCrawlerRequest
2883
2897
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2885,37 +2899,37 @@ export default class Client extends OpenApi {
2885
2899
  */
2886
2900
  getCrawlerWithOptions(request: $_model.GetCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCrawlerResponse>;
2887
2901
  /**
2888
- * 获取元数据采集器详情
2902
+ * Queries the configuration, status, and latest run information of a specified metadata crawler.
2889
2903
  *
2890
2904
  * @remarks
2891
- * ## 使用场景
2892
- * 查询指定元数据采集器的配置、可用状态和最近一次运行信息。
2893
- * ## 推荐流程
2894
- * 1. 调用 `ListCrawlers` 查询采集器 ID。
2895
- * 2. 调用本接口获取采集器详情。
2896
- * 3. 如需查询完整运行历史,调用 `ListCrawlerRuns`。
2897
- * ## 版本要求
2898
- * 需要购买DataWorks基础版及以上版本才能使用。
2899
- * ## 注意事项
2900
- * 采集器尚未运行时,最近运行状态和任务实例 ID 可能为空。
2905
+ * ## Scenarios
2906
+ * Queries the configuration, availability status, and latest run information of a specified metadata crawler.
2907
+ * ## Recommended workflow
2908
+ * 1. Call `ListCrawlers` to query crawler IDs.
2909
+ * 2. Call this operation to retrieve crawler details.
2910
+ * 3. To query the complete run history, call `ListCrawlerRuns`.
2911
+ * ## Edition requirements
2912
+ * DataWorks Basic Edition or higher is required.
2913
+ * ## Precautions
2914
+ * If the crawler has not been run, the latest run status and task instance ID may be empty.
2901
2915
  *
2902
2916
  * @param request - GetCrawlerRequest
2903
2917
  * @returns GetCrawlerResponse
2904
2918
  */
2905
2919
  getCrawler(request: $_model.GetCrawlerRequest): Promise<$_model.GetCrawlerResponse>;
2906
2920
  /**
2907
- * 查询当前地域支持创建的元数据采集器类型及能力
2921
+ * Queries the crawler types supported in the current region, along with their collection scope, scheduling, and extension configuration capabilities.
2908
2922
  *
2909
2923
  * @remarks
2910
- * ## 使用场景
2911
- * 查询当前地域支持创建的采集器类型,以及各类型支持的数据源、采集范围、资源组、调度、AI 元数据描述和扩展配置能力。
2912
- * ## 推荐流程
2913
- * 1. 在创建或更新采集器前调用本接口。
2914
- * 2. 根据返回的能力信息构造 `CreateCrawler` 或 `UpdateCrawler` 请求。
2915
- * ## 版本要求
2916
- * 需要购买DataWorks基础版及以上版本才能使用。
2917
- * ## 注意事项
2918
- * 不同地域和采集器类型的能力可能不同,请以本接口的实际返回结果为准。
2924
+ * ## Scenarios
2925
+ * Queries the crawler types that can be created in the current region, as well as the data sources, collection scope, resource groups, scheduling, AI metadata description, and extension configuration capabilities supported by each type.
2926
+ * ## Recommended workflow
2927
+ * 1. Call this operation before creating or updating a crawler.
2928
+ * 2. Construct a `CreateCrawler` or `UpdateCrawler` request based on the returned capability information.
2929
+ * ## Edition requirements
2930
+ * DataWorks Basic Edition or a higher edition is required.
2931
+ * ## Precautions
2932
+ * Capabilities may vary by region and crawler type. Use the actual response of this operation as the reference.
2919
2933
  *
2920
2934
  * @param request - GetCrawlerTypeCapabilitiesRequest
2921
2935
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2923,18 +2937,18 @@ export default class Client extends OpenApi {
2923
2937
  */
2924
2938
  getCrawlerTypeCapabilitiesWithOptions(request: $_model.GetCrawlerTypeCapabilitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCrawlerTypeCapabilitiesResponse>;
2925
2939
  /**
2926
- * 查询当前地域支持创建的元数据采集器类型及能力
2940
+ * Queries the crawler types supported in the current region, along with their collection scope, scheduling, and extension configuration capabilities.
2927
2941
  *
2928
2942
  * @remarks
2929
- * ## 使用场景
2930
- * 查询当前地域支持创建的采集器类型,以及各类型支持的数据源、采集范围、资源组、调度、AI 元数据描述和扩展配置能力。
2931
- * ## 推荐流程
2932
- * 1. 在创建或更新采集器前调用本接口。
2933
- * 2. 根据返回的能力信息构造 `CreateCrawler` 或 `UpdateCrawler` 请求。
2934
- * ## 版本要求
2935
- * 需要购买DataWorks基础版及以上版本才能使用。
2936
- * ## 注意事项
2937
- * 不同地域和采集器类型的能力可能不同,请以本接口的实际返回结果为准。
2943
+ * ## Scenarios
2944
+ * Queries the crawler types that can be created in the current region, as well as the data sources, collection scope, resource groups, scheduling, AI metadata description, and extension configuration capabilities supported by each type.
2945
+ * ## Recommended workflow
2946
+ * 1. Call this operation before creating or updating a crawler.
2947
+ * 2. Construct a `CreateCrawler` or `UpdateCrawler` request based on the returned capability information.
2948
+ * ## Edition requirements
2949
+ * DataWorks Basic Edition or a higher edition is required.
2950
+ * ## Precautions
2951
+ * Capabilities may vary by region and crawler type. Use the actual response of this operation as the reference.
2938
2952
  *
2939
2953
  * @param request - GetCrawlerTypeCapabilitiesRequest
2940
2954
  * @returns GetCrawlerTypeCapabilitiesResponse
@@ -2998,10 +3012,10 @@ export default class Client extends OpenApi {
2998
3012
  */
2999
3013
  getDIJob(request: $_model.GetDIJobRequest): Promise<$_model.GetDIJobResponse>;
3000
3014
  /**
3001
- * Obtains logs generated for a synchronization task.
3015
+ * Retrieves the task logs of a data integration node.
3002
3016
  *
3003
3017
  * @remarks
3004
- * This API operation is available for all DataWorks editions.
3018
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
3005
3019
  *
3006
3020
  * @param request - GetDIJobLogRequest
3007
3021
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3009,10 +3023,10 @@ export default class Client extends OpenApi {
3009
3023
  */
3010
3024
  getDIJobLogWithOptions(request: $_model.GetDIJobLogRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDIJobLogResponse>;
3011
3025
  /**
3012
- * Obtains logs generated for a synchronization task.
3026
+ * Retrieves the task logs of a data integration node.
3013
3027
  *
3014
3028
  * @remarks
3015
- * This API operation is available for all DataWorks editions.
3029
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
3016
3030
  *
3017
3031
  * @param request - GetDIJobLogRequest
3018
3032
  * @returns GetDIJobLogResponse
@@ -3224,12 +3238,12 @@ export default class Client extends OpenApi {
3224
3238
  */
3225
3239
  getDataQualityTemplate(request: $_model.GetDataQualityTemplateRequest): Promise<$_model.GetDataQualityTemplateResponse>;
3226
3240
  /**
3227
- * Retrieves the details of a data source by data source ID.
3241
+ * Queries a specified data source by data source ID.
3228
3242
  *
3229
3243
  * @remarks
3230
- * 1. This operation is available for all DataWorks editions.
3231
- * 2. To call this operation, you must have one of the following roles in DataWorks:
3232
- * - Tenant Owner, Workspace Administrator, Deployment, Development, Project Owner, and O\\&M
3244
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
3245
+ * 2. You must have at least one of the following roles in the DataWorks workspace:
3246
+ * - Tenant Owner, Workspace Administrator, Deployment, Developer, Project Owner, or O&M Engineer
3233
3247
  *
3234
3248
  * @param request - GetDataSourceRequest
3235
3249
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3237,12 +3251,12 @@ export default class Client extends OpenApi {
3237
3251
  */
3238
3252
  getDataSourceWithOptions(request: $_model.GetDataSourceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDataSourceResponse>;
3239
3253
  /**
3240
- * Retrieves the details of a data source by data source ID.
3254
+ * Queries a specified data source by data source ID.
3241
3255
  *
3242
3256
  * @remarks
3243
- * 1. This operation is available for all DataWorks editions.
3244
- * 2. To call this operation, you must have one of the following roles in DataWorks:
3245
- * - Tenant Owner, Workspace Administrator, Deployment, Development, Project Owner, and O\\&M
3257
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
3258
+ * 2. You must have at least one of the following roles in the DataWorks workspace:
3259
+ * - Tenant Owner, Workspace Administrator, Deployment, Developer, Project Owner, or O&M Engineer
3246
3260
  *
3247
3261
  * @param request - GetDataSourceRequest
3248
3262
  * @returns GetDataSourceResponse
@@ -3300,7 +3314,7 @@ export default class Client extends OpenApi {
3300
3314
  */
3301
3315
  getDatasetVersion(request: $_model.GetDatasetVersionRequest): Promise<$_model.GetDatasetVersionResponse>;
3302
3316
  /**
3303
- * Queries the information about a deployment package.
3317
+ * Retrieves the details of a deployment package.
3304
3318
  *
3305
3319
  * @param request - GetDeploymentPackageRequest
3306
3320
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3308,7 +3322,7 @@ export default class Client extends OpenApi {
3308
3322
  */
3309
3323
  getDeploymentPackageWithOptions(request: $_model.GetDeploymentPackageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetDeploymentPackageResponse>;
3310
3324
  /**
3311
- * Queries the information about a deployment package.
3325
+ * Retrieves the details of a deployment package.
3312
3326
  *
3313
3327
  * @param request - GetDeploymentPackageRequest
3314
3328
  * @returns GetDeploymentPackageResponse
@@ -3330,7 +3344,7 @@ export default class Client extends OpenApi {
3330
3344
  */
3331
3345
  getFile(request: $_model.GetFileRequest): Promise<$_model.GetFileResponse>;
3332
3346
  /**
3333
- * Invoke GetFileVersion to obtain the version details of a file.
3347
+ * Retrieves the version details of a file.
3334
3348
  *
3335
3349
  * @param request - GetFileVersionRequest
3336
3350
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3338,7 +3352,7 @@ export default class Client extends OpenApi {
3338
3352
  */
3339
3353
  getFileVersionWithOptions(request: $_model.GetFileVersionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetFileVersionResponse>;
3340
3354
  /**
3341
- * Invoke GetFileVersion to obtain the version details of a file.
3355
+ * Retrieves the version details of a file.
3342
3356
  *
3343
3357
  * @param request - GetFileVersionRequest
3344
3358
  * @returns GetFileVersionResponse
@@ -3390,11 +3404,11 @@ export default class Client extends OpenApi {
3390
3404
  */
3391
3405
  getIDEEventDetail(request: $_model.GetIDEEventDetailRequest): Promise<$_model.GetIDEEventDetailResponse>;
3392
3406
  /**
3393
- * Gets the details of an image by its ID.
3407
+ * Retrieves the details of a specified image by image ID.
3394
3408
  *
3395
3409
  * @remarks
3396
- * 1. A subscription to DataWorks Basic Edition or a higher edition is required.
3397
- * 2. **Make sure that you have created the service-linked role AliyunServiceRoleForDataWorks before you call this operation.**
3410
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
3411
+ * 2. **Before calling this operation, make sure that the service-linked role AliyunServiceRoleForDataWorks has been created.**
3398
3412
  *
3399
3413
  * @param request - GetImageRequest
3400
3414
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3402,18 +3416,18 @@ export default class Client extends OpenApi {
3402
3416
  */
3403
3417
  getImageWithOptions(request: $_model.GetImageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetImageResponse>;
3404
3418
  /**
3405
- * Gets the details of an image by its ID.
3419
+ * Retrieves the details of a specified image by image ID.
3406
3420
  *
3407
3421
  * @remarks
3408
- * 1. A subscription to DataWorks Basic Edition or a higher edition is required.
3409
- * 2. **Make sure that you have created the service-linked role AliyunServiceRoleForDataWorks before you call this operation.**
3422
+ * 1. You must purchase DataWorks Basic Edition or a higher edition to use this operation.
3423
+ * 2. **Before calling this operation, make sure that the service-linked role AliyunServiceRoleForDataWorks has been created.**
3410
3424
  *
3411
3425
  * @param request - GetImageRequest
3412
3426
  * @returns GetImageResponse
3413
3427
  */
3414
3428
  getImage(request: $_model.GetImageRequest): Promise<$_model.GetImageResponse>;
3415
3429
  /**
3416
- * Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.
3430
+ * Returns the status of an asynchronous task. After calling an asynchronous API, poll this API to obtain the success status.
3417
3431
  *
3418
3432
  * @param request - GetJobStatusRequest
3419
3433
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3421,17 +3435,17 @@ export default class Client extends OpenApi {
3421
3435
  */
3422
3436
  getJobStatusWithOptions(request: $_model.GetJobStatusRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetJobStatusResponse>;
3423
3437
  /**
3424
- * Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.
3438
+ * Returns the status of an asynchronous task. After calling an asynchronous API, poll this API to obtain the success status.
3425
3439
  *
3426
3440
  * @param request - GetJobStatusRequest
3427
3441
  * @returns GetJobStatusResponse
3428
3442
  */
3429
3443
  getJobStatus(request: $_model.GetJobStatusRequest): Promise<$_model.GetJobStatusResponse>;
3430
3444
  /**
3431
- * Retrieves details for a specific lineage relationship in the data map.
3445
+ * Retrieves the details of a specified lineage relationship in DataWorks Data Map.
3432
3446
  *
3433
3447
  * @remarks
3434
- * 1. This operation is available only for DataWorks Standard Edition or later.
3448
+ * 1. You must have DataWorks Standard Edition or a higher edition to use this operation.
3435
3449
  *
3436
3450
  * @param request - GetLineageRelationshipRequest
3437
3451
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3439,10 +3453,10 @@ export default class Client extends OpenApi {
3439
3453
  */
3440
3454
  getLineageRelationshipWithOptions(request: $_model.GetLineageRelationshipRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetLineageRelationshipResponse>;
3441
3455
  /**
3442
- * Retrieves details for a specific lineage relationship in the data map.
3456
+ * Retrieves the details of a specified lineage relationship in DataWorks Data Map.
3443
3457
  *
3444
3458
  * @remarks
3445
- * 1. This operation is available only for DataWorks Standard Edition or later.
3459
+ * 1. You must have DataWorks Standard Edition or a higher edition to use this operation.
3446
3460
  *
3447
3461
  * @param request - GetLineageRelationshipRequest
3448
3462
  * @returns GetLineageRelationshipResponse
@@ -3609,11 +3623,10 @@ export default class Client extends OpenApi {
3609
3623
  */
3610
3624
  getPartition(request: $_model.GetPartitionRequest): Promise<$_model.GetPartitionResponse>;
3611
3625
  /**
3612
- * Gets the details of a Deployment Process.
3626
+ * Retrieves the details of a deployment process.
3613
3627
  *
3614
3628
  * @remarks
3615
- * >Notice:
3616
- * For earlier SDK versions that do not include this API, use the GetDeployment API with the same parameters described in this document.
3629
+ * >Notice: This operation may not be available in earlier SDK versions. In this case, use the GetDeployment operation instead. The parameters are the same as those described in this document.
3617
3630
  *
3618
3631
  * @param request - GetPipelineRunRequest
3619
3632
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3621,11 +3634,10 @@ export default class Client extends OpenApi {
3621
3634
  */
3622
3635
  getPipelineRunWithOptions(request: $_model.GetPipelineRunRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetPipelineRunResponse>;
3623
3636
  /**
3624
- * Gets the details of a Deployment Process.
3637
+ * Retrieves the details of a deployment process.
3625
3638
  *
3626
3639
  * @remarks
3627
- * >Notice:
3628
- * For earlier SDK versions that do not include this API, use the GetDeployment API with the same parameters described in this document.
3640
+ * >Notice: This operation may not be available in earlier SDK versions. In this case, use the GetDeployment operation instead. The parameters are the same as those described in this document.
3629
3641
  *
3630
3642
  * @param request - GetPipelineRunRequest
3631
3643
  * @returns GetPipelineRunResponse
@@ -3684,10 +3696,10 @@ export default class Client extends OpenApi {
3684
3696
  */
3685
3697
  getProcessInstance(request: $_model.GetProcessInstanceRequest): Promise<$_model.GetProcessInstanceResponse>;
3686
3698
  /**
3687
- * Queries the information about a DataWorks workspace.
3699
+ * Queries the details of a DataWorks workspace.
3688
3700
  *
3689
3701
  * @remarks
3690
- * This API operation is available for all DataWorks editions.
3702
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
3691
3703
  *
3692
3704
  * @param request - GetProjectRequest
3693
3705
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3695,10 +3707,10 @@ export default class Client extends OpenApi {
3695
3707
  */
3696
3708
  getProjectWithOptions(request: $_model.GetProjectRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetProjectResponse>;
3697
3709
  /**
3698
- * Queries the information about a DataWorks workspace.
3710
+ * Queries the details of a DataWorks workspace.
3699
3711
  *
3700
3712
  * @remarks
3701
- * This API operation is available for all DataWorks editions.
3713
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
3702
3714
  *
3703
3715
  * @param request - GetProjectRequest
3704
3716
  * @returns GetProjectResponse
@@ -3777,10 +3789,10 @@ export default class Client extends OpenApi {
3777
3789
  */
3778
3790
  getResource(request: $_model.GetResourceRequest): Promise<$_model.GetResourceResponse>;
3779
3791
  /**
3780
- * Queries the information about a resource group based on its ID.
3792
+ * Retrieves the information of a specified resource group by ID.
3781
3793
  *
3782
3794
  * @remarks
3783
- * DataWorks Basic Edition or a more advanced edition is required to use this feature.
3795
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
3784
3796
  *
3785
3797
  * @param request - GetResourceGroupRequest
3786
3798
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3788,10 +3800,10 @@ export default class Client extends OpenApi {
3788
3800
  */
3789
3801
  getResourceGroupWithOptions(request: $_model.GetResourceGroupRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetResourceGroupResponse>;
3790
3802
  /**
3791
- * Queries the information about a resource group based on its ID.
3803
+ * Retrieves the information of a specified resource group by ID.
3792
3804
  *
3793
3805
  * @remarks
3794
- * DataWorks Basic Edition or a more advanced edition is required to use this feature.
3806
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
3795
3807
  *
3796
3808
  * @param request - GetResourceGroupRequest
3797
3809
  * @returns GetResourceGroupResponse
@@ -3967,6 +3979,21 @@ export default class Client extends OpenApi {
3967
3979
  * @returns GetSkillResponse
3968
3980
  */
3969
3981
  getSkill(request: $_model.GetSkillRequest): Promise<$_model.GetSkillResponse>;
3982
+ /**
3983
+ * Retrieves the details of a version snapshot.
3984
+ *
3985
+ * @param request - GetSnapshotRequest
3986
+ * @param runtime - runtime options for this request RuntimeOptions
3987
+ * @returns GetSnapshotResponse
3988
+ */
3989
+ getSnapshotWithOptions(request: $_model.GetSnapshotRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetSnapshotResponse>;
3990
+ /**
3991
+ * Retrieves the details of a version snapshot.
3992
+ *
3993
+ * @param request - GetSnapshotRequest
3994
+ * @returns GetSnapshotResponse
3995
+ */
3996
+ getSnapshot(request: $_model.GetSnapshotRequest): Promise<$_model.GetSnapshotResponse>;
3970
3997
  /**
3971
3998
  * Retrieves the details of a specified table in Data Map. You can choose whether to return business metadata.
3972
3999
  *
@@ -4180,10 +4207,10 @@ export default class Client extends OpenApi {
4180
4207
  * Sends a stop request to the executor for a specified semantic job run. This is applicable to scenarios where a job runs for an extended period, requires manual termination, or needs resource reclamation.
4181
4208
  * ## Procedure
4182
4209
  * 1. Obtain the `ExecutorJobId` from `RunSemanticJob` or `ListSemanticJobRuns`, and use the `ProjectId` of the job.
4183
- * 2. Optionally specify `RetryTimes` as needed.
4184
- * 3. After the call, poll the final status by using `GetSemanticJobDetail`. If necessary, call `GetSemanticJobLog` for diagnostics.
4185
- * ## Before you begin
4186
- * A successful response indicates only that the stop request has been processed. It does not mean the job has reached a desired state.
4210
+ * 2. Optionally specify `RetryTimes`.
4211
+ * 3. After the call, poll the final status by calling `GetSemanticJobDetail`. If necessary, call `GetSemanticJobLog` for diagnostics.
4212
+ * ## Precautions
4213
+ * A successful response indicates only that the stop request has been processed. It does not mean that the job has reached a desired state.
4187
4214
  *
4188
4215
  * @param request - KillSemanticJobRequest
4189
4216
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4198,23 +4225,23 @@ export default class Client extends OpenApi {
4198
4225
  * Sends a stop request to the executor for a specified semantic job run. This is applicable to scenarios where a job runs for an extended period, requires manual termination, or needs resource reclamation.
4199
4226
  * ## Procedure
4200
4227
  * 1. Obtain the `ExecutorJobId` from `RunSemanticJob` or `ListSemanticJobRuns`, and use the `ProjectId` of the job.
4201
- * 2. Optionally specify `RetryTimes` as needed.
4202
- * 3. After the call, poll the final status by using `GetSemanticJobDetail`. If necessary, call `GetSemanticJobLog` for diagnostics.
4203
- * ## Before you begin
4204
- * A successful response indicates only that the stop request has been processed. It does not mean the job has reached a desired state.
4228
+ * 2. Optionally specify `RetryTimes`.
4229
+ * 3. After the call, poll the final status by calling `GetSemanticJobDetail`. If necessary, call `GetSemanticJobLog` for diagnostics.
4230
+ * ## Precautions
4231
+ * A successful response indicates only that the stop request has been processed. It does not mean that the job has reached a desired state.
4205
4232
  *
4206
4233
  * @param request - KillSemanticJobRequest
4207
4234
  * @returns KillSemanticJobResponse
4208
4235
  */
4209
4236
  killSemanticJob(request: $_model.KillSemanticJobRequest): Promise<$_model.KillSemanticJobResponse>;
4210
4237
  /**
4211
- * Retrieves a list of artifacts from a specified session.
4238
+ * Queries the list of artifact files produced by a specified session.
4212
4239
  *
4213
4240
  * @remarks
4214
- * ## Request
4215
- * - This operation retrieves all artifacts from a specific session. You can use the `Params.RequestId` parameter to filter for artifacts from a specific request.
4216
- * - The `NextToken` parameter is a continuation token used to retrieve the next page of results. Do not specify this parameter for the first request.
4217
- * - By default, this operation returns up to 50 artifacts per page. You can use the `MaxResults` parameter to specify a different limit.
4241
+ * ## Operation description
4242
+ * - This operation queries all artifact files generated in a specific session. You can use the `Params.RequestId` parameter to filter files produced by a single request.
4243
+ * - The `NextToken` parameter is used to retrieve more results in a paginated manner. You do not need to provide this value for the first call.
4244
+ * - By default, a maximum of 50 records are returned per page. You can adjust this value by using the `MaxResults` parameter.
4218
4245
  *
4219
4246
  * @param tmpReq - ListAgentSessionArtifactsRequest
4220
4247
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4222,13 +4249,13 @@ export default class Client extends OpenApi {
4222
4249
  */
4223
4250
  listAgentSessionArtifactsWithOptions(tmpReq: $_model.ListAgentSessionArtifactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentSessionArtifactsResponse>;
4224
4251
  /**
4225
- * Retrieves a list of artifacts from a specified session.
4252
+ * Queries the list of artifact files produced by a specified session.
4226
4253
  *
4227
4254
  * @remarks
4228
- * ## Request
4229
- * - This operation retrieves all artifacts from a specific session. You can use the `Params.RequestId` parameter to filter for artifacts from a specific request.
4230
- * - The `NextToken` parameter is a continuation token used to retrieve the next page of results. Do not specify this parameter for the first request.
4231
- * - By default, this operation returns up to 50 artifacts per page. You can use the `MaxResults` parameter to specify a different limit.
4255
+ * ## Operation description
4256
+ * - This operation queries all artifact files generated in a specific session. You can use the `Params.RequestId` parameter to filter files produced by a single request.
4257
+ * - The `NextToken` parameter is used to retrieve more results in a paginated manner. You do not need to provide this value for the first call.
4258
+ * - By default, a maximum of 50 records are returned per page. You can adjust this value by using the `MaxResults` parameter.
4232
4259
  *
4233
4260
  * @param request - ListAgentSessionArtifactsRequest
4234
4261
  * @returns ListAgentSessionArtifactsResponse
@@ -4266,12 +4293,12 @@ export default class Client extends OpenApi {
4266
4293
  */
4267
4294
  listAgentSessions(request: $_model.ListAgentSessionsRequest): Promise<$_model.ListAgentSessionsResponse>;
4268
4295
  /**
4269
- * Lists agents for the current tenant and supports filtering by name and pagination.
4296
+ * Queries the list of agents available to the current tenant, with support for filtering by name and pagination.
4270
4297
  *
4271
4298
  * @remarks
4272
4299
  * ## Request description
4273
- * - This operation lists all available agents for the current tenant.
4274
- * - You can filter the results by specifying an exact match for the `agentName` parameter.
4300
+ * - This operation queries all available agents under the current tenant.
4301
+ * - Supports exact match filtering by using the `agentName` parameter.
4275
4302
  *
4276
4303
  * @param tmpReq - ListAgentsRequest
4277
4304
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4279,12 +4306,12 @@ export default class Client extends OpenApi {
4279
4306
  */
4280
4307
  listAgentsWithOptions(tmpReq: $_model.ListAgentsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListAgentsResponse>;
4281
4308
  /**
4282
- * Lists agents for the current tenant and supports filtering by name and pagination.
4309
+ * Queries the list of agents available to the current tenant, with support for filtering by name and pagination.
4283
4310
  *
4284
4311
  * @remarks
4285
4312
  * ## Request description
4286
- * - This operation lists all available agents for the current tenant.
4287
- * - You can filter the results by specifying an exact match for the `agentName` parameter.
4313
+ * - This operation queries all available agents under the current tenant.
4314
+ * - Supports exact match filtering by using the `agentName` parameter.
4288
4315
  *
4289
4316
  * @param request - ListAgentsRequest
4290
4317
  * @returns ListAgentsResponse
@@ -4432,19 +4459,19 @@ export default class Client extends OpenApi {
4432
4459
  */
4433
4460
  listComputeResources(request: $_model.ListComputeResourcesRequest): Promise<$_model.ListComputeResourcesResponse>;
4434
4461
  /**
4435
- * 查询元数据采集器运行记录
4462
+ * Queries the run records of a specified metadata crawler by paging, with optional filtering by time range and run status.
4436
4463
  *
4437
4464
  * @remarks
4438
- * ## 使用场景
4439
- * 分页查询指定元数据采集器最近 30 天内的运行记录,并可按运行开始时间和状态筛选。
4440
- * ## 推荐流程
4441
- * 1. 使用 `ListCrawlers` 查询采集器 ID。
4442
- * 2. 调用本接口查询运行记录和任务实例 ID。
4443
- * 3. 对运行、停止等异步操作,以本接口返回的最终状态为准。
4444
- * ## 版本要求
4445
- * 需要购买DataWorks基础版及以上版本才能使用。
4446
- * ## 注意事项
4447
- * 未指定时间范围时,默认查询当前时间向前 30 天。
4465
+ * ## Scenarios
4466
+ * Queries the run records of a specified metadata crawler within the last 30 days by paging, with optional filtering by run start time and status.
4467
+ * ## Recommended workflow
4468
+ * 1. Invoke `ListCrawlers` to obtain the crawler ID.
4469
+ * 2. Invoke this operation to query run records and node instance IDs.
4470
+ * 3. For asynchronous operations such as running or stopping, use the final status returned by this operation as the source of truth.
4471
+ * ## Edition requirements
4472
+ * DataWorks Basic Edition or a higher edition is required.
4473
+ * ## Precautions
4474
+ * If no time range is specified, the system queries records from the last 30 days by default.
4448
4475
  *
4449
4476
  * @param request - ListCrawlerRunsRequest
4450
4477
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4452,19 +4479,19 @@ export default class Client extends OpenApi {
4452
4479
  */
4453
4480
  listCrawlerRunsWithOptions(request: $_model.ListCrawlerRunsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCrawlerRunsResponse>;
4454
4481
  /**
4455
- * 查询元数据采集器运行记录
4482
+ * Queries the run records of a specified metadata crawler by paging, with optional filtering by time range and run status.
4456
4483
  *
4457
4484
  * @remarks
4458
- * ## 使用场景
4459
- * 分页查询指定元数据采集器最近 30 天内的运行记录,并可按运行开始时间和状态筛选。
4460
- * ## 推荐流程
4461
- * 1. 使用 `ListCrawlers` 查询采集器 ID。
4462
- * 2. 调用本接口查询运行记录和任务实例 ID。
4463
- * 3. 对运行、停止等异步操作,以本接口返回的最终状态为准。
4464
- * ## 版本要求
4465
- * 需要购买DataWorks基础版及以上版本才能使用。
4466
- * ## 注意事项
4467
- * 未指定时间范围时,默认查询当前时间向前 30 天。
4485
+ * ## Scenarios
4486
+ * Queries the run records of a specified metadata crawler within the last 30 days by paging, with optional filtering by run start time and status.
4487
+ * ## Recommended workflow
4488
+ * 1. Invoke `ListCrawlers` to obtain the crawler ID.
4489
+ * 2. Invoke this operation to query run records and node instance IDs.
4490
+ * 3. For asynchronous operations such as running or stopping, use the final status returned by this operation as the source of truth.
4491
+ * ## Edition requirements
4492
+ * DataWorks Basic Edition or a higher edition is required.
4493
+ * ## Precautions
4494
+ * If no time range is specified, the system queries records from the last 30 days by default.
4468
4495
  *
4469
4496
  * @param request - ListCrawlerRunsRequest
4470
4497
  * @returns ListCrawlerRunsResponse
@@ -4489,18 +4516,18 @@ export default class Client extends OpenApi {
4489
4516
  */
4490
4517
  listCrawlerTypes(): Promise<$_model.ListCrawlerTypesResponse>;
4491
4518
  /**
4492
- * 查询元数据采集器列表
4519
+ * Queries metadata crawlers by paged query, and supports filtering by workspace, data source, type, environment, owner, and name.
4493
4520
  *
4494
4521
  * @remarks
4495
- * ## 使用场景
4496
- * 分页查询有权访问的元数据采集器,并可按工作空间、数据源、采集器类型、环境、负责人和名称筛选。
4497
- * ## 推荐流程
4498
- * 1. 按需组合筛选条件查询采集器列表。
4499
- * 2. 使用返回的采集器 ID 调用详情、更新、运行、停止、运行记录或删除接口。
4500
- * ## 版本要求
4501
- * 需要购买DataWorks基础版及以上版本才能使用。
4502
- * ## 注意事项
4503
- * 多个筛选条件同时提供时组合生效,名称支持模糊匹配。
4522
+ * ## Scenarios
4523
+ * Performs a paged query of metadata crawlers that you have access to. Supports filtering by workspace, data source, crawler type, environment, owner, and name.
4524
+ * ## Recommended flow
4525
+ * 1. Combine filter conditions as needed to perform a conditional query of the crawler list.
4526
+ * 2. Use the returned crawler IDs to invoke the get details, update, run, stop, run records, or delete operations.
4527
+ * ## Version requirements
4528
+ * DataWorks Basic Edition or higher is required.
4529
+ * ## Precautions
4530
+ * When multiple filter conditions are provided at the same time, they take effect in combination. The name field supports fuzzy match.
4504
4531
  *
4505
4532
  * @param tmpReq - ListCrawlersRequest
4506
4533
  * @param runtime - runtime options for this request RuntimeOptions
@@ -4508,18 +4535,18 @@ export default class Client extends OpenApi {
4508
4535
  */
4509
4536
  listCrawlersWithOptions(tmpReq: $_model.ListCrawlersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCrawlersResponse>;
4510
4537
  /**
4511
- * 查询元数据采集器列表
4538
+ * Queries metadata crawlers by paged query, and supports filtering by workspace, data source, type, environment, owner, and name.
4512
4539
  *
4513
4540
  * @remarks
4514
- * ## 使用场景
4515
- * 分页查询有权访问的元数据采集器,并可按工作空间、数据源、采集器类型、环境、负责人和名称筛选。
4516
- * ## 推荐流程
4517
- * 1. 按需组合筛选条件查询采集器列表。
4518
- * 2. 使用返回的采集器 ID 调用详情、更新、运行、停止、运行记录或删除接口。
4519
- * ## 版本要求
4520
- * 需要购买DataWorks基础版及以上版本才能使用。
4521
- * ## 注意事项
4522
- * 多个筛选条件同时提供时组合生效,名称支持模糊匹配。
4541
+ * ## Scenarios
4542
+ * Performs a paged query of metadata crawlers that you have access to. Supports filtering by workspace, data source, crawler type, environment, owner, and name.
4543
+ * ## Recommended flow
4544
+ * 1. Combine filter conditions as needed to perform a conditional query of the crawler list.
4545
+ * 2. Use the returned crawler IDs to invoke the get details, update, run, stop, run records, or delete operations.
4546
+ * ## Version requirements
4547
+ * DataWorks Basic Edition or higher is required.
4548
+ * ## Precautions
4549
+ * When multiple filter conditions are provided at the same time, they take effect in combination. The name field supports fuzzy match.
4523
4550
  *
4524
4551
  * @param request - ListCrawlersRequest
4525
4552
  * @returns ListCrawlersResponse
@@ -4808,7 +4835,7 @@ export default class Client extends OpenApi {
4808
4835
  * Queries a list of data quality rule templates.
4809
4836
  *
4810
4837
  * @remarks
4811
- * You must purchase DataWorks Basic Edition or higher to use this feature.
4838
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4812
4839
  *
4813
4840
  * @deprecated OpenAPI ListDataQualityRuleTemplates is deprecated, please use dataworks-public::2024-05-18::ListDataQualityTemplates instead.
4814
4841
  *
@@ -4821,7 +4848,7 @@ export default class Client extends OpenApi {
4821
4848
  * Queries a list of data quality rule templates.
4822
4849
  *
4823
4850
  * @remarks
4824
- * You must purchase DataWorks Basic Edition or higher to use this feature.
4851
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4825
4852
  *
4826
4853
  * @deprecated OpenAPI ListDataQualityRuleTemplates is deprecated, please use dataworks-public::2024-05-18::ListDataQualityTemplates instead.
4827
4854
  *
@@ -4830,10 +4857,10 @@ export default class Client extends OpenApi {
4830
4857
  */
4831
4858
  listDataQualityRuleTemplates(request: $_model.ListDataQualityRuleTemplatesRequest): Promise<$_model.ListDataQualityRuleTemplatesResponse>;
4832
4859
  /**
4833
- * Paginated query of data quality monitoring rules.
4860
+ * Queries quality monitoring rules by paging.
4834
4861
  *
4835
4862
  * @remarks
4836
- * Requires DataWorks Basic Edition or above.
4863
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4837
4864
  *
4838
4865
  * @deprecated OpenAPI ListDataQualityRules is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScans instead.
4839
4866
  *
@@ -4843,10 +4870,10 @@ export default class Client extends OpenApi {
4843
4870
  */
4844
4871
  listDataQualityRulesWithOptions(request: $_model.ListDataQualityRulesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataQualityRulesResponse>;
4845
4872
  /**
4846
- * Paginated query of data quality monitoring rules.
4873
+ * Queries quality monitoring rules by paging.
4847
4874
  *
4848
4875
  * @remarks
4849
- * Requires DataWorks Basic Edition or above.
4876
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
4850
4877
  *
4851
4878
  * @deprecated OpenAPI ListDataQualityRules is deprecated, please use dataworks-public::2024-05-18::ListDataQualityScans instead.
4852
4879
  *
@@ -5021,7 +5048,7 @@ export default class Client extends OpenApi {
5021
5048
  */
5022
5049
  listDatasets(request: $_model.ListDatasetsRequest): Promise<$_model.ListDatasetsResponse>;
5023
5050
  /**
5024
- * Queries a list of versions of files to be deployed.
5051
+ * Retrieves the list of file versions pending deployment.
5025
5052
  *
5026
5053
  * @param tmpReq - ListDeploymentPackageFilesRequest
5027
5054
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5029,7 +5056,7 @@ export default class Client extends OpenApi {
5029
5056
  */
5030
5057
  listDeploymentPackageFilesWithOptions(tmpReq: $_model.ListDeploymentPackageFilesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDeploymentPackageFilesResponse>;
5031
5058
  /**
5032
- * Queries a list of versions of files to be deployed.
5059
+ * Retrieves the list of file versions pending deployment.
5033
5060
  *
5034
5061
  * @param request - ListDeploymentPackageFilesRequest
5035
5062
  * @returns ListDeploymentPackageFilesResponse
@@ -5051,10 +5078,10 @@ export default class Client extends OpenApi {
5051
5078
  */
5052
5079
  listDeploymentPackages(request: $_model.ListDeploymentPackagesRequest): Promise<$_model.ListDeploymentPackagesResponse>;
5053
5080
  /**
5054
- * Queries a list of descendant instances of an instance by page.
5081
+ * Retrieves a paginated list of downstream instances for a specified instance.
5055
5082
  *
5056
5083
  * @remarks
5057
- * This API operation is available for all DataWorks editions.
5084
+ * DataWorks Basic Edition or a more advanced edition is required.
5058
5085
  *
5059
5086
  * @param request - ListDownstreamTaskInstancesRequest
5060
5087
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5062,10 +5089,10 @@ export default class Client extends OpenApi {
5062
5089
  */
5063
5090
  listDownstreamTaskInstancesWithOptions(request: $_model.ListDownstreamTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDownstreamTaskInstancesResponse>;
5064
5091
  /**
5065
- * Queries a list of descendant instances of an instance by page.
5092
+ * Retrieves a paginated list of downstream instances for a specified instance.
5066
5093
  *
5067
5094
  * @remarks
5068
- * This API operation is available for all DataWorks editions.
5095
+ * DataWorks Basic Edition or a more advanced edition is required.
5069
5096
  *
5070
5097
  * @param request - ListDownstreamTaskInstancesRequest
5071
5098
  * @returns ListDownstreamTaskInstancesResponse
@@ -5108,7 +5135,7 @@ export default class Client extends OpenApi {
5108
5135
  */
5109
5136
  listEntitiesInMetaCollection(request: $_model.ListEntitiesInMetaCollectionRequest): Promise<$_model.ListEntitiesInMetaCollectionResponse>;
5110
5137
  /**
5111
- * Queries a list of file versions.
5138
+ * Queries the version list of a file.
5112
5139
  *
5113
5140
  * @param request - ListFileVersionsRequest
5114
5141
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5116,14 +5143,14 @@ export default class Client extends OpenApi {
5116
5143
  */
5117
5144
  listFileVersionsWithOptions(request: $_model.ListFileVersionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListFileVersionsResponse>;
5118
5145
  /**
5119
- * Queries a list of file versions.
5146
+ * Queries the version list of a file.
5120
5147
  *
5121
5148
  * @param request - ListFileVersionsRequest
5122
5149
  * @returns ListFileVersionsResponse
5123
5150
  */
5124
5151
  listFileVersions(request: $_model.ListFileVersionsRequest): Promise<$_model.ListFileVersionsResponse>;
5125
5152
  /**
5126
- * Queries a list of files.
5153
+ * Queries a list of files by calling ListFiles.
5127
5154
  *
5128
5155
  * @param request - ListFilesRequest
5129
5156
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5131,7 +5158,7 @@ export default class Client extends OpenApi {
5131
5158
  */
5132
5159
  listFilesWithOptions(request: $_model.ListFilesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListFilesResponse>;
5133
5160
  /**
5134
- * Queries a list of files.
5161
+ * Queries a list of files by calling ListFiles.
5135
5162
  *
5136
5163
  * @param request - ListFilesRequest
5137
5164
  * @returns ListFilesResponse
@@ -5153,7 +5180,7 @@ export default class Client extends OpenApi {
5153
5180
  */
5154
5181
  listFolders(request: $_model.ListFoldersRequest): Promise<$_model.ListFoldersResponse>;
5155
5182
  /**
5156
- * Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.
5183
+ * Retrieves a paginated list of UDF functions in DataStudio. You can also use filter conditions to filter UDF functions.
5157
5184
  *
5158
5185
  * @param request - ListFunctionsRequest
5159
5186
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5161,7 +5188,7 @@ export default class Client extends OpenApi {
5161
5188
  */
5162
5189
  listFunctionsWithOptions(request: $_model.ListFunctionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListFunctionsResponse>;
5163
5190
  /**
5164
- * Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.
5191
+ * Retrieves a paginated list of UDF functions in DataStudio. You can also use filter conditions to filter UDF functions.
5165
5192
  *
5166
5193
  * @param request - ListFunctionsRequest
5167
5194
  * @returns ListFunctionsResponse
@@ -5258,11 +5285,11 @@ export default class Client extends OpenApi {
5258
5285
  */
5259
5286
  listLineageRelationships(request: $_model.ListLineageRelationshipsRequest): Promise<$_model.ListLineageRelationshipsResponse>;
5260
5287
  /**
5261
- * Queries the upstream and downstream entities for a specified entity in Data Map. You can optionally include detailed lineage relationship information.
5288
+ * Queries the upstream and downstream lineage entities for a specified entity in DataWorks Data Map, with an option to include detailed lineage relationship information.
5262
5289
  *
5263
5290
  * @remarks
5264
- * 1. To use this API, you must purchase DataWorks Standard Edition or a later edition.
5265
- * 2. Use this API to query the upstream and downstream entities of a specific entity and their lineage relationships.
5291
+ * 1. You must purchase DataWorks Standard Edition or a higher edition to use this operation.
5292
+ * 2. This operation queries the upstream and downstream entities of the current entity, as well as the lineage relationships between entities.
5266
5293
  *
5267
5294
  * @param request - ListLineagesRequest
5268
5295
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5270,11 +5297,11 @@ export default class Client extends OpenApi {
5270
5297
  */
5271
5298
  listLineagesWithOptions(request: $_model.ListLineagesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListLineagesResponse>;
5272
5299
  /**
5273
- * Queries the upstream and downstream entities for a specified entity in Data Map. You can optionally include detailed lineage relationship information.
5300
+ * Queries the upstream and downstream lineage entities for a specified entity in DataWorks Data Map, with an option to include detailed lineage relationship information.
5274
5301
  *
5275
5302
  * @remarks
5276
- * 1. To use this API, you must purchase DataWorks Standard Edition or a later edition.
5277
- * 2. Use this API to query the upstream and downstream entities of a specific entity and their lineage relationships.
5303
+ * 1. You must purchase DataWorks Standard Edition or a higher edition to use this operation.
5304
+ * 2. This operation queries the upstream and downstream entities of the current entity, as well as the lineage relationships between entities.
5278
5305
  *
5279
5306
  * @param request - ListLineagesRequest
5280
5307
  * @returns ListLineagesResponse
@@ -5463,7 +5490,7 @@ export default class Client extends OpenApi {
5463
5490
  */
5464
5491
  listNodeDependencies(request: $_model.ListNodeDependenciesRequest): Promise<$_model.ListNodeDependenciesResponse>;
5465
5492
  /**
5466
- * Retrieves a paginated list of data development nodes that can be filtered by specified criteria.
5493
+ * Retrieves a list of data development nodes with paging, and supports filtered query by specified conditions.
5467
5494
  *
5468
5495
  * @param request - ListNodesRequest
5469
5496
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5471,7 +5498,7 @@ export default class Client extends OpenApi {
5471
5498
  */
5472
5499
  listNodesWithOptions(request: $_model.ListNodesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListNodesResponse>;
5473
5500
  /**
5474
- * Retrieves a paginated list of data development nodes that can be filtered by specified criteria.
5501
+ * Retrieves a list of data development nodes with paging, and supports filtered query by specified conditions.
5475
5502
  *
5476
5503
  * @param request - ListNodesRequest
5477
5504
  * @returns ListNodesResponse
@@ -5799,7 +5826,7 @@ export default class Client extends OpenApi {
5799
5826
  */
5800
5827
  listResourceGroups(request: $_model.ListResourceGroupsRequest): Promise<$_model.ListResourceGroupsResponse>;
5801
5828
  /**
5802
- * Queries a list of file resources in DataStudio. You can also specify filter conditions to query specific file resources.
5829
+ * Queries resource files with pagination and filtering support.
5803
5830
  *
5804
5831
  * @param request - ListResourcesRequest
5805
5832
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5807,17 +5834,17 @@ export default class Client extends OpenApi {
5807
5834
  */
5808
5835
  listResourcesWithOptions(request: $_model.ListResourcesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListResourcesResponse>;
5809
5836
  /**
5810
- * Queries a list of file resources in DataStudio. You can also specify filter conditions to query specific file resources.
5837
+ * Queries resource files with pagination and filtering support.
5811
5838
  *
5812
5839
  * @param request - ListResourcesRequest
5813
5840
  * @returns ListResourcesResponse
5814
5841
  */
5815
5842
  listResources(request: $_model.ListResourcesRequest): Promise<$_model.ListResourcesResponse>;
5816
5843
  /**
5817
- * Retrieves a list of routes for a network resource.
5844
+ * Retrieves the route list of a network resource.
5818
5845
  *
5819
5846
  * @remarks
5820
- * This API operation is available for all DataWorks editions.
5847
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
5821
5848
  *
5822
5849
  * @param request - ListRoutesRequest
5823
5850
  * @param runtime - runtime options for this request RuntimeOptions
@@ -5825,10 +5852,10 @@ export default class Client extends OpenApi {
5825
5852
  */
5826
5853
  listRoutesWithOptions(request: $_model.ListRoutesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListRoutesResponse>;
5827
5854
  /**
5828
- * Retrieves a list of routes for a network resource.
5855
+ * Retrieves the route list of a network resource.
5829
5856
  *
5830
5857
  * @remarks
5831
- * This API operation is available for all DataWorks editions.
5858
+ * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
5832
5859
  *
5833
5860
  * @param request - ListRoutesRequest
5834
5861
  * @returns ListRoutesResponse
@@ -5985,6 +6012,21 @@ export default class Client extends OpenApi {
5985
6012
  * @returns ListSkillsResponse
5986
6013
  */
5987
6014
  listSkills(request: $_model.ListSkillsRequest): Promise<$_model.ListSkillsResponse>;
6015
+ /**
6016
+ * Retrieves a list of version snapshots.
6017
+ *
6018
+ * @param request - ListSnapshotsRequest
6019
+ * @param runtime - runtime options for this request RuntimeOptions
6020
+ * @returns ListSnapshotsResponse
6021
+ */
6022
+ listSnapshotsWithOptions(request: $_model.ListSnapshotsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSnapshotsResponse>;
6023
+ /**
6024
+ * Retrieves a list of version snapshots.
6025
+ *
6026
+ * @param request - ListSnapshotsRequest
6027
+ * @returns ListSnapshotsResponse
6028
+ */
6029
+ listSnapshots(request: $_model.ListSnapshotsRequest): Promise<$_model.ListSnapshotsResponse>;
5988
6030
  /**
5989
6031
  * Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.
5990
6032
  *
@@ -6146,10 +6188,10 @@ export default class Client extends OpenApi {
6146
6188
  */
6147
6189
  listWorkflowDefinitions(request: $_model.ListWorkflowDefinitionsRequest): Promise<$_model.ListWorkflowDefinitionsResponse>;
6148
6190
  /**
6149
- * Returns a paginated list of workflow instances that can be filtered by specific criteria.
6191
+ * Retrieves a paging list of workflow instances, with optional filtered query by conditions.
6150
6192
  *
6151
6193
  * @remarks
6152
- * Available with DataWorks Basic Edition or higher.
6194
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6153
6195
  *
6154
6196
  * @param tmpReq - ListWorkflowInstancesRequest
6155
6197
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6157,10 +6199,10 @@ export default class Client extends OpenApi {
6157
6199
  */
6158
6200
  listWorkflowInstancesWithOptions(tmpReq: $_model.ListWorkflowInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListWorkflowInstancesResponse>;
6159
6201
  /**
6160
- * Returns a paginated list of workflow instances that can be filtered by specific criteria.
6202
+ * Retrieves a paging list of workflow instances, with optional filtered query by conditions.
6161
6203
  *
6162
6204
  * @remarks
6163
- * Available with DataWorks Basic Edition or higher.
6205
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6164
6206
  *
6165
6207
  * @param request - ListWorkflowInstancesRequest
6166
6208
  * @returns ListWorkflowInstancesResponse
@@ -6527,10 +6569,10 @@ export default class Client extends OpenApi {
6527
6569
  */
6528
6570
  resumeTaskInstances(request: $_model.ResumeTaskInstancesRequest): Promise<$_model.ResumeTaskInstancesResponse>;
6529
6571
  /**
6530
- * Revokes roles that are assigned to a member in a workspace.
6572
+ * Revokes roles from a workspace member.
6531
6573
  *
6532
6574
  * @remarks
6533
- * This API operation is available for all DataWorks editions.
6575
+ * DataWorks Basic Edition or a more advanced edition is required to use this operation.
6534
6576
  *
6535
6577
  * @param tmpReq - RevokeMemberProjectRolesRequest
6536
6578
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6538,10 +6580,10 @@ export default class Client extends OpenApi {
6538
6580
  */
6539
6581
  revokeMemberProjectRolesWithOptions(tmpReq: $_model.RevokeMemberProjectRolesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RevokeMemberProjectRolesResponse>;
6540
6582
  /**
6541
- * Revokes roles that are assigned to a member in a workspace.
6583
+ * Revokes roles from a workspace member.
6542
6584
  *
6543
6585
  * @remarks
6544
- * This API operation is available for all DataWorks editions.
6586
+ * DataWorks Basic Edition or a more advanced edition is required to use this operation.
6545
6587
  *
6546
6588
  * @param request - RevokeMemberProjectRolesRequest
6547
6589
  * @returns RevokeMemberProjectRolesResponse
@@ -6569,22 +6611,22 @@ export default class Client extends OpenApi {
6569
6611
  */
6570
6612
  rollbackParameter(request: $_model.RollbackParameterRequest): Promise<$_model.RollbackParameterResponse>;
6571
6613
  /**
6572
- * 运行元数据采集器
6614
+ * Triggers a specified metadata crawler to run and returns the submit status and associated task instance information.
6573
6615
  *
6574
6616
  * @remarks
6575
- * ## 使用场景
6576
- * 提交指定元数据采集器的运行请求。
6577
- * ## 推荐流程
6578
- * 1. 调用 `ListCrawlers` 查询可运行的采集器 ID。
6579
- * 2. 调用本接口提交运行请求。
6580
- * 3. 调用 `ListCrawlerRuns` 查询最终运行状态。
6581
- * ## 版本要求
6582
- * 需要购买DataWorks基础版及以上版本才能使用。
6583
- * ## 费用说明
6584
- * 运行采集任务会使用计算资源,可能产生费用,具体以实际使用的资源组和 DataWorks 计费规则为准。
6585
- * 当采集器已开启 AI 元数据描述能力(`EnableAiComment=true`)时,采集元数据并生成 AI 说明会消耗 Token。Token 赠送额度及超出额度后的计费规则,请参见 [Data Agent 费用](https://help.aliyun.com/zh/dataworks/dataworks-data-agent-agent-billing)。
6586
- * ## 注意事项
6587
- * 接口成功仅表示运行请求已受理,不表示采集任务已经完成。
6617
+ * ## Scenarios
6618
+ * Submits a run request for a specified metadata crawler.
6619
+ * ## Recommended process
6620
+ * 1. Call `ListCrawlers` to query the IDs of available crawlers.
6621
+ * 2. Call this operation to submit a run request.
6622
+ * 3. Call `ListCrawlerRuns` to query the final run status.
6623
+ * ## Edition requirements
6624
+ * DataWorks Basic Edition or higher is required.
6625
+ * ## Billing description
6626
+ * Running a collection task consumes compute resources and may incur fees. The actual fees depend on the resource group used and the DataWorks billing rules.
6627
+ * If the crawler has the AI metadata description feature enabled (`EnableAiComment=true`), collecting metadata and generating AI descriptions consumes tokens. For information about the complimentary token quota and billing rules after the quota is exceeded, see [Data Agent billing](https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing).
6628
+ * ## Precautions
6629
+ * A successful response only indicates that the run request has been accepted. It does not indicate that the collection task is complete.
6588
6630
  *
6589
6631
  * @param request - RunCrawlerRequest
6590
6632
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6592,22 +6634,22 @@ export default class Client extends OpenApi {
6592
6634
  */
6593
6635
  runCrawlerWithOptions(request: $_model.RunCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RunCrawlerResponse>;
6594
6636
  /**
6595
- * 运行元数据采集器
6637
+ * Triggers a specified metadata crawler to run and returns the submit status and associated task instance information.
6596
6638
  *
6597
6639
  * @remarks
6598
- * ## 使用场景
6599
- * 提交指定元数据采集器的运行请求。
6600
- * ## 推荐流程
6601
- * 1. 调用 `ListCrawlers` 查询可运行的采集器 ID。
6602
- * 2. 调用本接口提交运行请求。
6603
- * 3. 调用 `ListCrawlerRuns` 查询最终运行状态。
6604
- * ## 版本要求
6605
- * 需要购买DataWorks基础版及以上版本才能使用。
6606
- * ## 费用说明
6607
- * 运行采集任务会使用计算资源,可能产生费用,具体以实际使用的资源组和 DataWorks 计费规则为准。
6608
- * 当采集器已开启 AI 元数据描述能力(`EnableAiComment=true`)时,采集元数据并生成 AI 说明会消耗 Token。Token 赠送额度及超出额度后的计费规则,请参见 [Data Agent 费用](https://help.aliyun.com/zh/dataworks/dataworks-data-agent-agent-billing)。
6609
- * ## 注意事项
6610
- * 接口成功仅表示运行请求已受理,不表示采集任务已经完成。
6640
+ * ## Scenarios
6641
+ * Submits a run request for a specified metadata crawler.
6642
+ * ## Recommended process
6643
+ * 1. Call `ListCrawlers` to query the IDs of available crawlers.
6644
+ * 2. Call this operation to submit a run request.
6645
+ * 3. Call `ListCrawlerRuns` to query the final run status.
6646
+ * ## Edition requirements
6647
+ * DataWorks Basic Edition or higher is required.
6648
+ * ## Billing description
6649
+ * Running a collection task consumes compute resources and may incur fees. The actual fees depend on the resource group used and the DataWorks billing rules.
6650
+ * If the crawler has the AI metadata description feature enabled (`EnableAiComment=true`), collecting metadata and generating AI descriptions consumes tokens. For information about the complimentary token quota and billing rules after the quota is exceeded, see [Data Agent billing](https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing).
6651
+ * ## Precautions
6652
+ * A successful response only indicates that the run request has been accepted. It does not indicate that the collection task is complete.
6611
6653
  *
6612
6654
  * @param request - RunCrawlerRequest
6613
6655
  * @returns RunCrawlerResponse
@@ -6691,10 +6733,10 @@ export default class Client extends OpenApi {
6691
6733
  */
6692
6734
  startDIJob(request: $_model.StartDIJobRequest): Promise<$_model.StartDIJobResponse>;
6693
6735
  /**
6694
- * Start multiple workflow instances in batch.
6736
+ * Starts multiple workflow instances in a batch.
6695
6737
  *
6696
6738
  * @remarks
6697
- * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
6739
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6698
6740
  *
6699
6741
  * @param tmpReq - StartWorkflowInstancesRequest
6700
6742
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6702,29 +6744,29 @@ export default class Client extends OpenApi {
6702
6744
  */
6703
6745
  startWorkflowInstancesWithOptions(tmpReq: $_model.StartWorkflowInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StartWorkflowInstancesResponse>;
6704
6746
  /**
6705
- * Start multiple workflow instances in batch.
6747
+ * Starts multiple workflow instances in a batch.
6706
6748
  *
6707
6749
  * @remarks
6708
- * You must purchase DataWorks Basic Edition or a higher edition to use this feature.
6750
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6709
6751
  *
6710
6752
  * @param request - StartWorkflowInstancesRequest
6711
6753
  * @returns StartWorkflowInstancesResponse
6712
6754
  */
6713
6755
  startWorkflowInstances(request: $_model.StartWorkflowInstancesRequest): Promise<$_model.StartWorkflowInstancesResponse>;
6714
6756
  /**
6715
- * 停止元数据采集器运行
6757
+ * Stops the currently running task of a specified metadata crawler.
6716
6758
  *
6717
6759
  * @remarks
6718
- * ## 使用场景
6719
- * 停止指定元数据采集器当前正在执行的运行任务。
6720
- * ## 推荐流程
6721
- * 1. 调用 `ListCrawlerRuns` 确认采集器存在正在执行的运行任务。
6722
- * 2. 调用本接口提交停止请求。
6723
- * 3. 再次调用 `ListCrawlerRuns` 确认最终运行状态。
6724
- * ## 版本要求
6725
- * 需要购买DataWorks基础版及以上版本才能使用。
6726
- * ## 注意事项
6727
- * 没有正在执行的运行任务时调用会失败。接口成功仅表示停止请求已受理。
6760
+ * ## Scenarios
6761
+ * Stops the currently running task of a specified metadata crawler.
6762
+ * ## Recommended workflow
6763
+ * 1. Call `ListCrawlerRuns` to confirm that the crawler has a running task.
6764
+ * 2. Call this operation to submit a stop request.
6765
+ * 3. Call `ListCrawlerRuns` again to confirm the final run status.
6766
+ * ## Edition requirements
6767
+ * DataWorks Basic Edition or a more advanced edition is required.
6768
+ * ## Precautions
6769
+ * The call fails if the crawler has no running task. A successful response only indicates that the stop request has been accepted.
6728
6770
  *
6729
6771
  * @param request - StopCrawlerRequest
6730
6772
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6732,19 +6774,19 @@ export default class Client extends OpenApi {
6732
6774
  */
6733
6775
  stopCrawlerWithOptions(request: $_model.StopCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopCrawlerResponse>;
6734
6776
  /**
6735
- * 停止元数据采集器运行
6777
+ * Stops the currently running task of a specified metadata crawler.
6736
6778
  *
6737
6779
  * @remarks
6738
- * ## 使用场景
6739
- * 停止指定元数据采集器当前正在执行的运行任务。
6740
- * ## 推荐流程
6741
- * 1. 调用 `ListCrawlerRuns` 确认采集器存在正在执行的运行任务。
6742
- * 2. 调用本接口提交停止请求。
6743
- * 3. 再次调用 `ListCrawlerRuns` 确认最终运行状态。
6744
- * ## 版本要求
6745
- * 需要购买DataWorks基础版及以上版本才能使用。
6746
- * ## 注意事项
6747
- * 没有正在执行的运行任务时调用会失败。接口成功仅表示停止请求已受理。
6780
+ * ## Scenarios
6781
+ * Stops the currently running task of a specified metadata crawler.
6782
+ * ## Recommended workflow
6783
+ * 1. Call `ListCrawlerRuns` to confirm that the crawler has a running task.
6784
+ * 2. Call this operation to submit a stop request.
6785
+ * 3. Call `ListCrawlerRuns` again to confirm the final run status.
6786
+ * ## Edition requirements
6787
+ * DataWorks Basic Edition or a more advanced edition is required.
6788
+ * ## Precautions
6789
+ * The call fails if the crawler has no running task. A successful response only indicates that the stop request has been accepted.
6748
6790
  *
6749
6791
  * @param request - StopCrawlerRequest
6750
6792
  * @returns StopCrawlerResponse
@@ -6799,10 +6841,10 @@ export default class Client extends OpenApi {
6799
6841
  */
6800
6842
  stopProcessInstance(request: $_model.StopProcessInstanceRequest): Promise<$_model.StopProcessInstanceResponse>;
6801
6843
  /**
6802
- * Stops multiple instances at a time.
6844
+ * Stops multiple instances in a batch.
6803
6845
  *
6804
6846
  * @remarks
6805
- * This API operation is available for all DataWorks editions.
6847
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6806
6848
  *
6807
6849
  * @param tmpReq - StopTaskInstancesRequest
6808
6850
  * @param runtime - runtime options for this request RuntimeOptions
@@ -6810,10 +6852,10 @@ export default class Client extends OpenApi {
6810
6852
  */
6811
6853
  stopTaskInstancesWithOptions(tmpReq: $_model.StopTaskInstancesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopTaskInstancesResponse>;
6812
6854
  /**
6813
- * Stops multiple instances at a time.
6855
+ * Stops multiple instances in a batch.
6814
6856
  *
6815
6857
  * @remarks
6816
- * This API operation is available for all DataWorks editions.
6858
+ * You must purchase DataWorks Basic Edition or a higher edition to use this operation.
6817
6859
  *
6818
6860
  * @param request - StopTaskInstancesRequest
6819
6861
  * @returns StopTaskInstancesResponse
@@ -7064,19 +7106,19 @@ export default class Client extends OpenApi {
7064
7106
  */
7065
7107
  updateComputeResource(request: $_model.UpdateComputeResourceRequest): Promise<$_model.UpdateComputeResourceResponse>;
7066
7108
  /**
7067
- * 更新元数据采集器
7109
+ * Updates the resource group, collection scope, scheduling, and extension configurations of a specified metadata crawler.
7068
7110
  *
7069
7111
  * @remarks
7070
- * ## 使用场景
7071
- * 部分更新指定元数据采集器的资源组、采集范围、调度、AI 元数据描述或扩展配置。
7072
- * ## 推荐流程
7073
- * 1. 调用 `GetCrawler` 查询当前配置。
7074
- * 2. 调用 `GetCrawlerTypeCapabilities` 确认该采集器类型支持的配置能力。
7075
- * 3. 仅传入需要更新的字段调用本接口。
7076
- * ## 版本要求
7077
- * 需要购买DataWorks基础版及以上版本才能使用。
7078
- * ## 注意事项
7079
- * 至少需要提供一个可更新字段;未提供的字段保持不变。
7112
+ * ## Scenarios
7113
+ * Partially updates the resource group, collection scope, scheduling, AI metadata description, or extension configurations of a specified metadata crawler.
7114
+ * ## Recommended workflow
7115
+ * 1. Call `GetCrawler` to query the current configurations.
7116
+ * 2. Call `GetCrawlerTypeCapabilities` to check the configuration capabilities supported by the crawler type.
7117
+ * 3. Call this operation with only the fields that you want to update.
7118
+ * ## Edition requirements
7119
+ * DataWorks Basic Edition or a more advanced edition is required.
7120
+ * ## Precautions
7121
+ * At least one updatable field must be provided. Fields that are not provided remain unchanged.
7080
7122
  *
7081
7123
  * @param tmpReq - UpdateCrawlerRequest
7082
7124
  * @param runtime - runtime options for this request RuntimeOptions
@@ -7084,19 +7126,19 @@ export default class Client extends OpenApi {
7084
7126
  */
7085
7127
  updateCrawlerWithOptions(tmpReq: $_model.UpdateCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCrawlerResponse>;
7086
7128
  /**
7087
- * 更新元数据采集器
7129
+ * Updates the resource group, collection scope, scheduling, and extension configurations of a specified metadata crawler.
7088
7130
  *
7089
7131
  * @remarks
7090
- * ## 使用场景
7091
- * 部分更新指定元数据采集器的资源组、采集范围、调度、AI 元数据描述或扩展配置。
7092
- * ## 推荐流程
7093
- * 1. 调用 `GetCrawler` 查询当前配置。
7094
- * 2. 调用 `GetCrawlerTypeCapabilities` 确认该采集器类型支持的配置能力。
7095
- * 3. 仅传入需要更新的字段调用本接口。
7096
- * ## 版本要求
7097
- * 需要购买DataWorks基础版及以上版本才能使用。
7098
- * ## 注意事项
7099
- * 至少需要提供一个可更新字段;未提供的字段保持不变。
7132
+ * ## Scenarios
7133
+ * Partially updates the resource group, collection scope, scheduling, AI metadata description, or extension configurations of a specified metadata crawler.
7134
+ * ## Recommended workflow
7135
+ * 1. Call `GetCrawler` to query the current configurations.
7136
+ * 2. Call `GetCrawlerTypeCapabilities` to check the configuration capabilities supported by the crawler type.
7137
+ * 3. Call this operation with only the fields that you want to update.
7138
+ * ## Edition requirements
7139
+ * DataWorks Basic Edition or a more advanced edition is required.
7140
+ * ## Precautions
7141
+ * At least one updatable field must be provided. Fields that are not provided remain unchanged.
7100
7142
  *
7101
7143
  * @param request - UpdateCrawlerRequest
7102
7144
  * @returns UpdateCrawlerResponse
@@ -7154,10 +7196,10 @@ export default class Client extends OpenApi {
7154
7196
  */
7155
7197
  updateDIJob(request: $_model.UpdateDIJobRequest): Promise<$_model.UpdateDIJobResponse>;
7156
7198
  /**
7157
- * Updates a tag.
7199
+ * Updates a label.
7158
7200
  *
7159
7201
  * @remarks
7160
- * This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.
7202
+ * You must purchase DataWorks Enterprise Edition or a higher edition to use this feature.
7161
7203
  *
7162
7204
  * @param tmpReq - UpdateDataAssetTagRequest
7163
7205
  * @param runtime - runtime options for this request RuntimeOptions
@@ -7165,10 +7207,10 @@ export default class Client extends OpenApi {
7165
7207
  */
7166
7208
  updateDataAssetTagWithOptions(tmpReq: $_model.UpdateDataAssetTagRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateDataAssetTagResponse>;
7167
7209
  /**
7168
- * Updates a tag.
7210
+ * Updates a label.
7169
7211
  *
7170
7212
  * @remarks
7171
- * This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.
7213
+ * You must purchase DataWorks Enterprise Edition or a higher edition to use this feature.
7172
7214
  *
7173
7215
  * @param request - UpdateDataAssetTagRequest
7174
7216
  * @returns UpdateDataAssetTagResponse
@@ -7178,7 +7220,7 @@ export default class Client extends OpenApi {
7178
7220
  * Updates a specified data quality monitoring alert rule.
7179
7221
  *
7180
7222
  * @remarks
7181
- * DataWorks Basic Edition or a higher edition is required.
7223
+ * DataWorks Basic Edition or a more advanced edition is required.
7182
7224
  *
7183
7225
  * @param tmpReq - UpdateDataQualityAlertRuleRequest
7184
7226
  * @param runtime - runtime options for this request RuntimeOptions
@@ -7189,7 +7231,7 @@ export default class Client extends OpenApi {
7189
7231
  * Updates a specified data quality monitoring alert rule.
7190
7232
  *
7191
7233
  * @remarks
7192
- * DataWorks Basic Edition or a higher edition is required.
7234
+ * DataWorks Basic Edition or a more advanced edition is required.
7193
7235
  *
7194
7236
  * @param request - UpdateDataQualityAlertRuleRequest
7195
7237
  * @returns UpdateDataQualityAlertRuleResponse
@@ -7421,9 +7463,9 @@ export default class Client extends OpenApi {
7421
7463
  * Updates an MCP Server.
7422
7464
  *
7423
7465
  * @remarks
7424
- * ## Description
7425
- * This API updates the configuration of a specified MCP Server. Omitted fields retain their original values.
7426
- * **Note**: When you modify the`Visibility` parameter, you must provide either`ProjectIds` or`UserIds` in`VisibilityScope` to apply the correct access control scope.
7466
+ * ## Operation description
7467
+ * This API operation allows you to update the configuration of a specified MCP Server, including the service URL, transport protocol, custom request headers, and visibility settings. Fields that are not provided retain their existing values.
7468
+ * **Note**: When you modify the `Visibility` parameter, selectively provide `ProjectIds` or `UserIds` in `VisibilityScope` based on the visibility setting to ensure that the correct access control scope is applied.
7427
7469
  *
7428
7470
  * @param tmpReq - UpdateMcpServerRequest
7429
7471
  * @param runtime - runtime options for this request RuntimeOptions
@@ -7434,9 +7476,9 @@ export default class Client extends OpenApi {
7434
7476
  * Updates an MCP Server.
7435
7477
  *
7436
7478
  * @remarks
7437
- * ## Description
7438
- * This API updates the configuration of a specified MCP Server. Omitted fields retain their original values.
7439
- * **Note**: When you modify the`Visibility` parameter, you must provide either`ProjectIds` or`UserIds` in`VisibilityScope` to apply the correct access control scope.
7479
+ * ## Operation description
7480
+ * This API operation allows you to update the configuration of a specified MCP Server, including the service URL, transport protocol, custom request headers, and visibility settings. Fields that are not provided retain their existing values.
7481
+ * **Note**: When you modify the `Visibility` parameter, selectively provide `ProjectIds` or `UserIds` in `VisibilityScope` based on the visibility setting to ensure that the correct access control scope is applied.
7440
7482
  *
7441
7483
  * @param request - UpdateMcpServerRequest
7442
7484
  * @returns UpdateMcpServerResponse