@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.
- package/dist/client.d.ts +542 -500
- package/dist/client.js +603 -501
- package/dist/client.js.map +1 -1
- package/dist/models/AbolishPipelineRunRequest.d.ts +3 -3
- package/dist/models/AbolishPipelineRunResponseBody.d.ts +3 -5
- package/dist/models/AbolishPipelineRunResponseBody.js.map +1 -1
- package/dist/models/AddEntityIntoMetaCollectionRequest.d.ts +3 -3
- package/dist/models/ApproveProcessInstanceRequest.d.ts +5 -5
- package/dist/models/ApproveProcessInstanceResponseBody.d.ts +1 -1
- package/dist/models/AttachDataQualityRulesToEvaluationTaskRequest.d.ts +4 -3
- package/dist/models/AttachDataQualityRulesToEvaluationTaskRequest.js.map +1 -1
- package/dist/models/AttachDataQualityRulesToEvaluationTaskResponseBody.d.ts +3 -2
- package/dist/models/AttachDataQualityRulesToEvaluationTaskResponseBody.js.map +1 -1
- package/dist/models/AttachDataQualityRulesToEvaluationTaskShrinkRequest.d.ts +4 -3
- package/dist/models/AttachDataQualityRulesToEvaluationTaskShrinkRequest.js.map +1 -1
- package/dist/models/BatchCreateMetaEntitiesRequest.d.ts +9 -11
- package/dist/models/BatchCreateMetaEntitiesRequest.js.map +1 -1
- package/dist/models/BatchCreateMetaEntitiesResponseBody.d.ts +3 -3
- package/dist/models/BatchCreateMetaEntitiesShrinkRequest.d.ts +1 -1
- package/dist/models/BatchDeleteMetaEntitiesRequest.d.ts +1 -1
- package/dist/models/BatchDeleteMetaEntitiesResponseBody.d.ts +3 -3
- package/dist/models/BatchDeleteMetaEntitiesShrinkRequest.d.ts +1 -1
- package/dist/models/BatchUpdateTasksRequest.d.ts +29 -39
- package/dist/models/BatchUpdateTasksRequest.js.map +1 -1
- package/dist/models/BatchUpdateTasksResponseBody.d.ts +2 -2
- package/dist/models/BatchUpdateTasksShrinkRequest.d.ts +1 -1
- package/dist/models/CancelAgentSessionRequest.d.ts +1 -1
- package/dist/models/CancelAgentSessionResponseBody.d.ts +2 -2
- package/dist/models/CancelAgentSessionShrinkRequest.d.ts +1 -1
- package/dist/models/Catalog.d.ts +0 -37
- package/dist/models/Catalog.js.map +1 -1
- package/dist/models/CloneDataSourceRequest.d.ts +2 -2
- package/dist/models/CloneDataSourceResponseBody.d.ts +2 -2
- package/dist/models/Column.d.ts +3 -3
- package/dist/models/CrawlerType.d.ts +0 -39
- package/dist/models/CrawlerType.js.map +1 -1
- package/dist/models/CreateAlertRuleRequest.d.ts +62 -90
- package/dist/models/CreateAlertRuleRequest.js.map +1 -1
- package/dist/models/CreateAlertRuleResponseBody.d.ts +2 -2
- package/dist/models/CreateAlertRuleShrinkRequest.d.ts +5 -5
- package/dist/models/CreateComponentRequest.d.ts +3 -3
- package/dist/models/CreateComponentResponseBody.d.ts +1 -1
- package/dist/models/CreateComputeResourceRequest.d.ts +5 -5
- package/dist/models/CreateComputeResourceResponseBody.d.ts +2 -2
- package/dist/models/CreateCrawlerRequest.d.ts +39 -0
- package/dist/models/CreateCrawlerRequest.js.map +1 -1
- package/dist/models/CreateCrawlerResponseBody.d.ts +10 -0
- package/dist/models/CreateCrawlerResponseBody.js.map +1 -1
- package/dist/models/CreateCrawlerShrinkRequest.d.ts +25 -0
- package/dist/models/CreateCrawlerShrinkRequest.js.map +1 -1
- package/dist/models/CreateDataQualityAlertRuleRequest.d.ts +8 -16
- package/dist/models/CreateDataQualityAlertRuleRequest.js.map +1 -1
- package/dist/models/CreateDataQualityAlertRuleResponseBody.d.ts +1 -1
- package/dist/models/CreateDataQualityAlertRuleShrinkRequest.d.ts +2 -2
- package/dist/models/CreateDataQualityEvaluationTaskInstanceRequest.d.ts +8 -8
- package/dist/models/CreateDataQualityEvaluationTaskInstanceResponseBody.d.ts +1 -1
- package/dist/models/CreateDataQualityEvaluationTaskInstanceShrinkRequest.d.ts +6 -6
- package/dist/models/CreateDataQualityEvaluationTaskRequest.d.ts +64 -104
- package/dist/models/CreateDataQualityEvaluationTaskRequest.js.map +1 -1
- package/dist/models/CreateDataQualityEvaluationTaskResponseBody.d.ts +1 -1
- package/dist/models/CreateDataQualityEvaluationTaskShrinkRequest.d.ts +9 -15
- package/dist/models/CreateDataQualityEvaluationTaskShrinkRequest.js.map +1 -1
- package/dist/models/CreateDataQualityRuleTemplateRequest.d.ts +28 -25
- package/dist/models/CreateDataQualityRuleTemplateRequest.js.map +1 -1
- package/dist/models/CreateDataQualityRuleTemplateResponseBody.d.ts +2 -2
- package/dist/models/CreateDataQualityRuleTemplateShrinkRequest.d.ts +7 -6
- package/dist/models/CreateDataQualityRuleTemplateShrinkRequest.js.map +1 -1
- package/dist/models/CreateDataQualityScanRunRequest.d.ts +9 -11
- package/dist/models/CreateDataQualityScanRunRequest.js.map +1 -1
- package/dist/models/CreateDataQualityScanRunResponseBody.d.ts +1 -1
- package/dist/models/CreateDataQualityScanRunShrinkRequest.d.ts +3 -3
- package/dist/models/CreateDataSourceRequest.d.ts +12 -16
- package/dist/models/CreateDataSourceRequest.js.map +1 -1
- package/dist/models/CreateDataSourceResponseBody.d.ts +2 -2
- package/dist/models/CreateDatasetRequest.d.ts +27 -53
- package/dist/models/CreateDatasetRequest.js.map +1 -1
- package/dist/models/CreateDatasetResponseBody.d.ts +1 -1
- package/dist/models/CreateDatasetShrinkRequest.d.ts +15 -42
- package/dist/models/CreateDatasetShrinkRequest.js.map +1 -1
- package/dist/models/CreateDatasetVersionRequest.d.ts +13 -12
- package/dist/models/CreateDatasetVersionRequest.js.map +1 -1
- package/dist/models/CreateDatasetVersionResponseBody.d.ts +1 -1
- package/dist/models/CreateDatasetVersionShrinkRequest.d.ts +13 -12
- package/dist/models/CreateDatasetVersionShrinkRequest.js.map +1 -1
- package/dist/models/CreateDialarmRuleRequest.d.ts +28 -46
- package/dist/models/CreateDialarmRuleRequest.js.map +1 -1
- package/dist/models/CreateDialarmRuleResponseBody.d.ts +2 -2
- package/dist/models/CreateDialarmRuleShrinkRequest.d.ts +9 -14
- package/dist/models/CreateDialarmRuleShrinkRequest.js.map +1 -1
- package/dist/models/CreateDijobRequest.d.ts +141 -211
- package/dist/models/CreateDijobRequest.js.map +1 -1
- package/dist/models/CreateDijobResponseBody.d.ts +3 -3
- package/dist/models/CreateDijobShrinkRequest.d.ts +25 -29
- package/dist/models/CreateDijobShrinkRequest.js.map +1 -1
- package/dist/models/CreateFunctionRequest.d.ts +2 -2
- package/dist/models/CreateFunctionResponseBody.d.ts +2 -2
- package/dist/models/CreateMcpServerRequest.d.ts +7 -7
- package/dist/models/CreateMcpServerResponseBody.d.ts +4 -2
- package/dist/models/CreateMcpServerResponseBody.js.map +1 -1
- package/dist/models/CreateMcpServerShrinkRequest.d.ts +3 -3
- package/dist/models/CreateNodeRequest.d.ts +17 -18
- package/dist/models/CreateNodeRequest.js.map +1 -1
- package/dist/models/CreateNodeResponseBody.d.ts +3 -3
- package/dist/models/CreateProjectMemberRequest.d.ts +5 -5
- package/dist/models/CreateProjectMemberResponseBody.d.ts +1 -1
- package/dist/models/CreateProjectMemberShrinkRequest.d.ts +5 -5
- package/dist/models/CreateProjectRequest.d.ts +16 -16
- package/dist/models/CreateProjectResponseBody.d.ts +4 -3
- package/dist/models/CreateProjectResponseBody.js.map +1 -1
- package/dist/models/CreateProjectShrinkRequest.d.ts +16 -16
- package/dist/models/CreateResourceAdvanceRequest.d.ts +4 -5
- package/dist/models/CreateResourceAdvanceRequest.js.map +1 -1
- package/dist/models/CreateResourceGroupRequest.d.ts +14 -10
- package/dist/models/CreateResourceGroupRequest.js.map +1 -1
- package/dist/models/CreateResourceGroupResponseBody.d.ts +5 -5
- package/dist/models/CreateResourceGroupShrinkRequest.d.ts +14 -10
- package/dist/models/CreateResourceGroupShrinkRequest.js.map +1 -1
- package/dist/models/CreateResourceRequest.d.ts +4 -5
- package/dist/models/CreateResourceRequest.js.map +1 -1
- package/dist/models/CreateResourceResponseBody.d.ts +2 -2
- package/dist/models/CreateWorkflowDefinitionRequest.d.ts +7 -2
- package/dist/models/CreateWorkflowDefinitionRequest.js.map +1 -1
- package/dist/models/CreateWorkflowDefinitionResponseBody.d.ts +3 -3
- package/dist/models/DataQualityRule.d.ts +0 -9
- package/dist/models/DataQualityRule.js.map +1 -1
- package/dist/models/Database.d.ts +7 -43
- package/dist/models/Database.js.map +1 -1
- package/dist/models/DeleteAlertRuleRequest.d.ts +1 -1
- package/dist/models/DeleteAlertRuleResponseBody.d.ts +2 -2
- package/dist/models/DeleteCertificateRequest.d.ts +2 -2
- package/dist/models/DeleteCertificateResponseBody.d.ts +2 -2
- package/dist/models/DeleteComponentRequest.d.ts +3 -3
- package/dist/models/DeleteCrawlerRequest.d.ts +2 -0
- package/dist/models/DeleteCrawlerRequest.js.map +1 -1
- package/dist/models/DeleteCrawlerResponseBody.d.ts +10 -0
- package/dist/models/DeleteCrawlerResponseBody.js.map +1 -1
- package/dist/models/DeleteDatasetResponseBody.d.ts +1 -1
- package/dist/models/DeleteNetworkRequest.d.ts +1 -1
- package/dist/models/DeleteNetworkResponseBody.d.ts +1 -1
- package/dist/models/DeleteProjectMemberRequest.d.ts +2 -2
- package/dist/models/DeleteProjectMemberResponseBody.d.ts +1 -1
- package/dist/models/DeleteWorkflowDefinitionRequest.d.ts +3 -3
- package/dist/models/DeleteWorkflowDefinitionResponseBody.d.ts +4 -4
- package/dist/models/DeployFileRequest.d.ts +10 -4
- package/dist/models/DeployFileRequest.js.map +1 -1
- package/dist/models/DeployFileResponseBody.d.ts +3 -4
- package/dist/models/DeployFileResponseBody.js.map +1 -1
- package/dist/models/ExecPipelineRunStageRequest.d.ts +3 -3
- package/dist/models/ExecPipelineRunStageResponseBody.d.ts +5 -10
- package/dist/models/ExecPipelineRunStageResponseBody.js.map +1 -1
- package/dist/models/ExecuteAdhocWorkflowInstanceRequest.d.ts +27 -33
- package/dist/models/ExecuteAdhocWorkflowInstanceRequest.js.map +1 -1
- package/dist/models/ExecuteAdhocWorkflowInstanceResponseBody.d.ts +1 -1
- package/dist/models/ExecuteAdhocWorkflowInstanceShrinkRequest.d.ts +7 -9
- package/dist/models/ExecuteAdhocWorkflowInstanceShrinkRequest.js.map +1 -1
- package/dist/models/GetAlertRuleRequest.d.ts +1 -1
- package/dist/models/GetAlertRuleResponseBody.d.ts +66 -90
- package/dist/models/GetAlertRuleResponseBody.js.map +1 -1
- package/dist/models/GetBusinessRequest.d.ts +3 -3
- package/dist/models/GetBusinessResponseBody.d.ts +10 -11
- package/dist/models/GetBusinessResponseBody.js.map +1 -1
- package/dist/models/GetCatalogRequest.d.ts +7 -5
- package/dist/models/GetCatalogRequest.js.map +1 -1
- package/dist/models/GetCatalogResponseBody.d.ts +1 -1
- package/dist/models/GetCrawlerRequest.d.ts +2 -0
- package/dist/models/GetCrawlerRequest.js.map +1 -1
- package/dist/models/GetCrawlerResponseBody.d.ts +88 -0
- package/dist/models/GetCrawlerResponseBody.js.map +1 -1
- package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.d.ts +82 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.js.map +1 -1
- package/dist/models/GetDataSourceRequest.d.ts +1 -1
- package/dist/models/GetDataSourceResponseBody.d.ts +17 -22
- package/dist/models/GetDataSourceResponseBody.js.map +1 -1
- package/dist/models/GetDeploymentPackageRequest.d.ts +10 -4
- package/dist/models/GetDeploymentPackageRequest.js.map +1 -1
- package/dist/models/GetDeploymentPackageResponseBody.d.ts +39 -35
- package/dist/models/GetDeploymentPackageResponseBody.js.map +1 -1
- package/dist/models/GetDijobLogRequest.d.ts +6 -7
- package/dist/models/GetDijobLogRequest.js.map +1 -1
- package/dist/models/GetDijobLogResponseBody.d.ts +2 -2
- package/dist/models/GetFileVersionRequest.d.ts +4 -4
- package/dist/models/GetFileVersionResponseBody.d.ts +32 -48
- package/dist/models/GetFileVersionResponseBody.js.map +1 -1
- package/dist/models/GetImageRequest.d.ts +1 -1
- package/dist/models/GetImageResponseBody.d.ts +28 -50
- package/dist/models/GetImageResponseBody.js.map +1 -1
- package/dist/models/GetJobStatusRequest.d.ts +1 -1
- package/dist/models/GetJobStatusResponseBody.d.ts +18 -18
- package/dist/models/GetLineageRelationshipRequest.d.ts +1 -1
- package/dist/models/GetLineageRelationshipResponseBody.d.ts +1 -1
- package/dist/models/GetPipelineRunRequest.d.ts +3 -3
- package/dist/models/GetPipelineRunResponseBody.d.ts +36 -48
- package/dist/models/GetPipelineRunResponseBody.js.map +1 -1
- package/dist/models/GetProjectRequest.d.ts +2 -2
- package/dist/models/GetProjectResponseBody.d.ts +23 -31
- package/dist/models/GetProjectResponseBody.js.map +1 -1
- package/dist/models/GetResourceGroupRequest.d.ts +1 -1
- package/dist/models/GetResourceGroupResponseBody.d.ts +33 -44
- package/dist/models/GetResourceGroupResponseBody.js.map +1 -1
- package/dist/models/GetSnapshotRequest.d.ts +23 -0
- package/dist/models/GetSnapshotRequest.js +58 -0
- package/dist/models/GetSnapshotRequest.js.map +1 -0
- package/dist/models/GetSnapshotResponse.d.ts +19 -0
- package/dist/models/GetSnapshotResponse.js +69 -0
- package/dist/models/GetSnapshotResponse.js.map +1 -0
- package/dist/models/GetSnapshotResponseBody.d.ts +151 -0
- package/dist/models/GetSnapshotResponseBody.js +126 -0
- package/dist/models/GetSnapshotResponseBody.js.map +1 -0
- package/dist/models/KillSemanticJobRequest.d.ts +3 -3
- package/dist/models/LineageEntity.d.ts +2 -7
- package/dist/models/LineageEntity.js.map +1 -1
- package/dist/models/LineageRelationship.d.ts +2 -2
- package/dist/models/ListAgentSessionArtifactsRequest.d.ts +5 -5
- package/dist/models/ListAgentSessionArtifactsResponseBody.d.ts +9 -9
- package/dist/models/ListAgentSessionArtifactsShrinkRequest.d.ts +1 -1
- package/dist/models/ListAgentsRequest.d.ts +3 -3
- package/dist/models/ListAgentsResponseBody.d.ts +3 -3
- package/dist/models/ListAgentsShrinkRequest.d.ts +2 -2
- package/dist/models/ListCrawlerRunsRequest.d.ts +17 -0
- package/dist/models/ListCrawlerRunsRequest.js.map +1 -1
- package/dist/models/ListCrawlerRunsResponseBody.d.ts +42 -0
- package/dist/models/ListCrawlerRunsResponseBody.js.map +1 -1
- package/dist/models/ListCrawlersRequest.d.ts +25 -0
- package/dist/models/ListCrawlersRequest.js.map +1 -1
- package/dist/models/ListCrawlersResponseBody.d.ts +76 -0
- package/dist/models/ListCrawlersResponseBody.js.map +1 -1
- package/dist/models/ListCrawlersShrinkRequest.d.ts +25 -0
- package/dist/models/ListCrawlersShrinkRequest.js.map +1 -1
- package/dist/models/ListDataQualityRuleTemplatesRequest.d.ts +8 -7
- package/dist/models/ListDataQualityRuleTemplatesRequest.js.map +1 -1
- package/dist/models/ListDataQualityRuleTemplatesResponseBody.d.ts +30 -27
- package/dist/models/ListDataQualityRuleTemplatesResponseBody.js.map +1 -1
- package/dist/models/ListDataQualityRulesRequest.d.ts +6 -6
- package/dist/models/ListDataQualityRulesResponseBody.d.ts +65 -65
- package/dist/models/ListDeploymentPackageFilesRequest.d.ts +13 -15
- package/dist/models/ListDeploymentPackageFilesRequest.js.map +1 -1
- package/dist/models/ListDeploymentPackageFilesResponseBody.d.ts +48 -69
- package/dist/models/ListDeploymentPackageFilesResponseBody.js.map +1 -1
- package/dist/models/ListDeploymentPackageFilesShrinkRequest.d.ts +13 -15
- package/dist/models/ListDeploymentPackageFilesShrinkRequest.js.map +1 -1
- package/dist/models/ListDeploymentPackagesRequest.d.ts +13 -17
- package/dist/models/ListDeploymentPackagesRequest.js.map +1 -1
- package/dist/models/ListDeploymentPackagesResponseBody.d.ts +13 -16
- package/dist/models/ListDeploymentPackagesResponseBody.js.map +1 -1
- package/dist/models/ListDownstreamTaskInstancesRequest.d.ts +1 -1
- package/dist/models/ListDownstreamTaskInstancesResponseBody.d.ts +73 -182
- package/dist/models/ListDownstreamTaskInstancesResponseBody.js.map +1 -1
- package/dist/models/ListFileVersionsRequest.d.ts +5 -5
- package/dist/models/ListFileVersionsResponseBody.d.ts +19 -21
- package/dist/models/ListFileVersionsResponseBody.js.map +1 -1
- package/dist/models/ListFilesRequest.d.ts +20 -25
- package/dist/models/ListFilesRequest.js.map +1 -1
- package/dist/models/ListFilesResponseBody.d.ts +32 -40
- package/dist/models/ListFilesResponseBody.js.map +1 -1
- package/dist/models/ListFoldersRequest.d.ts +8 -4
- package/dist/models/ListFoldersRequest.js.map +1 -1
- package/dist/models/ListFoldersResponseBody.d.ts +11 -12
- package/dist/models/ListFoldersResponseBody.js.map +1 -1
- package/dist/models/ListFunctionsRequest.d.ts +9 -14
- package/dist/models/ListFunctionsRequest.js.map +1 -1
- package/dist/models/ListFunctionsResponseBody.d.ts +35 -43
- package/dist/models/ListFunctionsResponseBody.js.map +1 -1
- package/dist/models/ListLineageRelationshipsRequest.d.ts +1 -1
- package/dist/models/ListLineagesRequest.d.ts +11 -13
- package/dist/models/ListLineagesRequest.js.map +1 -1
- package/dist/models/ListLineagesResponseBody.d.ts +5 -5
- package/dist/models/ListNodesRequest.d.ts +17 -21
- package/dist/models/ListNodesRequest.js.map +1 -1
- package/dist/models/ListNodesResponseBody.d.ts +78 -122
- package/dist/models/ListNodesResponseBody.js.map +1 -1
- package/dist/models/ListResourcesRequest.d.ts +7 -10
- package/dist/models/ListResourcesRequest.js.map +1 -1
- package/dist/models/ListResourcesResponseBody.d.ts +22 -28
- package/dist/models/ListResourcesResponseBody.js.map +1 -1
- package/dist/models/ListRoutesRequest.d.ts +6 -8
- package/dist/models/ListRoutesRequest.js.map +1 -1
- package/dist/models/ListRoutesResponseBody.d.ts +9 -9
- package/dist/models/ListSnapshotsRequest.d.ts +59 -0
- package/dist/models/ListSnapshotsRequest.js +66 -0
- package/dist/models/ListSnapshotsRequest.js.map +1 -0
- package/dist/models/ListSnapshotsResponse.d.ts +19 -0
- package/dist/models/ListSnapshotsResponse.js +69 -0
- package/dist/models/ListSnapshotsResponse.js.map +1 -0
- package/dist/models/ListSnapshotsResponseBody.d.ts +143 -0
- package/dist/models/ListSnapshotsResponseBody.js +124 -0
- package/dist/models/ListSnapshotsResponseBody.js.map +1 -0
- package/dist/models/ListWorkflowInstancesRequest.d.ts +20 -26
- package/dist/models/ListWorkflowInstancesRequest.js.map +1 -1
- package/dist/models/ListWorkflowInstancesResponseBody.d.ts +33 -39
- package/dist/models/ListWorkflowInstancesResponseBody.js.map +1 -1
- package/dist/models/ListWorkflowInstancesShrinkRequest.d.ts +20 -26
- package/dist/models/ListWorkflowInstancesShrinkRequest.js.map +1 -1
- package/dist/models/Partition.d.ts +0 -18
- package/dist/models/Partition.js.map +1 -1
- package/dist/models/RevokeMemberProjectRolesRequest.d.ts +4 -4
- package/dist/models/RevokeMemberProjectRolesResponseBody.d.ts +1 -1
- package/dist/models/RevokeMemberProjectRolesShrinkRequest.d.ts +4 -4
- package/dist/models/RunCrawlerRequest.d.ts +2 -0
- package/dist/models/RunCrawlerRequest.js.map +1 -1
- package/dist/models/RunCrawlerResponseBody.d.ts +20 -0
- package/dist/models/RunCrawlerResponseBody.js.map +1 -1
- package/dist/models/Schema.d.ts +9 -19
- package/dist/models/Schema.js.map +1 -1
- package/dist/models/StartWorkflowInstancesRequest.d.ts +1 -1
- package/dist/models/StartWorkflowInstancesResponseBody.d.ts +2 -2
- package/dist/models/StartWorkflowInstancesShrinkRequest.d.ts +1 -1
- package/dist/models/StopCrawlerRequest.d.ts +2 -0
- package/dist/models/StopCrawlerRequest.js.map +1 -1
- package/dist/models/StopCrawlerResponseBody.d.ts +14 -0
- package/dist/models/StopCrawlerResponseBody.js.map +1 -1
- package/dist/models/StopTaskInstancesRequest.d.ts +2 -2
- package/dist/models/StopTaskInstancesResponseBody.d.ts +2 -2
- package/dist/models/StopTaskInstancesShrinkRequest.d.ts +2 -2
- package/dist/models/SuccessInfoValue.d.ts +1 -1
- package/dist/models/Table.d.ts +10 -3
- package/dist/models/Table.js.map +1 -1
- package/dist/models/UpdateCrawlerRequest.d.ts +35 -0
- package/dist/models/UpdateCrawlerRequest.js.map +1 -1
- package/dist/models/UpdateCrawlerResponseBody.d.ts +10 -0
- package/dist/models/UpdateCrawlerResponseBody.js.map +1 -1
- package/dist/models/UpdateCrawlerShrinkRequest.d.ts +21 -0
- package/dist/models/UpdateCrawlerShrinkRequest.js.map +1 -1
- package/dist/models/UpdateDataAssetTagRequest.d.ts +4 -4
- package/dist/models/UpdateDataAssetTagResponseBody.d.ts +1 -1
- package/dist/models/UpdateDataAssetTagShrinkRequest.d.ts +4 -4
- package/dist/models/UpdateDataQualityAlertRuleRequest.d.ts +10 -18
- package/dist/models/UpdateDataQualityAlertRuleRequest.js.map +1 -1
- package/dist/models/UpdateDataQualityAlertRuleResponseBody.d.ts +1 -1
- package/dist/models/UpdateDataQualityAlertRuleShrinkRequest.d.ts +4 -4
- package/dist/models/UpdateMcpServerRequest.d.ts +5 -5
- package/dist/models/UpdateMcpServerResponseBody.d.ts +6 -4
- package/dist/models/UpdateMcpServerResponseBody.js.map +1 -1
- package/dist/models/UpdateMcpServerShrinkRequest.d.ts +3 -3
- package/dist/models/UpdateProjectRoleRequest.d.ts +12 -33
- package/dist/models/UpdateProjectRoleRequest.js.map +1 -1
- package/dist/models/UpdateProjectRoleShrinkRequest.d.ts +3 -3
- package/dist/models/model.d.ts +10 -0
- package/dist/models/model.js +56 -36
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +613 -501
- package/src/models/AbolishPipelineRunRequest.ts +3 -3
- package/src/models/AbolishPipelineRunResponseBody.ts +3 -5
- package/src/models/AddEntityIntoMetaCollectionRequest.ts +3 -3
- package/src/models/ApproveProcessInstanceRequest.ts +5 -5
- package/src/models/ApproveProcessInstanceResponseBody.ts +1 -1
- package/src/models/AttachDataQualityRulesToEvaluationTaskRequest.ts +4 -3
- package/src/models/AttachDataQualityRulesToEvaluationTaskResponseBody.ts +3 -2
- package/src/models/AttachDataQualityRulesToEvaluationTaskShrinkRequest.ts +4 -3
- package/src/models/BatchCreateMetaEntitiesRequest.ts +9 -11
- package/src/models/BatchCreateMetaEntitiesResponseBody.ts +3 -3
- package/src/models/BatchCreateMetaEntitiesShrinkRequest.ts +1 -1
- package/src/models/BatchDeleteMetaEntitiesRequest.ts +1 -1
- package/src/models/BatchDeleteMetaEntitiesResponseBody.ts +3 -3
- package/src/models/BatchDeleteMetaEntitiesShrinkRequest.ts +1 -1
- package/src/models/BatchUpdateTasksRequest.ts +29 -39
- package/src/models/BatchUpdateTasksResponseBody.ts +2 -2
- package/src/models/BatchUpdateTasksShrinkRequest.ts +1 -1
- package/src/models/CancelAgentSessionRequest.ts +1 -1
- package/src/models/CancelAgentSessionResponseBody.ts +2 -2
- package/src/models/CancelAgentSessionShrinkRequest.ts +1 -1
- package/src/models/Catalog.ts +0 -37
- package/src/models/CloneDataSourceRequest.ts +2 -2
- package/src/models/CloneDataSourceResponseBody.ts +2 -2
- package/src/models/Column.ts +3 -3
- package/src/models/CrawlerType.ts +0 -39
- package/src/models/CreateAlertRuleRequest.ts +62 -90
- package/src/models/CreateAlertRuleResponseBody.ts +2 -2
- package/src/models/CreateAlertRuleShrinkRequest.ts +5 -5
- package/src/models/CreateComponentRequest.ts +3 -3
- package/src/models/CreateComponentResponseBody.ts +1 -1
- package/src/models/CreateComputeResourceRequest.ts +5 -5
- package/src/models/CreateComputeResourceResponseBody.ts +2 -2
- package/src/models/CreateCrawlerRequest.ts +39 -0
- package/src/models/CreateCrawlerResponseBody.ts +10 -0
- package/src/models/CreateCrawlerShrinkRequest.ts +25 -0
- package/src/models/CreateDataQualityAlertRuleRequest.ts +8 -16
- package/src/models/CreateDataQualityAlertRuleResponseBody.ts +1 -1
- package/src/models/CreateDataQualityAlertRuleShrinkRequest.ts +2 -2
- package/src/models/CreateDataQualityEvaluationTaskInstanceRequest.ts +8 -8
- package/src/models/CreateDataQualityEvaluationTaskInstanceResponseBody.ts +1 -1
- package/src/models/CreateDataQualityEvaluationTaskInstanceShrinkRequest.ts +6 -6
- package/src/models/CreateDataQualityEvaluationTaskRequest.ts +64 -104
- package/src/models/CreateDataQualityEvaluationTaskResponseBody.ts +1 -1
- package/src/models/CreateDataQualityEvaluationTaskShrinkRequest.ts +9 -15
- package/src/models/CreateDataQualityRuleTemplateRequest.ts +28 -25
- package/src/models/CreateDataQualityRuleTemplateResponseBody.ts +2 -2
- package/src/models/CreateDataQualityRuleTemplateShrinkRequest.ts +7 -6
- package/src/models/CreateDataQualityScanRunRequest.ts +9 -11
- package/src/models/CreateDataQualityScanRunResponseBody.ts +1 -1
- package/src/models/CreateDataQualityScanRunShrinkRequest.ts +3 -3
- package/src/models/CreateDataSourceRequest.ts +12 -16
- package/src/models/CreateDataSourceResponseBody.ts +2 -2
- package/src/models/CreateDatasetRequest.ts +27 -53
- package/src/models/CreateDatasetResponseBody.ts +1 -1
- package/src/models/CreateDatasetShrinkRequest.ts +15 -42
- package/src/models/CreateDatasetVersionRequest.ts +13 -12
- package/src/models/CreateDatasetVersionResponseBody.ts +1 -1
- package/src/models/CreateDatasetVersionShrinkRequest.ts +13 -12
- package/src/models/CreateDialarmRuleRequest.ts +28 -46
- package/src/models/CreateDialarmRuleResponseBody.ts +2 -2
- package/src/models/CreateDialarmRuleShrinkRequest.ts +9 -14
- package/src/models/CreateDijobRequest.ts +141 -211
- package/src/models/CreateDijobResponseBody.ts +3 -3
- package/src/models/CreateDijobShrinkRequest.ts +25 -29
- package/src/models/CreateFunctionRequest.ts +2 -2
- package/src/models/CreateFunctionResponseBody.ts +2 -2
- package/src/models/CreateMcpServerRequest.ts +7 -7
- package/src/models/CreateMcpServerResponseBody.ts +4 -2
- package/src/models/CreateMcpServerShrinkRequest.ts +3 -3
- package/src/models/CreateNodeRequest.ts +17 -18
- package/src/models/CreateNodeResponseBody.ts +3 -3
- package/src/models/CreateProjectMemberRequest.ts +5 -5
- package/src/models/CreateProjectMemberResponseBody.ts +1 -1
- package/src/models/CreateProjectMemberShrinkRequest.ts +5 -5
- package/src/models/CreateProjectRequest.ts +16 -16
- package/src/models/CreateProjectResponseBody.ts +4 -3
- package/src/models/CreateProjectShrinkRequest.ts +16 -16
- package/src/models/CreateResourceAdvanceRequest.ts +4 -5
- package/src/models/CreateResourceGroupRequest.ts +14 -10
- package/src/models/CreateResourceGroupResponseBody.ts +5 -5
- package/src/models/CreateResourceGroupShrinkRequest.ts +14 -10
- package/src/models/CreateResourceRequest.ts +4 -5
- package/src/models/CreateResourceResponseBody.ts +2 -2
- package/src/models/CreateWorkflowDefinitionRequest.ts +7 -2
- package/src/models/CreateWorkflowDefinitionResponseBody.ts +3 -3
- package/src/models/DataQualityRule.ts +0 -9
- package/src/models/Database.ts +7 -43
- package/src/models/DeleteAlertRuleRequest.ts +1 -1
- package/src/models/DeleteAlertRuleResponseBody.ts +2 -2
- package/src/models/DeleteCertificateRequest.ts +2 -2
- package/src/models/DeleteCertificateResponseBody.ts +2 -2
- package/src/models/DeleteComponentRequest.ts +3 -3
- package/src/models/DeleteCrawlerRequest.ts +2 -0
- package/src/models/DeleteCrawlerResponseBody.ts +10 -0
- package/src/models/DeleteDatasetResponseBody.ts +1 -1
- package/src/models/DeleteNetworkRequest.ts +1 -1
- package/src/models/DeleteNetworkResponseBody.ts +1 -1
- package/src/models/DeleteProjectMemberRequest.ts +2 -2
- package/src/models/DeleteProjectMemberResponseBody.ts +1 -1
- package/src/models/DeleteWorkflowDefinitionRequest.ts +3 -3
- package/src/models/DeleteWorkflowDefinitionResponseBody.ts +4 -4
- package/src/models/DeployFileRequest.ts +10 -4
- package/src/models/DeployFileResponseBody.ts +3 -4
- package/src/models/ExecPipelineRunStageRequest.ts +3 -3
- package/src/models/ExecPipelineRunStageResponseBody.ts +5 -10
- package/src/models/ExecuteAdhocWorkflowInstanceRequest.ts +27 -33
- package/src/models/ExecuteAdhocWorkflowInstanceResponseBody.ts +1 -1
- package/src/models/ExecuteAdhocWorkflowInstanceShrinkRequest.ts +7 -9
- package/src/models/GetAlertRuleRequest.ts +1 -1
- package/src/models/GetAlertRuleResponseBody.ts +66 -90
- package/src/models/GetBusinessRequest.ts +3 -3
- package/src/models/GetBusinessResponseBody.ts +10 -11
- package/src/models/GetCatalogRequest.ts +7 -5
- package/src/models/GetCatalogResponseBody.ts +1 -1
- package/src/models/GetCrawlerRequest.ts +2 -0
- package/src/models/GetCrawlerResponseBody.ts +88 -0
- package/src/models/GetCrawlerTypeCapabilitiesResponseBody.ts +82 -0
- package/src/models/GetDataSourceRequest.ts +1 -1
- package/src/models/GetDataSourceResponseBody.ts +17 -22
- package/src/models/GetDeploymentPackageRequest.ts +10 -4
- package/src/models/GetDeploymentPackageResponseBody.ts +39 -35
- package/src/models/GetDijobLogRequest.ts +6 -7
- package/src/models/GetDijobLogResponseBody.ts +2 -2
- package/src/models/GetFileVersionRequest.ts +4 -4
- package/src/models/GetFileVersionResponseBody.ts +32 -48
- package/src/models/GetImageRequest.ts +1 -1
- package/src/models/GetImageResponseBody.ts +28 -50
- package/src/models/GetJobStatusRequest.ts +1 -1
- package/src/models/GetJobStatusResponseBody.ts +18 -18
- package/src/models/GetLineageRelationshipRequest.ts +1 -1
- package/src/models/GetLineageRelationshipResponseBody.ts +1 -1
- package/src/models/GetPipelineRunRequest.ts +3 -3
- package/src/models/GetPipelineRunResponseBody.ts +36 -48
- package/src/models/GetProjectRequest.ts +2 -2
- package/src/models/GetProjectResponseBody.ts +23 -31
- package/src/models/GetResourceGroupRequest.ts +1 -1
- package/src/models/GetResourceGroupResponseBody.ts +33 -44
- package/src/models/GetSnapshotRequest.ts +36 -0
- package/src/models/GetSnapshotResponse.ts +40 -0
- package/src/models/GetSnapshotResponseBody.ts +214 -0
- package/src/models/KillSemanticJobRequest.ts +3 -3
- package/src/models/LineageEntity.ts +2 -7
- package/src/models/LineageRelationship.ts +2 -2
- package/src/models/ListAgentSessionArtifactsRequest.ts +5 -5
- package/src/models/ListAgentSessionArtifactsResponseBody.ts +9 -9
- package/src/models/ListAgentSessionArtifactsShrinkRequest.ts +1 -1
- package/src/models/ListAgentsRequest.ts +3 -3
- package/src/models/ListAgentsResponseBody.ts +3 -3
- package/src/models/ListAgentsShrinkRequest.ts +2 -2
- package/src/models/ListCrawlerRunsRequest.ts +17 -0
- package/src/models/ListCrawlerRunsResponseBody.ts +42 -0
- package/src/models/ListCrawlersRequest.ts +25 -0
- package/src/models/ListCrawlersResponseBody.ts +76 -0
- package/src/models/ListCrawlersShrinkRequest.ts +25 -0
- package/src/models/ListDataQualityRuleTemplatesRequest.ts +8 -7
- package/src/models/ListDataQualityRuleTemplatesResponseBody.ts +30 -27
- package/src/models/ListDataQualityRulesRequest.ts +6 -6
- package/src/models/ListDataQualityRulesResponseBody.ts +65 -65
- package/src/models/ListDeploymentPackageFilesRequest.ts +14 -16
- package/src/models/ListDeploymentPackageFilesResponseBody.ts +48 -69
- package/src/models/ListDeploymentPackageFilesShrinkRequest.ts +14 -16
- package/src/models/ListDeploymentPackagesRequest.ts +13 -17
- package/src/models/ListDeploymentPackagesResponseBody.ts +13 -16
- package/src/models/ListDownstreamTaskInstancesRequest.ts +1 -1
- package/src/models/ListDownstreamTaskInstancesResponseBody.ts +73 -182
- package/src/models/ListFileVersionsRequest.ts +5 -5
- package/src/models/ListFileVersionsResponseBody.ts +19 -21
- package/src/models/ListFilesRequest.ts +20 -25
- package/src/models/ListFilesResponseBody.ts +32 -40
- package/src/models/ListFoldersRequest.ts +8 -4
- package/src/models/ListFoldersResponseBody.ts +11 -12
- package/src/models/ListFunctionsRequest.ts +9 -14
- package/src/models/ListFunctionsResponseBody.ts +35 -43
- package/src/models/ListLineageRelationshipsRequest.ts +1 -1
- package/src/models/ListLineagesRequest.ts +11 -13
- package/src/models/ListLineagesResponseBody.ts +5 -5
- package/src/models/ListNodesRequest.ts +17 -21
- package/src/models/ListNodesResponseBody.ts +78 -122
- package/src/models/ListResourcesRequest.ts +7 -10
- package/src/models/ListResourcesResponseBody.ts +22 -28
- package/src/models/ListRoutesRequest.ts +6 -8
- package/src/models/ListRoutesResponseBody.ts +9 -9
- package/src/models/ListSnapshotsRequest.ts +80 -0
- package/src/models/ListSnapshotsResponse.ts +40 -0
- package/src/models/ListSnapshotsResponseBody.ts +204 -0
- package/src/models/ListWorkflowInstancesRequest.ts +20 -26
- package/src/models/ListWorkflowInstancesResponseBody.ts +33 -39
- package/src/models/ListWorkflowInstancesShrinkRequest.ts +20 -26
- package/src/models/Partition.ts +0 -18
- package/src/models/RevokeMemberProjectRolesRequest.ts +4 -4
- package/src/models/RevokeMemberProjectRolesResponseBody.ts +1 -1
- package/src/models/RevokeMemberProjectRolesShrinkRequest.ts +4 -4
- package/src/models/RunCrawlerRequest.ts +2 -0
- package/src/models/RunCrawlerResponseBody.ts +20 -0
- package/src/models/Schema.ts +9 -19
- package/src/models/StartWorkflowInstancesRequest.ts +1 -1
- package/src/models/StartWorkflowInstancesResponseBody.ts +2 -2
- package/src/models/StartWorkflowInstancesShrinkRequest.ts +1 -1
- package/src/models/StopCrawlerRequest.ts +2 -0
- package/src/models/StopCrawlerResponseBody.ts +14 -0
- package/src/models/StopTaskInstancesRequest.ts +2 -2
- package/src/models/StopTaskInstancesResponseBody.ts +2 -2
- package/src/models/StopTaskInstancesShrinkRequest.ts +2 -2
- package/src/models/SuccessInfoValue.ts +1 -1
- package/src/models/Table.ts +10 -3
- package/src/models/UpdateCrawlerRequest.ts +35 -0
- package/src/models/UpdateCrawlerResponseBody.ts +10 -0
- package/src/models/UpdateCrawlerShrinkRequest.ts +21 -0
- package/src/models/UpdateDataAssetTagRequest.ts +4 -4
- package/src/models/UpdateDataAssetTagResponseBody.ts +1 -1
- package/src/models/UpdateDataAssetTagShrinkRequest.ts +4 -4
- package/src/models/UpdateDataQualityAlertRuleRequest.ts +10 -18
- package/src/models/UpdateDataQualityAlertRuleResponseBody.ts +1 -1
- package/src/models/UpdateDataQualityAlertRuleShrinkRequest.ts +4 -4
- package/src/models/UpdateMcpServerRequest.ts +5 -5
- package/src/models/UpdateMcpServerResponseBody.ts +6 -4
- package/src/models/UpdateMcpServerShrinkRequest.ts +3 -3
- package/src/models/UpdateProjectRoleRequest.ts +12 -33
- package/src/models/UpdateProjectRoleShrinkRequest.ts +3 -3
- 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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
240
|
+
* Updates multiple nodes in batches by using incremental updates.
|
|
243
241
|
*
|
|
244
242
|
* @remarks
|
|
245
|
-
* DataWorks Basic Edition or higher
|
|
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
|
-
*
|
|
251
|
+
* Updates multiple nodes in batches by using incremental updates.
|
|
254
252
|
*
|
|
255
253
|
* @remarks
|
|
256
|
-
* DataWorks Basic Edition or higher
|
|
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
|
-
*
|
|
261
|
+
* Interrupts the Agent call for a specified session, supporting interruption during streaming responses.
|
|
264
262
|
*
|
|
265
263
|
* @remarks
|
|
266
|
-
* ##
|
|
267
|
-
* - This operation is used to actively interrupt an ongoing session, especially when the session is
|
|
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
|
-
*
|
|
274
|
+
* Interrupts the Agent call for a specified session, supporting interruption during streaming responses.
|
|
277
275
|
*
|
|
278
276
|
* @remarks
|
|
279
|
-
* ##
|
|
280
|
-
* - This operation is used to actively interrupt an ongoing session, especially when the session is
|
|
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
|
|
286
|
+
* Clones a new data source based on an existing data source.
|
|
289
287
|
*
|
|
290
288
|
* @remarks
|
|
291
|
-
* 1.
|
|
292
|
-
* 2.
|
|
293
|
-
* - Tenant Owner,
|
|
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
|
|
299
|
+
* Clones a new data source based on an existing data source.
|
|
302
300
|
*
|
|
303
301
|
* @remarks
|
|
304
|
-
* 1.
|
|
305
|
-
* 2.
|
|
306
|
-
* - Tenant Owner,
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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.
|
|
464
|
-
* 2.
|
|
465
|
-
* 3.
|
|
466
|
-
* ##
|
|
467
|
-
*
|
|
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.
|
|
484
|
-
* 2.
|
|
485
|
-
* 3.
|
|
486
|
-
* ##
|
|
487
|
-
*
|
|
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
|
|
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
|
|
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
|
-
*
|
|
528
|
+
* Creates a data integration task.
|
|
527
529
|
*
|
|
528
530
|
* @remarks
|
|
529
|
-
* -
|
|
530
|
-
* - This
|
|
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
|
-
*
|
|
540
|
+
* Creates a data integration task.
|
|
539
541
|
*
|
|
540
542
|
* @remarks
|
|
541
|
-
* -
|
|
542
|
-
* - This
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
714
|
+
* Triggers the execution of a specified data quality monitoring task and returns the run instance ID.
|
|
713
715
|
*
|
|
714
716
|
* @remarks
|
|
715
|
-
*
|
|
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
|
|
725
|
+
* Triggers the execution of a specified data quality monitoring task and returns the run instance ID.
|
|
724
726
|
*
|
|
725
727
|
* @remarks
|
|
726
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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.
|
|
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.
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
-
* ##
|
|
925
|
-
* -
|
|
926
|
-
* - If the MCP Server connection is unavailable, the
|
|
927
|
-
* - The
|
|
928
|
-
* - The
|
|
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
|
-
* ##
|
|
940
|
-
* -
|
|
941
|
-
* - If the MCP Server connection is unavailable, the
|
|
942
|
-
* - The
|
|
943
|
-
* - The
|
|
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
|
|
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
|
|
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
|
|
1142
|
+
* Adds a workspace member and grants workspace roles to the member.
|
|
1129
1143
|
*
|
|
1130
1144
|
* @remarks
|
|
1131
|
-
*
|
|
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
|
|
1153
|
+
* Adds a workspace member and grants workspace roles to the member.
|
|
1140
1154
|
*
|
|
1141
1155
|
* @remarks
|
|
1142
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
1209
|
-
* 3. **Before you call this operation, make sure that you have created the
|
|
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
|
|
1222
|
-
* 3. **Before you call this operation, make sure that you have created the
|
|
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
|
|
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
|
|
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.
|
|
1461
|
-
* 2.
|
|
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.
|
|
1473
|
-
* 2.
|
|
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.
|
|
1535
|
-
* 2.
|
|
1536
|
-
* ##
|
|
1537
|
-
*
|
|
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.
|
|
1554
|
-
* 2.
|
|
1555
|
-
* ##
|
|
1556
|
-
*
|
|
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
|
|
1645
|
+
* Deletes a data quality monitoring alert rule based on the specified ID.
|
|
1638
1646
|
*
|
|
1639
1647
|
* @remarks
|
|
1640
|
-
* DataWorks Basic Edition or a
|
|
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
|
|
1656
|
+
* Deletes a data quality monitoring alert rule based on the specified ID.
|
|
1649
1657
|
*
|
|
1650
1658
|
* @remarks
|
|
1651
|
-
* DataWorks Basic Edition or a
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
2127
|
+
* Removes a workspace member and the workspace roles granted to the member.
|
|
2114
2128
|
*
|
|
2115
2129
|
* @remarks
|
|
2116
|
-
*
|
|
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
|
|
2138
|
+
* Removes a workspace member and the workspace roles granted to the member.
|
|
2125
2139
|
*
|
|
2126
2140
|
* @remarks
|
|
2127
|
-
*
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
2572
|
+
* Executes a specified stage of a publish flow.
|
|
2561
2573
|
*
|
|
2562
2574
|
* @remarks
|
|
2563
|
-
* > The stages
|
|
2564
|
-
* > The execution
|
|
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
|
|
2585
|
+
* Executes a specified stage of a publish flow.
|
|
2573
2586
|
*
|
|
2574
2587
|
* @remarks
|
|
2575
|
-
* > The stages
|
|
2576
|
-
* > The execution
|
|
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
|
-
*
|
|
2597
|
+
* Creates a temporary workflow instance based on the specified configuration.
|
|
2584
2598
|
*
|
|
2585
2599
|
* @remarks
|
|
2586
|
-
*
|
|
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
|
-
*
|
|
2608
|
+
* Creates a temporary workflow instance based on the specified configuration.
|
|
2595
2609
|
*
|
|
2596
2610
|
* @remarks
|
|
2597
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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.
|
|
2875
|
-
* 2.
|
|
2876
|
-
* 3.
|
|
2877
|
-
* ##
|
|
2878
|
-
*
|
|
2879
|
-
* ##
|
|
2880
|
-
*
|
|
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.
|
|
2895
|
-
* 2.
|
|
2896
|
-
* 3.
|
|
2897
|
-
* ##
|
|
2898
|
-
*
|
|
2899
|
-
* ##
|
|
2900
|
-
*
|
|
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
|
-
*
|
|
2912
|
-
* ##
|
|
2913
|
-
* 1.
|
|
2914
|
-
* 2.
|
|
2915
|
-
* ##
|
|
2916
|
-
*
|
|
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
|
-
*
|
|
2931
|
-
* ##
|
|
2932
|
-
* 1.
|
|
2933
|
-
* 2.
|
|
2934
|
-
* ##
|
|
2935
|
-
*
|
|
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
|
-
*
|
|
3015
|
+
* Retrieves the task logs of a data integration node.
|
|
3002
3016
|
*
|
|
3003
3017
|
* @remarks
|
|
3004
|
-
*
|
|
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
|
-
*
|
|
3026
|
+
* Retrieves the task logs of a data integration node.
|
|
3013
3027
|
*
|
|
3014
3028
|
* @remarks
|
|
3015
|
-
*
|
|
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
|
-
*
|
|
3241
|
+
* Queries a specified data source by data source ID.
|
|
3228
3242
|
*
|
|
3229
3243
|
* @remarks
|
|
3230
|
-
* 1.
|
|
3231
|
-
* 2.
|
|
3232
|
-
* - Tenant Owner, Workspace Administrator, Deployment,
|
|
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
|
-
*
|
|
3254
|
+
* Queries a specified data source by data source ID.
|
|
3241
3255
|
*
|
|
3242
3256
|
* @remarks
|
|
3243
|
-
* 1.
|
|
3244
|
-
* 2.
|
|
3245
|
-
* - Tenant Owner, Workspace Administrator, Deployment,
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
3407
|
+
* Retrieves the details of a specified image by image ID.
|
|
3394
3408
|
*
|
|
3395
3409
|
* @remarks
|
|
3396
|
-
* 1.
|
|
3397
|
-
* 2. **
|
|
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
|
-
*
|
|
3419
|
+
* Retrieves the details of a specified image by image ID.
|
|
3406
3420
|
*
|
|
3407
3421
|
* @remarks
|
|
3408
|
-
* 1.
|
|
3409
|
-
* 2. **
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
3445
|
+
* Retrieves the details of a specified lineage relationship in DataWorks Data Map.
|
|
3432
3446
|
*
|
|
3433
3447
|
* @remarks
|
|
3434
|
-
* 1.
|
|
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
|
|
3456
|
+
* Retrieves the details of a specified lineage relationship in DataWorks Data Map.
|
|
3443
3457
|
*
|
|
3444
3458
|
* @remarks
|
|
3445
|
-
* 1.
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
3699
|
+
* Queries the details of a DataWorks workspace.
|
|
3688
3700
|
*
|
|
3689
3701
|
* @remarks
|
|
3690
|
-
*
|
|
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
|
|
3710
|
+
* Queries the details of a DataWorks workspace.
|
|
3699
3711
|
*
|
|
3700
3712
|
* @remarks
|
|
3701
|
-
*
|
|
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
|
-
*
|
|
3792
|
+
* Retrieves the information of a specified resource group by ID.
|
|
3781
3793
|
*
|
|
3782
3794
|
* @remarks
|
|
3783
|
-
* DataWorks Basic Edition or a
|
|
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
|
-
*
|
|
3803
|
+
* Retrieves the information of a specified resource group by ID.
|
|
3792
3804
|
*
|
|
3793
3805
|
* @remarks
|
|
3794
|
-
* DataWorks Basic Edition or a
|
|
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
|
|
4184
|
-
* 3. After the call, poll the final status by
|
|
4185
|
-
* ##
|
|
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
|
|
4202
|
-
* 3. After the call, poll the final status by
|
|
4203
|
-
* ##
|
|
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
|
-
*
|
|
4238
|
+
* Queries the list of artifact files produced by a specified session.
|
|
4212
4239
|
*
|
|
4213
4240
|
* @remarks
|
|
4214
|
-
* ##
|
|
4215
|
-
* - This operation
|
|
4216
|
-
* - The `NextToken` parameter is
|
|
4217
|
-
* - By default,
|
|
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
|
-
*
|
|
4252
|
+
* Queries the list of artifact files produced by a specified session.
|
|
4226
4253
|
*
|
|
4227
4254
|
* @remarks
|
|
4228
|
-
* ##
|
|
4229
|
-
* - This operation
|
|
4230
|
-
* - The `NextToken` parameter is
|
|
4231
|
-
* - By default,
|
|
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
|
-
*
|
|
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
|
|
4274
|
-
* -
|
|
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
|
-
*
|
|
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
|
|
4287
|
-
* -
|
|
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
|
-
*
|
|
4440
|
-
* ##
|
|
4441
|
-
* 1.
|
|
4442
|
-
* 2.
|
|
4443
|
-
* 3.
|
|
4444
|
-
* ##
|
|
4445
|
-
*
|
|
4446
|
-
* ##
|
|
4447
|
-
*
|
|
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
|
-
*
|
|
4460
|
-
* ##
|
|
4461
|
-
* 1.
|
|
4462
|
-
* 2.
|
|
4463
|
-
* 3.
|
|
4464
|
-
* ##
|
|
4465
|
-
*
|
|
4466
|
-
* ##
|
|
4467
|
-
*
|
|
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.
|
|
4500
|
-
* ##
|
|
4501
|
-
*
|
|
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.
|
|
4519
|
-
* ##
|
|
4520
|
-
*
|
|
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
|
-
*
|
|
4860
|
+
* Queries quality monitoring rules by paging.
|
|
4834
4861
|
*
|
|
4835
4862
|
* @remarks
|
|
4836
|
-
*
|
|
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
|
-
*
|
|
4873
|
+
* Queries quality monitoring rules by paging.
|
|
4847
4874
|
*
|
|
4848
4875
|
* @remarks
|
|
4849
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
5081
|
+
* Retrieves a paginated list of downstream instances for a specified instance.
|
|
5055
5082
|
*
|
|
5056
5083
|
* @remarks
|
|
5057
|
-
*
|
|
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
|
-
*
|
|
5092
|
+
* Retrieves a paginated list of downstream instances for a specified instance.
|
|
5066
5093
|
*
|
|
5067
5094
|
* @remarks
|
|
5068
|
-
*
|
|
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
|
|
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
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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.
|
|
5265
|
-
* 2.
|
|
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
|
|
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.
|
|
5277
|
-
* 2.
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
5844
|
+
* Retrieves the route list of a network resource.
|
|
5818
5845
|
*
|
|
5819
5846
|
* @remarks
|
|
5820
|
-
*
|
|
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
|
|
5855
|
+
* Retrieves the route list of a network resource.
|
|
5829
5856
|
*
|
|
5830
5857
|
* @remarks
|
|
5831
|
-
*
|
|
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
|
-
*
|
|
6191
|
+
* Retrieves a paging list of workflow instances, with optional filtered query by conditions.
|
|
6150
6192
|
*
|
|
6151
6193
|
* @remarks
|
|
6152
|
-
*
|
|
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
|
-
*
|
|
6202
|
+
* Retrieves a paging list of workflow instances, with optional filtered query by conditions.
|
|
6161
6203
|
*
|
|
6162
6204
|
* @remarks
|
|
6163
|
-
*
|
|
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
|
|
6572
|
+
* Revokes roles from a workspace member.
|
|
6531
6573
|
*
|
|
6532
6574
|
* @remarks
|
|
6533
|
-
*
|
|
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
|
|
6583
|
+
* Revokes roles from a workspace member.
|
|
6542
6584
|
*
|
|
6543
6585
|
* @remarks
|
|
6544
|
-
*
|
|
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.
|
|
6579
|
-
* 2.
|
|
6580
|
-
* 3.
|
|
6581
|
-
* ##
|
|
6582
|
-
*
|
|
6583
|
-
* ##
|
|
6584
|
-
*
|
|
6585
|
-
*
|
|
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.
|
|
6602
|
-
* 2.
|
|
6603
|
-
* 3.
|
|
6604
|
-
* ##
|
|
6605
|
-
*
|
|
6606
|
-
* ##
|
|
6607
|
-
*
|
|
6608
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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
|
-
*
|
|
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
|
|
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.
|
|
6722
|
-
* 2.
|
|
6723
|
-
* 3.
|
|
6724
|
-
* ##
|
|
6725
|
-
*
|
|
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.
|
|
6742
|
-
* 2.
|
|
6743
|
-
* 3.
|
|
6744
|
-
* ##
|
|
6745
|
-
*
|
|
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
|
|
6844
|
+
* Stops multiple instances in a batch.
|
|
6803
6845
|
*
|
|
6804
6846
|
* @remarks
|
|
6805
|
-
*
|
|
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
|
|
6855
|
+
* Stops multiple instances in a batch.
|
|
6814
6856
|
*
|
|
6815
6857
|
* @remarks
|
|
6816
|
-
*
|
|
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
|
-
*
|
|
7072
|
-
* ##
|
|
7073
|
-
* 1.
|
|
7074
|
-
* 2.
|
|
7075
|
-
* 3.
|
|
7076
|
-
* ##
|
|
7077
|
-
*
|
|
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
|
-
*
|
|
7092
|
-
* ##
|
|
7093
|
-
* 1.
|
|
7094
|
-
* 2.
|
|
7095
|
-
* 3.
|
|
7096
|
-
* ##
|
|
7097
|
-
*
|
|
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
|
|
7199
|
+
* Updates a label.
|
|
7158
7200
|
*
|
|
7159
7201
|
* @remarks
|
|
7160
|
-
*
|
|
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
|
|
7210
|
+
* Updates a label.
|
|
7169
7211
|
*
|
|
7170
7212
|
* @remarks
|
|
7171
|
-
*
|
|
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
|
|
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
|
|
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
|
-
* ##
|
|
7425
|
-
* This API
|
|
7426
|
-
* **Note**: When you modify the`Visibility` parameter,
|
|
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
|
-
* ##
|
|
7438
|
-
* This API
|
|
7439
|
-
* **Note**: When you modify the`Visibility` parameter,
|
|
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
|