@alicloud/dataworks-public20240518 8.8.5 → 9.1.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 +862 -130
- package/dist/client.js +1572 -179
- package/dist/client.js.map +1 -1
- package/dist/models/CreateAgentRequest.d.ts +72 -12
- package/dist/models/CreateAgentRequest.js +61 -4
- package/dist/models/CreateAgentRequest.js.map +1 -1
- package/dist/models/CreateAgentResponseBody.d.ts +4 -4
- package/dist/models/CreateAgentSessionRequest.d.ts +32 -10
- package/dist/models/CreateAgentSessionRequest.js.map +1 -1
- package/dist/models/CreateAgentSessionResponseBody.d.ts +4 -4
- package/dist/models/CreateAgentSessionShrinkRequest.d.ts +2 -2
- package/dist/models/CreateAgentShrinkRequest.d.ts +7 -7
- package/dist/models/CreateCrawlerRequest.d.ts +99 -0
- package/dist/models/CreateCrawlerRequest.js +128 -0
- package/dist/models/CreateCrawlerRequest.js.map +1 -0
- package/dist/models/CreateCrawlerResponse.d.ts +19 -0
- package/dist/models/CreateCrawlerResponse.js +69 -0
- package/dist/models/CreateCrawlerResponse.js.map +1 -0
- package/dist/models/CreateCrawlerResponseBody.d.ts +24 -0
- package/dist/models/CreateCrawlerResponseBody.js +62 -0
- package/dist/models/CreateCrawlerResponseBody.js.map +1 -0
- package/dist/models/CreateCrawlerShrinkRequest.d.ts +46 -0
- package/dist/models/CreateCrawlerShrinkRequest.js +72 -0
- package/dist/models/CreateCrawlerShrinkRequest.js.map +1 -0
- package/dist/models/CreateCustomAttributeRequest.d.ts +13 -17
- package/dist/models/CreateCustomAttributeRequest.js.map +1 -1
- package/dist/models/CreateCustomAttributeResponseBody.d.ts +1 -1
- package/dist/models/CreateCustomAttributeShrinkRequest.d.ts +13 -17
- package/dist/models/CreateCustomAttributeShrinkRequest.js.map +1 -1
- package/dist/models/CreateFileRequest.d.ts +86 -92
- package/dist/models/CreateFileRequest.js +2 -0
- package/dist/models/CreateFileRequest.js.map +1 -1
- package/dist/models/CreateFileResponseBody.d.ts +4 -5
- package/dist/models/CreateFileResponseBody.js.map +1 -1
- package/dist/models/CreateMetaEntityDefRequest.d.ts +7 -8
- package/dist/models/CreateMetaEntityDefRequest.js.map +1 -1
- package/dist/models/CreateMetaEntityDefResponseBody.d.ts +1 -1
- package/dist/models/CreateMetaEntityDefShrinkRequest.d.ts +7 -8
- package/dist/models/CreateMetaEntityDefShrinkRequest.js.map +1 -1
- package/dist/models/CreateSemanticJobRequest.d.ts +63 -0
- package/dist/models/CreateSemanticJobRequest.js +77 -0
- package/dist/models/CreateSemanticJobRequest.js.map +1 -0
- package/dist/models/CreateSemanticJobResponse.d.ts +19 -0
- package/dist/models/CreateSemanticJobResponse.js +69 -0
- package/dist/models/CreateSemanticJobResponse.js.map +1 -0
- package/dist/models/CreateSemanticJobResponseBody.d.ts +132 -0
- package/dist/models/CreateSemanticJobResponseBody.js +115 -0
- package/dist/models/CreateSemanticJobResponseBody.js.map +1 -0
- package/dist/models/CreateSemanticJobShrinkRequest.d.ts +61 -0
- package/dist/models/CreateSemanticJobShrinkRequest.js +68 -0
- package/dist/models/CreateSemanticJobShrinkRequest.js.map +1 -0
- package/dist/models/CreateSkillRequest.d.ts +35 -0
- package/dist/models/CreateSkillRequest.js.map +1 -1
- package/dist/models/CreateSkillResponseBody.d.ts +41 -0
- package/dist/models/CreateSkillResponseBody.js.map +1 -1
- package/dist/models/CreateSkillShrinkRequest.d.ts +27 -0
- package/dist/models/CreateSkillShrinkRequest.js.map +1 -1
- package/dist/models/DeleteAgentRequest.d.ts +2 -0
- package/dist/models/DeleteAgentRequest.js.map +1 -1
- package/dist/models/DeleteAgentResponseBody.d.ts +3 -0
- package/dist/models/DeleteAgentResponseBody.js.map +1 -1
- package/dist/models/DeleteCrawlerRequest.d.ts +21 -0
- package/dist/models/DeleteCrawlerRequest.js +58 -0
- package/dist/models/DeleteCrawlerRequest.js.map +1 -0
- package/dist/models/DeleteCrawlerResponse.d.ts +19 -0
- package/dist/models/DeleteCrawlerResponse.js +69 -0
- package/dist/models/DeleteCrawlerResponse.js.map +1 -0
- package/dist/models/DeleteCrawlerResponseBody.d.ts +24 -0
- package/dist/models/DeleteCrawlerResponseBody.js +62 -0
- package/dist/models/DeleteCrawlerResponseBody.js.map +1 -0
- package/dist/models/DeleteLineageRelationshipRequest.d.ts +1 -1
- package/dist/models/DeleteLineageRelationshipResponseBody.d.ts +2 -3
- package/dist/models/DeleteLineageRelationshipResponseBody.js.map +1 -1
- package/dist/models/DeleteMetaEntityDefRequest.d.ts +8 -0
- package/dist/models/DeleteMetaEntityDefRequest.js.map +1 -1
- package/dist/models/DeleteMetaEntityDefResponseBody.d.ts +6 -0
- package/dist/models/DeleteMetaEntityDefResponseBody.js.map +1 -1
- package/dist/models/DeleteSemanticJobRequest.d.ts +23 -0
- package/dist/models/DeleteSemanticJobRequest.js +58 -0
- package/dist/models/DeleteSemanticJobRequest.js.map +1 -0
- package/dist/models/DeleteSemanticJobResponse.d.ts +19 -0
- package/dist/models/DeleteSemanticJobResponse.js +69 -0
- package/dist/models/DeleteSemanticJobResponse.js.map +1 -0
- package/dist/models/DeleteSemanticJobResponseBody.d.ts +72 -0
- package/dist/models/DeleteSemanticJobResponseBody.js +90 -0
- package/dist/models/DeleteSemanticJobResponseBody.js.map +1 -0
- package/dist/models/DownloadSemanticResultsRequest.d.ts +31 -0
- package/dist/models/DownloadSemanticResultsRequest.js +60 -0
- package/dist/models/DownloadSemanticResultsRequest.js.map +1 -0
- package/dist/models/DownloadSemanticResultsResponse.d.ts +19 -0
- package/dist/models/DownloadSemanticResultsResponse.js +69 -0
- package/dist/models/DownloadSemanticResultsResponse.js.map +1 -0
- package/dist/models/DownloadSemanticResultsResponseBody.d.ts +84 -0
- package/dist/models/DownloadSemanticResultsResponseBody.js +110 -0
- package/dist/models/DownloadSemanticResultsResponseBody.js.map +1 -0
- package/dist/models/GetCrawlerRequest.d.ts +21 -0
- package/dist/models/GetCrawlerRequest.js +58 -0
- package/dist/models/GetCrawlerRequest.js.map +1 -0
- package/dist/models/GetCrawlerResponse.d.ts +19 -0
- package/dist/models/GetCrawlerResponse.js +69 -0
- package/dist/models/GetCrawlerResponse.js.map +1 -0
- package/dist/models/GetCrawlerResponseBody.d.ts +158 -0
- package/dist/models/GetCrawlerResponseBody.js +176 -0
- package/dist/models/GetCrawlerResponseBody.js.map +1 -0
- package/dist/models/GetCrawlerTypeCapabilitiesRequest.d.ts +13 -0
- package/dist/models/GetCrawlerTypeCapabilitiesRequest.js +54 -0
- package/dist/models/GetCrawlerTypeCapabilitiesRequest.js.map +1 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponse.d.ts +19 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponse.js +69 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponse.js.map +1 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.d.ts +112 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.js +171 -0
- package/dist/models/GetCrawlerTypeCapabilitiesResponseBody.js.map +1 -0
- package/dist/models/GetSemanticJobDetailRequest.d.ts +33 -0
- package/dist/models/GetSemanticJobDetailRequest.js +60 -0
- package/dist/models/GetSemanticJobDetailRequest.js.map +1 -0
- package/dist/models/GetSemanticJobDetailResponse.d.ts +19 -0
- package/dist/models/GetSemanticJobDetailResponse.js +69 -0
- package/dist/models/GetSemanticJobDetailResponse.js.map +1 -0
- package/dist/models/GetSemanticJobDetailResponseBody.d.ts +139 -0
- package/dist/models/GetSemanticJobDetailResponseBody.js +120 -0
- package/dist/models/GetSemanticJobDetailResponseBody.js.map +1 -0
- package/dist/models/GetSemanticJobLogRequest.d.ts +33 -0
- package/dist/models/GetSemanticJobLogRequest.js +60 -0
- package/dist/models/GetSemanticJobLogRequest.js.map +1 -0
- package/dist/models/GetSemanticJobLogResponse.d.ts +19 -0
- package/dist/models/GetSemanticJobLogResponse.js +69 -0
- package/dist/models/GetSemanticJobLogResponse.js.map +1 -0
- package/dist/models/GetSemanticJobLogResponseBody.d.ts +56 -0
- package/dist/models/GetSemanticJobLogResponseBody.js +86 -0
- package/dist/models/GetSemanticJobLogResponseBody.js.map +1 -0
- package/dist/models/GetTableRequest.d.ts +11 -5
- package/dist/models/GetTableRequest.js.map +1 -1
- package/dist/models/GetTableResponseBody.d.ts +1 -1
- package/dist/models/ImportWorkflowDefinitionRequest.d.ts +10 -5
- package/dist/models/ImportWorkflowDefinitionRequest.js.map +1 -1
- package/dist/models/ImportWorkflowDefinitionResponseBody.d.ts +3 -3
- package/dist/models/KillSemanticJobRequest.d.ts +41 -0
- package/dist/models/KillSemanticJobRequest.js +62 -0
- package/dist/models/KillSemanticJobRequest.js.map +1 -0
- package/dist/models/KillSemanticJobResponse.d.ts +19 -0
- package/dist/models/KillSemanticJobResponse.js +69 -0
- package/dist/models/KillSemanticJobResponse.js.map +1 -0
- package/dist/models/KillSemanticJobResponseBody.d.ts +31 -0
- package/dist/models/KillSemanticJobResponseBody.js +62 -0
- package/dist/models/KillSemanticJobResponseBody.js.map +1 -0
- package/dist/models/ListColumnsRequest.d.ts +14 -7
- package/dist/models/ListColumnsRequest.js.map +1 -1
- package/dist/models/ListColumnsResponseBody.d.ts +3 -3
- package/dist/models/ListCrawlerRunsRequest.d.ts +46 -0
- package/dist/models/ListCrawlerRunsRequest.js +68 -0
- package/dist/models/ListCrawlerRunsRequest.js.map +1 -0
- package/dist/models/ListCrawlerRunsResponse.d.ts +19 -0
- package/dist/models/ListCrawlerRunsResponse.js +69 -0
- package/dist/models/ListCrawlerRunsResponse.js.map +1 -0
- package/dist/models/ListCrawlerRunsResponseBody.d.ts +90 -0
- package/dist/models/ListCrawlerRunsResponseBody.js +122 -0
- package/dist/models/ListCrawlerRunsResponseBody.js.map +1 -0
- package/dist/models/ListCrawlersRequest.d.ts +49 -0
- package/dist/models/ListCrawlersRequest.js +75 -0
- package/dist/models/ListCrawlersRequest.js.map +1 -0
- package/dist/models/ListCrawlersResponse.d.ts +19 -0
- package/dist/models/ListCrawlersResponse.js +69 -0
- package/dist/models/ListCrawlersResponse.js.map +1 -0
- package/dist/models/ListCrawlersResponseBody.d.ts +153 -0
- package/dist/models/ListCrawlersResponseBody.js +164 -0
- package/dist/models/ListCrawlersResponseBody.js.map +1 -0
- package/dist/models/ListCrawlersShrinkRequest.d.ts +49 -0
- package/dist/models/ListCrawlersShrinkRequest.js +72 -0
- package/dist/models/ListCrawlersShrinkRequest.js.map +1 -0
- package/dist/models/ListCustomAttributesRequest.d.ts +4 -4
- package/dist/models/ListCustomAttributesResponseBody.d.ts +5 -5
- package/dist/models/ListDataAssetsRequest.d.ts +15 -6
- package/dist/models/ListDataAssetsRequest.js.map +1 -1
- package/dist/models/ListDataAssetsResponseBody.d.ts +20 -7
- package/dist/models/ListDataAssetsResponseBody.js.map +1 -1
- package/dist/models/ListDataAssetsShrinkRequest.d.ts +14 -5
- package/dist/models/ListDataAssetsShrinkRequest.js.map +1 -1
- package/dist/models/ListDataQualityTemplatesRequest.d.ts +4 -4
- package/dist/models/ListDataQualityTemplatesResponseBody.d.ts +8 -8
- package/dist/models/ListLineageRelationshipsRequest.d.ts +12 -11
- package/dist/models/ListLineageRelationshipsRequest.js.map +1 -1
- package/dist/models/ListLineageRelationshipsResponseBody.d.ts +5 -5
- package/dist/models/ListMetaCollectionsRequest.d.ts +19 -26
- package/dist/models/ListMetaCollectionsRequest.js.map +1 -1
- package/dist/models/ListMetaCollectionsResponseBody.d.ts +13 -15
- package/dist/models/ListMetaCollectionsResponseBody.js.map +1 -1
- package/dist/models/ListMetaEntitiesRequest.d.ts +13 -13
- package/dist/models/ListMetaEntitiesResponseBody.d.ts +5 -5
- package/dist/models/ListMetaEntitiesShrinkRequest.d.ts +9 -9
- package/dist/models/ListMetaEntityDefsRequest.d.ts +17 -7
- package/dist/models/ListMetaEntityDefsRequest.js.map +1 -1
- package/dist/models/ListMetaEntityDefsResponseBody.d.ts +6 -6
- package/dist/models/ListPartitionsRequest.d.ts +13 -16
- package/dist/models/ListPartitionsRequest.js.map +1 -1
- package/dist/models/ListPartitionsResponseBody.d.ts +4 -4
- package/dist/models/ListSemanticJobRunsRequest.d.ts +39 -0
- package/dist/models/ListSemanticJobRunsRequest.js +62 -0
- package/dist/models/ListSemanticJobRunsRequest.js.map +1 -0
- package/dist/models/ListSemanticJobRunsResponse.d.ts +19 -0
- package/dist/models/ListSemanticJobRunsResponse.js +69 -0
- package/dist/models/ListSemanticJobRunsResponse.js.map +1 -0
- package/dist/models/ListSemanticJobRunsResponseBody.d.ts +124 -0
- package/dist/models/ListSemanticJobRunsResponseBody.js +120 -0
- package/dist/models/ListSemanticJobRunsResponseBody.js.map +1 -0
- package/dist/models/ListSemanticJobsRequest.d.ts +29 -0
- package/dist/models/ListSemanticJobsRequest.js +60 -0
- package/dist/models/ListSemanticJobsRequest.js.map +1 -0
- package/dist/models/ListSemanticJobsResponse.d.ts +19 -0
- package/dist/models/ListSemanticJobsResponse.js +69 -0
- package/dist/models/ListSemanticJobsResponse.js.map +1 -0
- package/dist/models/ListSemanticJobsResponseBody.d.ts +173 -0
- package/dist/models/ListSemanticJobsResponseBody.js +143 -0
- package/dist/models/ListSemanticJobsResponseBody.js.map +1 -0
- package/dist/models/ListTablesRequest.d.ts +13 -6
- package/dist/models/ListTablesRequest.js.map +1 -1
- package/dist/models/ListTablesShrinkRequest.d.ts +13 -6
- package/dist/models/ListTablesShrinkRequest.js.map +1 -1
- package/dist/models/LoadAgentSessionRequest.d.ts +1 -1
- package/dist/models/PromptAgentSessionRequest.d.ts +17 -16
- package/dist/models/PromptAgentSessionRequest.js.map +1 -1
- package/dist/models/PromptAgentSessionResponseBody.d.ts +5 -5
- package/dist/models/PromptAgentSessionShrinkRequest.d.ts +1 -1
- package/dist/models/RerunTaskInstancesRequest.d.ts +7 -0
- package/dist/models/RerunTaskInstancesRequest.js.map +1 -1
- package/dist/models/RerunTaskInstancesResponseBody.d.ts +1 -1
- package/dist/models/RerunTaskInstancesShrinkRequest.d.ts +7 -0
- package/dist/models/RerunTaskInstancesShrinkRequest.js.map +1 -1
- package/dist/models/RunCrawlerRequest.d.ts +21 -0
- package/dist/models/RunCrawlerRequest.js +58 -0
- package/dist/models/RunCrawlerRequest.js.map +1 -0
- package/dist/models/RunCrawlerResponse.d.ts +19 -0
- package/dist/models/RunCrawlerResponse.js +69 -0
- package/dist/models/RunCrawlerResponse.js.map +1 -0
- package/dist/models/RunCrawlerResponseBody.d.ts +35 -0
- package/dist/models/RunCrawlerResponseBody.js +68 -0
- package/dist/models/RunCrawlerResponseBody.js.map +1 -0
- package/dist/models/RunSemanticJobRequest.d.ts +23 -0
- package/dist/models/RunSemanticJobRequest.js +58 -0
- package/dist/models/RunSemanticJobRequest.js.map +1 -0
- package/dist/models/RunSemanticJobResponse.d.ts +19 -0
- package/dist/models/RunSemanticJobResponse.js +69 -0
- package/dist/models/RunSemanticJobResponse.js.map +1 -0
- package/dist/models/RunSemanticJobResponseBody.d.ts +85 -0
- package/dist/models/RunSemanticJobResponseBody.js +100 -0
- package/dist/models/RunSemanticJobResponseBody.js.map +1 -0
- package/dist/models/StopCrawlerRequest.d.ts +21 -0
- package/dist/models/StopCrawlerRequest.js +58 -0
- package/dist/models/StopCrawlerRequest.js.map +1 -0
- package/dist/models/StopCrawlerResponse.d.ts +19 -0
- package/dist/models/StopCrawlerResponse.js +69 -0
- package/dist/models/StopCrawlerResponse.js.map +1 -0
- package/dist/models/StopCrawlerResponseBody.d.ts +25 -0
- package/dist/models/StopCrawlerResponseBody.js +64 -0
- package/dist/models/StopCrawlerResponseBody.js.map +1 -0
- package/dist/models/UpdateCrawlerRequest.d.ts +83 -0
- package/dist/models/UpdateCrawlerRequest.js +124 -0
- package/dist/models/UpdateCrawlerRequest.js.map +1 -0
- package/dist/models/UpdateCrawlerResponse.d.ts +19 -0
- package/dist/models/UpdateCrawlerResponse.js +69 -0
- package/dist/models/UpdateCrawlerResponse.js.map +1 -0
- package/dist/models/UpdateCrawlerResponseBody.d.ts +24 -0
- package/dist/models/UpdateCrawlerResponseBody.js +62 -0
- package/dist/models/UpdateCrawlerResponseBody.js.map +1 -0
- package/dist/models/UpdateCrawlerShrinkRequest.d.ts +30 -0
- package/dist/models/UpdateCrawlerShrinkRequest.js +68 -0
- package/dist/models/UpdateCrawlerShrinkRequest.js.map +1 -0
- package/dist/models/UpdateMetaEntityDefRequest.d.ts +2 -2
- package/dist/models/UpdateMetaEntityDefShrinkRequest.d.ts +2 -2
- package/dist/models/UpdateSkillRequest.d.ts +100 -0
- package/dist/models/UpdateSkillRequest.js +105 -0
- package/dist/models/UpdateSkillRequest.js.map +1 -0
- package/dist/models/UpdateSkillResponse.d.ts +19 -0
- package/dist/models/UpdateSkillResponse.js +69 -0
- package/dist/models/UpdateSkillResponse.js.map +1 -0
- package/dist/models/UpdateSkillResponseBody.d.ts +133 -0
- package/dist/models/UpdateSkillResponseBody.js +128 -0
- package/dist/models/UpdateSkillResponseBody.js.map +1 -0
- package/dist/models/UpdateSkillShrinkRequest.d.ts +76 -0
- package/dist/models/UpdateSkillShrinkRequest.js +72 -0
- package/dist/models/UpdateSkillShrinkRequest.js.map +1 -0
- package/dist/models/UpdateTableBusinessMetadataRequest.d.ts +3 -3
- package/dist/models/UpdateTableBusinessMetadataShrinkRequest.d.ts +3 -3
- package/dist/models/UploadSemanticFileRequest.d.ts +43 -0
- package/dist/models/UploadSemanticFileRequest.js +62 -0
- package/dist/models/UploadSemanticFileRequest.js.map +1 -0
- package/dist/models/UploadSemanticFileResponse.d.ts +19 -0
- package/dist/models/UploadSemanticFileResponse.js +69 -0
- package/dist/models/UploadSemanticFileResponse.js.map +1 -0
- package/dist/models/UploadSemanticFileResponseBody.d.ts +67 -0
- package/dist/models/UploadSemanticFileResponseBody.js +88 -0
- package/dist/models/UploadSemanticFileResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +98 -0
- package/dist/models/model.js +241 -43
- package/dist/models/model.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +1699 -188
- package/src/models/CreateAgentRequest.ts +105 -15
- package/src/models/CreateAgentResponseBody.ts +4 -4
- package/src/models/CreateAgentSessionRequest.ts +32 -10
- package/src/models/CreateAgentSessionResponseBody.ts +4 -4
- package/src/models/CreateAgentSessionShrinkRequest.ts +2 -2
- package/src/models/CreateAgentShrinkRequest.ts +7 -7
- package/src/models/CreateCrawlerRequest.ts +162 -0
- package/src/models/CreateCrawlerResponse.ts +40 -0
- package/src/models/CreateCrawlerResponseBody.ts +41 -0
- package/src/models/CreateCrawlerShrinkRequest.ts +73 -0
- package/src/models/CreateCustomAttributeRequest.ts +13 -17
- package/src/models/CreateCustomAttributeResponseBody.ts +1 -1
- package/src/models/CreateCustomAttributeShrinkRequest.ts +13 -17
- package/src/models/CreateFileRequest.ts +88 -92
- package/src/models/CreateFileResponseBody.ts +4 -5
- package/src/models/CreateMetaEntityDefRequest.ts +7 -8
- package/src/models/CreateMetaEntityDefResponseBody.ts +1 -1
- package/src/models/CreateMetaEntityDefShrinkRequest.ts +7 -8
- package/src/models/CreateSemanticJobRequest.ts +93 -0
- package/src/models/CreateSemanticJobResponse.ts +40 -0
- package/src/models/CreateSemanticJobResponseBody.ts +191 -0
- package/src/models/CreateSemanticJobShrinkRequest.ts +84 -0
- package/src/models/CreateSkillRequest.ts +35 -0
- package/src/models/CreateSkillResponseBody.ts +41 -0
- package/src/models/CreateSkillShrinkRequest.ts +27 -0
- package/src/models/DeleteAgentRequest.ts +2 -0
- package/src/models/DeleteAgentResponseBody.ts +3 -0
- package/src/models/DeleteCrawlerRequest.ts +34 -0
- package/src/models/DeleteCrawlerResponse.ts +40 -0
- package/src/models/DeleteCrawlerResponseBody.ts +41 -0
- package/src/models/DeleteLineageRelationshipRequest.ts +1 -1
- package/src/models/DeleteLineageRelationshipResponseBody.ts +2 -3
- package/src/models/DeleteMetaEntityDefRequest.ts +8 -0
- package/src/models/DeleteMetaEntityDefResponseBody.ts +6 -0
- package/src/models/DeleteSemanticJobRequest.ts +36 -0
- package/src/models/DeleteSemanticJobResponse.ts +40 -0
- package/src/models/DeleteSemanticJobResponseBody.ts +108 -0
- package/src/models/DownloadSemanticResultsRequest.ts +46 -0
- package/src/models/DownloadSemanticResultsResponse.ts +40 -0
- package/src/models/DownloadSemanticResultsResponseBody.ts +131 -0
- package/src/models/GetCrawlerRequest.ts +34 -0
- package/src/models/GetCrawlerResponse.ts +40 -0
- package/src/models/GetCrawlerResponseBody.ts +260 -0
- package/src/models/GetCrawlerTypeCapabilitiesRequest.ts +24 -0
- package/src/models/GetCrawlerTypeCapabilitiesResponse.ts +40 -0
- package/src/models/GetCrawlerTypeCapabilitiesResponseBody.ts +211 -0
- package/src/models/GetSemanticJobDetailRequest.ts +48 -0
- package/src/models/GetSemanticJobDetailResponse.ts +40 -0
- package/src/models/GetSemanticJobDetailResponseBody.ts +201 -0
- package/src/models/GetSemanticJobLogRequest.ts +48 -0
- package/src/models/GetSemanticJobLogResponse.ts +40 -0
- package/src/models/GetSemanticJobLogResponseBody.ts +88 -0
- package/src/models/GetTableRequest.ts +11 -5
- package/src/models/GetTableResponseBody.ts +1 -1
- package/src/models/ImportWorkflowDefinitionRequest.ts +10 -5
- package/src/models/ImportWorkflowDefinitionResponseBody.ts +3 -3
- package/src/models/KillSemanticJobRequest.ts +58 -0
- package/src/models/KillSemanticJobResponse.ts +40 -0
- package/src/models/KillSemanticJobResponseBody.ts +48 -0
- package/src/models/ListColumnsRequest.ts +14 -7
- package/src/models/ListColumnsResponseBody.ts +3 -3
- package/src/models/ListCrawlerRunsRequest.ts +69 -0
- package/src/models/ListCrawlerRunsResponse.ts +40 -0
- package/src/models/ListCrawlerRunsResponseBody.ts +149 -0
- package/src/models/ListCrawlersRequest.ts +79 -0
- package/src/models/ListCrawlersResponse.ts +40 -0
- package/src/models/ListCrawlersResponseBody.ts +245 -0
- package/src/models/ListCrawlersShrinkRequest.ts +76 -0
- package/src/models/ListCustomAttributesRequest.ts +4 -4
- package/src/models/ListCustomAttributesResponseBody.ts +5 -5
- package/src/models/ListDataAssetsRequest.ts +15 -6
- package/src/models/ListDataAssetsResponseBody.ts +20 -7
- package/src/models/ListDataAssetsShrinkRequest.ts +14 -5
- package/src/models/ListDataQualityTemplatesRequest.ts +4 -4
- package/src/models/ListDataQualityTemplatesResponseBody.ts +8 -8
- package/src/models/ListLineageRelationshipsRequest.ts +12 -11
- package/src/models/ListLineageRelationshipsResponseBody.ts +5 -5
- package/src/models/ListMetaCollectionsRequest.ts +19 -26
- package/src/models/ListMetaCollectionsResponseBody.ts +13 -15
- package/src/models/ListMetaEntitiesRequest.ts +13 -13
- package/src/models/ListMetaEntitiesResponseBody.ts +5 -5
- package/src/models/ListMetaEntitiesShrinkRequest.ts +9 -9
- package/src/models/ListMetaEntityDefsRequest.ts +17 -7
- package/src/models/ListMetaEntityDefsResponseBody.ts +6 -6
- package/src/models/ListPartitionsRequest.ts +13 -16
- package/src/models/ListPartitionsResponseBody.ts +4 -4
- package/src/models/ListSemanticJobRunsRequest.ts +56 -0
- package/src/models/ListSemanticJobRunsResponse.ts +40 -0
- package/src/models/ListSemanticJobRunsResponseBody.ts +181 -0
- package/src/models/ListSemanticJobsRequest.ts +44 -0
- package/src/models/ListSemanticJobsResponse.ts +40 -0
- package/src/models/ListSemanticJobsResponseBody.ts +251 -0
- package/src/models/ListTablesRequest.ts +13 -6
- package/src/models/ListTablesShrinkRequest.ts +13 -6
- package/src/models/LoadAgentSessionRequest.ts +1 -1
- package/src/models/PromptAgentSessionRequest.ts +17 -16
- package/src/models/PromptAgentSessionResponseBody.ts +5 -5
- package/src/models/PromptAgentSessionShrinkRequest.ts +1 -1
- package/src/models/RerunTaskInstancesRequest.ts +7 -0
- package/src/models/RerunTaskInstancesResponseBody.ts +1 -1
- package/src/models/RerunTaskInstancesShrinkRequest.ts +7 -0
- package/src/models/RunCrawlerRequest.ts +34 -0
- package/src/models/RunCrawlerResponse.ts +40 -0
- package/src/models/RunCrawlerResponseBody.ts +58 -0
- package/src/models/RunSemanticJobRequest.ts +36 -0
- package/src/models/RunSemanticJobResponse.ts +40 -0
- package/src/models/RunSemanticJobResponseBody.ts +131 -0
- package/src/models/StopCrawlerRequest.ts +34 -0
- package/src/models/StopCrawlerResponse.ts +40 -0
- package/src/models/StopCrawlerResponseBody.ts +44 -0
- package/src/models/UpdateCrawlerRequest.ts +142 -0
- package/src/models/UpdateCrawlerResponse.ts +40 -0
- package/src/models/UpdateCrawlerResponseBody.ts +41 -0
- package/src/models/UpdateCrawlerShrinkRequest.ts +53 -0
- package/src/models/UpdateMetaEntityDefRequest.ts +2 -2
- package/src/models/UpdateMetaEntityDefShrinkRequest.ts +2 -2
- package/src/models/UpdateSkillRequest.ts +149 -0
- package/src/models/UpdateSkillResponse.ts +40 -0
- package/src/models/UpdateSkillResponseBody.ts +198 -0
- package/src/models/UpdateSkillShrinkRequest.ts +103 -0
- package/src/models/UpdateTableBusinessMetadataRequest.ts +3 -3
- package/src/models/UpdateTableBusinessMetadataShrinkRequest.ts +3 -3
- package/src/models/UploadSemanticFileRequest.ts +60 -0
- package/src/models/UploadSemanticFileResponse.ts +40 -0
- package/src/models/UploadSemanticFileResponseBody.ts +101 -0
- package/src/models/model.ts +98 -0
package/dist/client.d.ts
CHANGED
|
@@ -310,15 +310,15 @@ export default class Client extends OpenApi {
|
|
|
310
310
|
*/
|
|
311
311
|
cloneDataSource(request: $_model.CloneDataSourceRequest): Promise<$_model.CloneDataSourceResponse>;
|
|
312
312
|
/**
|
|
313
|
-
*
|
|
313
|
+
* Creates an Agent.
|
|
314
314
|
*
|
|
315
315
|
* @remarks
|
|
316
|
-
* ##
|
|
317
|
-
* - **Agent
|
|
318
|
-
* - **Model
|
|
319
|
-
* - **Visibility
|
|
320
|
-
* - **Visibility
|
|
321
|
-
* - **Other
|
|
316
|
+
* ## Operation description
|
|
317
|
+
* - **Agent name**: Must be unique within the current account.
|
|
318
|
+
* - **Model configuration**: An optional parameter that specifies the model used by the Agent and its related settings.
|
|
319
|
+
* - **Visibility level**: Defines who can access the Agent. Supported levels include account-wide, project-specific, or user-specific visibility.
|
|
320
|
+
* - **Visibility scope**: When you set the visibility level to `PROJECT` or `USER`, you must specify the list of project IDs or user IDs.
|
|
321
|
+
* - **Other parameters**: Parameters such as display name and description are optional. Set them as needed.
|
|
322
322
|
*
|
|
323
323
|
* @param tmpReq - CreateAgentRequest
|
|
324
324
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -326,29 +326,32 @@ export default class Client extends OpenApi {
|
|
|
326
326
|
*/
|
|
327
327
|
createAgentWithOptions(tmpReq: $_model.CreateAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentResponse>;
|
|
328
328
|
/**
|
|
329
|
-
*
|
|
329
|
+
* Creates an Agent.
|
|
330
330
|
*
|
|
331
331
|
* @remarks
|
|
332
|
-
* ##
|
|
333
|
-
* - **Agent
|
|
334
|
-
* - **Model
|
|
335
|
-
* - **Visibility
|
|
336
|
-
* - **Visibility
|
|
337
|
-
* - **Other
|
|
332
|
+
* ## Operation description
|
|
333
|
+
* - **Agent name**: Must be unique within the current account.
|
|
334
|
+
* - **Model configuration**: An optional parameter that specifies the model used by the Agent and its related settings.
|
|
335
|
+
* - **Visibility level**: Defines who can access the Agent. Supported levels include account-wide, project-specific, or user-specific visibility.
|
|
336
|
+
* - **Visibility scope**: When you set the visibility level to `PROJECT` or `USER`, you must specify the list of project IDs or user IDs.
|
|
337
|
+
* - **Other parameters**: Parameters such as display name and description are optional. Set them as needed.
|
|
338
338
|
*
|
|
339
339
|
* @param request - CreateAgentRequest
|
|
340
340
|
* @returns CreateAgentResponse
|
|
341
341
|
*/
|
|
342
342
|
createAgent(request: $_model.CreateAgentRequest): Promise<$_model.CreateAgentResponse>;
|
|
343
343
|
/**
|
|
344
|
-
* Creates a new agent session and returns
|
|
344
|
+
* Creates a new agent session and returns the session ID.
|
|
345
345
|
*
|
|
346
346
|
* @remarks
|
|
347
|
-
* ##
|
|
348
|
-
* - This
|
|
349
|
-
* -
|
|
350
|
-
* -
|
|
351
|
-
* -
|
|
347
|
+
* ## Request description
|
|
348
|
+
* - This operation creates a new agent session.
|
|
349
|
+
* - Use `_meta.agent.agentName` to specify the bound agent name. This parameter is required.
|
|
350
|
+
* - dataworks_data_agent: DataWorks built-in agent — Data Agent, which provides intelligent data development AI capabilities covering the entire workflow of data integration, development, O&M, governance, and analytics.
|
|
351
|
+
* - dataworks_chatbi_agent: DataWorks built-in agent — ChatBI, which uses natural language processing and intelligent analytics technologies to automate the entire analysis workflow from requirement parsing, data extraction, and automatic code generation to visualization report output through conversational interaction.
|
|
352
|
+
* - dataworks_ai_assistant_agent: DataWorks built-in agent — AI Assistant Service, which is a DataWorks enterprise-grade dedicated AI assistant built on open source frameworks such as OpenClaw and Hermes Agent.
|
|
353
|
+
* - Use `_meta.config.sessionSource` to pass through a session source identifier for subsequent retrieval by source.
|
|
354
|
+
* - Use `_meta.config.sessionTags[].sessionTagCode` to pass in session tags.
|
|
352
355
|
*
|
|
353
356
|
* @param tmpReq - CreateAgentSessionRequest
|
|
354
357
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -356,14 +359,17 @@ export default class Client extends OpenApi {
|
|
|
356
359
|
*/
|
|
357
360
|
createAgentSessionWithOptions(tmpReq: $_model.CreateAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateAgentSessionResponse>;
|
|
358
361
|
/**
|
|
359
|
-
* Creates a new agent session and returns
|
|
362
|
+
* Creates a new agent session and returns the session ID.
|
|
360
363
|
*
|
|
361
364
|
* @remarks
|
|
362
|
-
* ##
|
|
363
|
-
* - This
|
|
364
|
-
* -
|
|
365
|
-
* -
|
|
366
|
-
* -
|
|
365
|
+
* ## Request description
|
|
366
|
+
* - This operation creates a new agent session.
|
|
367
|
+
* - Use `_meta.agent.agentName` to specify the bound agent name. This parameter is required.
|
|
368
|
+
* - dataworks_data_agent: DataWorks built-in agent — Data Agent, which provides intelligent data development AI capabilities covering the entire workflow of data integration, development, O&M, governance, and analytics.
|
|
369
|
+
* - dataworks_chatbi_agent: DataWorks built-in agent — ChatBI, which uses natural language processing and intelligent analytics technologies to automate the entire analysis workflow from requirement parsing, data extraction, and automatic code generation to visualization report output through conversational interaction.
|
|
370
|
+
* - dataworks_ai_assistant_agent: DataWorks built-in agent — AI Assistant Service, which is a DataWorks enterprise-grade dedicated AI assistant built on open source frameworks such as OpenClaw and Hermes Agent.
|
|
371
|
+
* - Use `_meta.config.sessionSource` to pass through a session source identifier for subsequent retrieval by source.
|
|
372
|
+
* - Use `_meta.config.sessionTags[].sessionTagCode` to pass in session tags.
|
|
367
373
|
*
|
|
368
374
|
* @param request - CreateAgentSessionRequest
|
|
369
375
|
* @returns CreateAgentSessionResponse
|
|
@@ -447,6 +453,45 @@ export default class Client extends OpenApi {
|
|
|
447
453
|
* @returns CreateComputeResourceResponse
|
|
448
454
|
*/
|
|
449
455
|
createComputeResource(request: $_model.CreateComputeResourceRequest): Promise<$_model.CreateComputeResourceResponse>;
|
|
456
|
+
/**
|
|
457
|
+
* 创建元数据采集器
|
|
458
|
+
*
|
|
459
|
+
* @remarks
|
|
460
|
+
* ## 使用场景
|
|
461
|
+
* 为指定数据源创建元数据采集器,并配置采集范围、资源组、调度方式和扩展配置。
|
|
462
|
+
* ## 推荐流程
|
|
463
|
+
* 1. 调用 `GetCrawlerTypeCapabilities` 查询当前地域支持的采集器类型及其配置能力。
|
|
464
|
+
* 2. 使用与 `Type` 匹配的数据源创建采集器。
|
|
465
|
+
* 3. 创建成功后,调用 `RunCrawler` 手动运行,或通过周期调度自动运行。
|
|
466
|
+
* ## 版本要求
|
|
467
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
468
|
+
* ## 注意事项
|
|
469
|
+
* 创建成功仅表示采集器配置已生成,不会立即执行元数据采集。
|
|
470
|
+
*
|
|
471
|
+
* @param tmpReq - CreateCrawlerRequest
|
|
472
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
473
|
+
* @returns CreateCrawlerResponse
|
|
474
|
+
*/
|
|
475
|
+
createCrawlerWithOptions(tmpReq: $_model.CreateCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateCrawlerResponse>;
|
|
476
|
+
/**
|
|
477
|
+
* 创建元数据采集器
|
|
478
|
+
*
|
|
479
|
+
* @remarks
|
|
480
|
+
* ## 使用场景
|
|
481
|
+
* 为指定数据源创建元数据采集器,并配置采集范围、资源组、调度方式和扩展配置。
|
|
482
|
+
* ## 推荐流程
|
|
483
|
+
* 1. 调用 `GetCrawlerTypeCapabilities` 查询当前地域支持的采集器类型及其配置能力。
|
|
484
|
+
* 2. 使用与 `Type` 匹配的数据源创建采集器。
|
|
485
|
+
* 3. 创建成功后,调用 `RunCrawler` 手动运行,或通过周期调度自动运行。
|
|
486
|
+
* ## 版本要求
|
|
487
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
488
|
+
* ## 注意事项
|
|
489
|
+
* 创建成功仅表示采集器配置已生成,不会立即执行元数据采集。
|
|
490
|
+
*
|
|
491
|
+
* @param request - CreateCrawlerRequest
|
|
492
|
+
* @returns CreateCrawlerResponse
|
|
493
|
+
*/
|
|
494
|
+
createCrawler(request: $_model.CreateCrawlerRequest): Promise<$_model.CreateCrawlerResponse>;
|
|
450
495
|
/**
|
|
451
496
|
* Creates a custom attribute definition.
|
|
452
497
|
*
|
|
@@ -776,7 +821,7 @@ export default class Client extends OpenApi {
|
|
|
776
821
|
*/
|
|
777
822
|
createDatasetVersion(request: $_model.CreateDatasetVersionRequest): Promise<$_model.CreateDatasetVersionResponse>;
|
|
778
823
|
/**
|
|
779
|
-
* Creates a file in DataStudio.
|
|
824
|
+
* Creates a file in DataStudio. This operation does not support creating Data Integration nodes.
|
|
780
825
|
*
|
|
781
826
|
* @param request - CreateFileRequest
|
|
782
827
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -784,7 +829,7 @@ export default class Client extends OpenApi {
|
|
|
784
829
|
*/
|
|
785
830
|
createFileWithOptions(request: $_model.CreateFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateFileResponse>;
|
|
786
831
|
/**
|
|
787
|
-
* Creates a file in DataStudio.
|
|
832
|
+
* Creates a file in DataStudio. This operation does not support creating Data Integration nodes.
|
|
788
833
|
*
|
|
789
834
|
* @param request - CreateFileRequest
|
|
790
835
|
* @returns CreateFileResponse
|
|
@@ -923,10 +968,10 @@ export default class Client extends OpenApi {
|
|
|
923
968
|
*/
|
|
924
969
|
createMetaCollection(request: $_model.CreateMetaCollectionRequest): Promise<$_model.CreateMetaCollectionResponse>;
|
|
925
970
|
/**
|
|
926
|
-
* Creates a metadata entity definition
|
|
971
|
+
* Creates a metadata entity definition, including custom types and extended table types.
|
|
927
972
|
*
|
|
928
973
|
* @remarks
|
|
929
|
-
*
|
|
974
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
930
975
|
*
|
|
931
976
|
* @param tmpReq - CreateMetaEntityDefRequest
|
|
932
977
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -934,10 +979,10 @@ export default class Client extends OpenApi {
|
|
|
934
979
|
*/
|
|
935
980
|
createMetaEntityDefWithOptions(tmpReq: $_model.CreateMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMetaEntityDefResponse>;
|
|
936
981
|
/**
|
|
937
|
-
* Creates a metadata entity definition
|
|
982
|
+
* Creates a metadata entity definition, including custom types and extended table types.
|
|
938
983
|
*
|
|
939
984
|
* @remarks
|
|
940
|
-
*
|
|
985
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
941
986
|
*
|
|
942
987
|
* @param request - CreateMetaEntityDefRequest
|
|
943
988
|
* @returns CreateMetaEntityDefResponse
|
|
@@ -1235,13 +1280,48 @@ export default class Client extends OpenApi {
|
|
|
1235
1280
|
*/
|
|
1236
1281
|
createSecurityStrategy(request: $_model.CreateSecurityStrategyRequest): Promise<$_model.CreateSecurityStrategyResponse>;
|
|
1237
1282
|
/**
|
|
1238
|
-
*
|
|
1283
|
+
* Saves a reusable semantic job definition. If you use a single-file source, apply for and complete the attachment upload first. After creation, call RunSemanticJob with the returned Name.
|
|
1239
1284
|
*
|
|
1240
1285
|
* @remarks
|
|
1241
|
-
* ##
|
|
1242
|
-
*
|
|
1243
|
-
*
|
|
1244
|
-
*
|
|
1286
|
+
* ## Scenarios
|
|
1287
|
+
* Creates and saves a reusable semantic job definition. This operation only saves the data source, resource group, and reference file configurations without immediately executing the job.
|
|
1288
|
+
* ## Recommended workflow
|
|
1289
|
+
* 1. When `Source.type=singleTableFile`, call `UploadSemanticFile` first, use the returned `Data.UploadUrl` to complete the PUT upload, and then specify `Data.FileId` in `ReferenceFileIds`. Alternatively, you can provide a single accessible URI.
|
|
1290
|
+
* 2. Configure `Source`, `ProjectId`, and `ResourceGroupId`, and then call this operation to save the job.
|
|
1291
|
+
* 3. Use `Data.Name` from the response to call `RunSemanticJob`. After the job is complete, use `DownloadSemanticResults` to retrieve the output.
|
|
1292
|
+
* ## Before you begin
|
|
1293
|
+
* `Name` must be unique within the current tenant. The reference file quantity rules differ between single-file sources and other sources. For details, refer to the descriptions of the `ReferenceFileIds` and `ReferenceFileUris` fields.
|
|
1294
|
+
*
|
|
1295
|
+
* @param tmpReq - CreateSemanticJobRequest
|
|
1296
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1297
|
+
* @returns CreateSemanticJobResponse
|
|
1298
|
+
*/
|
|
1299
|
+
createSemanticJobWithOptions(tmpReq: $_model.CreateSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSemanticJobResponse>;
|
|
1300
|
+
/**
|
|
1301
|
+
* Saves a reusable semantic job definition. If you use a single-file source, apply for and complete the attachment upload first. After creation, call RunSemanticJob with the returned Name.
|
|
1302
|
+
*
|
|
1303
|
+
* @remarks
|
|
1304
|
+
* ## Scenarios
|
|
1305
|
+
* Creates and saves a reusable semantic job definition. This operation only saves the data source, resource group, and reference file configurations without immediately executing the job.
|
|
1306
|
+
* ## Recommended workflow
|
|
1307
|
+
* 1. When `Source.type=singleTableFile`, call `UploadSemanticFile` first, use the returned `Data.UploadUrl` to complete the PUT upload, and then specify `Data.FileId` in `ReferenceFileIds`. Alternatively, you can provide a single accessible URI.
|
|
1308
|
+
* 2. Configure `Source`, `ProjectId`, and `ResourceGroupId`, and then call this operation to save the job.
|
|
1309
|
+
* 3. Use `Data.Name` from the response to call `RunSemanticJob`. After the job is complete, use `DownloadSemanticResults` to retrieve the output.
|
|
1310
|
+
* ## Before you begin
|
|
1311
|
+
* `Name` must be unique within the current tenant. The reference file quantity rules differ between single-file sources and other sources. For details, refer to the descriptions of the `ReferenceFileIds` and `ReferenceFileUris` fields.
|
|
1312
|
+
*
|
|
1313
|
+
* @param request - CreateSemanticJobRequest
|
|
1314
|
+
* @returns CreateSemanticJobResponse
|
|
1315
|
+
*/
|
|
1316
|
+
createSemanticJob(request: $_model.CreateSemanticJobRequest): Promise<$_model.CreateSemanticJobResponse>;
|
|
1317
|
+
/**
|
|
1318
|
+
* Creates a new Skill in DataWorks.
|
|
1319
|
+
*
|
|
1320
|
+
* @remarks
|
|
1321
|
+
* ## Request description
|
|
1322
|
+
* - You must provide either SkillMdOverride or BundleUrl. One of the two parameters is required.
|
|
1323
|
+
* - Visibility can be set to `TENANT`, `PROJECT`, or `USER`, which indicate visibility within the account, visibility to specified projects, or visibility to specified users, respectively.
|
|
1324
|
+
* - When Visibility is set to `PROJECT`, specify the list of visible project IDs by using VisibilityScope.ProjectIds. When Visibility is set to `USER`, specify the list of visible user IDs by using VisibilityScope.UserIds.
|
|
1245
1325
|
*
|
|
1246
1326
|
* @param tmpReq - CreateSkillRequest
|
|
1247
1327
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1249,13 +1329,13 @@ export default class Client extends OpenApi {
|
|
|
1249
1329
|
*/
|
|
1250
1330
|
createSkillWithOptions(tmpReq: $_model.CreateSkillRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSkillResponse>;
|
|
1251
1331
|
/**
|
|
1252
|
-
*
|
|
1332
|
+
* Creates a new Skill in DataWorks.
|
|
1253
1333
|
*
|
|
1254
1334
|
* @remarks
|
|
1255
|
-
* ##
|
|
1256
|
-
* -
|
|
1257
|
-
* -
|
|
1258
|
-
* -
|
|
1335
|
+
* ## Request description
|
|
1336
|
+
* - You must provide either SkillMdOverride or BundleUrl. One of the two parameters is required.
|
|
1337
|
+
* - Visibility can be set to `TENANT`, `PROJECT`, or `USER`, which indicate visibility within the account, visibility to specified projects, or visibility to specified users, respectively.
|
|
1338
|
+
* - When Visibility is set to `PROJECT`, specify the list of visible project IDs by using VisibilityScope.ProjectIds. When Visibility is set to `USER`, specify the list of visible user IDs by using VisibilityScope.UserIds.
|
|
1259
1339
|
*
|
|
1260
1340
|
* @param request - CreateSkillRequest
|
|
1261
1341
|
* @returns CreateSkillResponse
|
|
@@ -1321,11 +1401,11 @@ export default class Client extends OpenApi {
|
|
|
1321
1401
|
*/
|
|
1322
1402
|
createWorkflowInstances(request: $_model.CreateWorkflowInstancesRequest): Promise<$_model.CreateWorkflowInstancesResponse>;
|
|
1323
1403
|
/**
|
|
1324
|
-
*
|
|
1404
|
+
* Deletes an Agent.
|
|
1325
1405
|
*
|
|
1326
1406
|
* @remarks
|
|
1327
|
-
* ##
|
|
1328
|
-
*
|
|
1407
|
+
* ## Operation description
|
|
1408
|
+
* This API operation deletes an Agent with the specified name from DataWorks. When calling this operation, you must provide the name of the Agent to delete.
|
|
1329
1409
|
*
|
|
1330
1410
|
* @param request - DeleteAgentRequest
|
|
1331
1411
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1333,11 +1413,11 @@ export default class Client extends OpenApi {
|
|
|
1333
1413
|
*/
|
|
1334
1414
|
deleteAgentWithOptions(request: $_model.DeleteAgentRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteAgentResponse>;
|
|
1335
1415
|
/**
|
|
1336
|
-
*
|
|
1416
|
+
* Deletes an Agent.
|
|
1337
1417
|
*
|
|
1338
1418
|
* @remarks
|
|
1339
|
-
* ##
|
|
1340
|
-
*
|
|
1419
|
+
* ## Operation description
|
|
1420
|
+
* This API operation deletes an Agent with the specified name from DataWorks. When calling this operation, you must provide the name of the Agent to delete.
|
|
1341
1421
|
*
|
|
1342
1422
|
* @param request - DeleteAgentRequest
|
|
1343
1423
|
* @returns DeleteAgentResponse
|
|
@@ -1444,6 +1524,43 @@ export default class Client extends OpenApi {
|
|
|
1444
1524
|
* @returns DeleteComputeResourceResponse
|
|
1445
1525
|
*/
|
|
1446
1526
|
deleteComputeResource(request: $_model.DeleteComputeResourceRequest): Promise<$_model.DeleteComputeResourceResponse>;
|
|
1527
|
+
/**
|
|
1528
|
+
* 删除元数据采集器
|
|
1529
|
+
*
|
|
1530
|
+
* @remarks
|
|
1531
|
+
* ## 使用场景
|
|
1532
|
+
* 删除不再使用的元数据采集器。
|
|
1533
|
+
* ## 推荐流程
|
|
1534
|
+
* 1. 调用 `ListCrawlers` 查询采集器 ID。
|
|
1535
|
+
* 2. 确认采集器不再需要后调用本接口。
|
|
1536
|
+
* ## 版本要求
|
|
1537
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
1538
|
+
* ## 注意事项
|
|
1539
|
+
* 删除成功后,该采集器不能继续查询、更新或运行。已采集元数据由系统清理,清理结果可能存在延迟。
|
|
1540
|
+
*
|
|
1541
|
+
* @param request - DeleteCrawlerRequest
|
|
1542
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1543
|
+
* @returns DeleteCrawlerResponse
|
|
1544
|
+
*/
|
|
1545
|
+
deleteCrawlerWithOptions(request: $_model.DeleteCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteCrawlerResponse>;
|
|
1546
|
+
/**
|
|
1547
|
+
* 删除元数据采集器
|
|
1548
|
+
*
|
|
1549
|
+
* @remarks
|
|
1550
|
+
* ## 使用场景
|
|
1551
|
+
* 删除不再使用的元数据采集器。
|
|
1552
|
+
* ## 推荐流程
|
|
1553
|
+
* 1. 调用 `ListCrawlers` 查询采集器 ID。
|
|
1554
|
+
* 2. 确认采集器不再需要后调用本接口。
|
|
1555
|
+
* ## 版本要求
|
|
1556
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
1557
|
+
* ## 注意事项
|
|
1558
|
+
* 删除成功后,该采集器不能继续查询、更新或运行。已采集元数据由系统清理,清理结果可能存在延迟。
|
|
1559
|
+
*
|
|
1560
|
+
* @param request - DeleteCrawlerRequest
|
|
1561
|
+
* @returns DeleteCrawlerResponse
|
|
1562
|
+
*/
|
|
1563
|
+
deleteCrawler(request: $_model.DeleteCrawlerRequest): Promise<$_model.DeleteCrawlerResponse>;
|
|
1447
1564
|
/**
|
|
1448
1565
|
* Deletes a custom attribute definition.
|
|
1449
1566
|
*
|
|
@@ -1784,10 +1901,10 @@ export default class Client extends OpenApi {
|
|
|
1784
1901
|
*/
|
|
1785
1902
|
deleteFunction(request: $_model.DeleteFunctionRequest): Promise<$_model.DeleteFunctionResponse>;
|
|
1786
1903
|
/**
|
|
1787
|
-
* Deletes a lineage
|
|
1904
|
+
* Deletes a specified data lineage relationship from DataWorks Data Map.
|
|
1788
1905
|
*
|
|
1789
1906
|
* @remarks
|
|
1790
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
1907
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
1791
1908
|
*
|
|
1792
1909
|
* @param request - DeleteLineageRelationshipRequest
|
|
1793
1910
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1795,10 +1912,10 @@ export default class Client extends OpenApi {
|
|
|
1795
1912
|
*/
|
|
1796
1913
|
deleteLineageRelationshipWithOptions(request: $_model.DeleteLineageRelationshipRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteLineageRelationshipResponse>;
|
|
1797
1914
|
/**
|
|
1798
|
-
* Deletes a lineage
|
|
1915
|
+
* Deletes a specified data lineage relationship from DataWorks Data Map.
|
|
1799
1916
|
*
|
|
1800
1917
|
* @remarks
|
|
1801
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
1918
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
1802
1919
|
*
|
|
1803
1920
|
* @param request - DeleteLineageRelationshipRequest
|
|
1804
1921
|
* @returns DeleteLineageRelationshipResponse
|
|
@@ -1857,10 +1974,10 @@ export default class Client extends OpenApi {
|
|
|
1857
1974
|
*/
|
|
1858
1975
|
deleteMetaCollection(request: $_model.DeleteMetaCollectionRequest): Promise<$_model.DeleteMetaCollectionResponse>;
|
|
1859
1976
|
/**
|
|
1860
|
-
*
|
|
1977
|
+
* Deletes a metadata entity definition, including custom entity types and extension table types.
|
|
1861
1978
|
*
|
|
1862
1979
|
* @remarks
|
|
1863
|
-
*
|
|
1980
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
1864
1981
|
*
|
|
1865
1982
|
* @param request - DeleteMetaEntityDefRequest
|
|
1866
1983
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1868,10 +1985,10 @@ export default class Client extends OpenApi {
|
|
|
1868
1985
|
*/
|
|
1869
1986
|
deleteMetaEntityDefWithOptions(request: $_model.DeleteMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteMetaEntityDefResponse>;
|
|
1870
1987
|
/**
|
|
1871
|
-
*
|
|
1988
|
+
* Deletes a metadata entity definition, including custom entity types and extension table types.
|
|
1872
1989
|
*
|
|
1873
1990
|
* @remarks
|
|
1874
|
-
*
|
|
1991
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
1875
1992
|
*
|
|
1876
1993
|
* @param request - DeleteMetaEntityDefRequest
|
|
1877
1994
|
* @returns DeleteMetaEntityDefResponse
|
|
@@ -2122,6 +2239,41 @@ export default class Client extends OpenApi {
|
|
|
2122
2239
|
* @returns DeleteSecurityStrategyResponse
|
|
2123
2240
|
*/
|
|
2124
2241
|
deleteSecurityStrategy(request: $_model.DeleteSecurityStrategyRequest): Promise<$_model.DeleteSecurityStrategyResponse>;
|
|
2242
|
+
/**
|
|
2243
|
+
* Deletes a semantic job definition by the Name of a created job. If the job is currently running, call KillSemanticJob with the ExecutorJobId of that run and confirm the stop before deletion.
|
|
2244
|
+
*
|
|
2245
|
+
* @remarks
|
|
2246
|
+
* ## Scenarios
|
|
2247
|
+
* Archives and deletes a saved semantic job definition so that it no longer appears in the list of available jobs.
|
|
2248
|
+
* ## Call flow
|
|
2249
|
+
* 1. Obtain the job name from `CreateSemanticJob.Data.Name` or `ListSemanticJobs.Data.SemanticJobs[].Name`.
|
|
2250
|
+
* 2. To check whether any active runs exist, call `ListSemanticJobRuns` first. If necessary, stop the execution by calling `KillSemanticJob`.
|
|
2251
|
+
* 3. Call this operation to delete the job definition.
|
|
2252
|
+
* ## Result description
|
|
2253
|
+
* A successful response indicates that the deletion request is complete. After deletion, you can no longer use the name to call `RunSemanticJob`.
|
|
2254
|
+
*
|
|
2255
|
+
* @param request - DeleteSemanticJobRequest
|
|
2256
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2257
|
+
* @returns DeleteSemanticJobResponse
|
|
2258
|
+
*/
|
|
2259
|
+
deleteSemanticJobWithOptions(request: $_model.DeleteSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSemanticJobResponse>;
|
|
2260
|
+
/**
|
|
2261
|
+
* Deletes a semantic job definition by the Name of a created job. If the job is currently running, call KillSemanticJob with the ExecutorJobId of that run and confirm the stop before deletion.
|
|
2262
|
+
*
|
|
2263
|
+
* @remarks
|
|
2264
|
+
* ## Scenarios
|
|
2265
|
+
* Archives and deletes a saved semantic job definition so that it no longer appears in the list of available jobs.
|
|
2266
|
+
* ## Call flow
|
|
2267
|
+
* 1. Obtain the job name from `CreateSemanticJob.Data.Name` or `ListSemanticJobs.Data.SemanticJobs[].Name`.
|
|
2268
|
+
* 2. To check whether any active runs exist, call `ListSemanticJobRuns` first. If necessary, stop the execution by calling `KillSemanticJob`.
|
|
2269
|
+
* 3. Call this operation to delete the job definition.
|
|
2270
|
+
* ## Result description
|
|
2271
|
+
* A successful response indicates that the deletion request is complete. After deletion, you can no longer use the name to call `RunSemanticJob`.
|
|
2272
|
+
*
|
|
2273
|
+
* @param request - DeleteSemanticJobRequest
|
|
2274
|
+
* @returns DeleteSemanticJobResponse
|
|
2275
|
+
*/
|
|
2276
|
+
deleteSemanticJob(request: $_model.DeleteSemanticJobRequest): Promise<$_model.DeleteSemanticJobResponse>;
|
|
2125
2277
|
/**
|
|
2126
2278
|
* Delete Skill
|
|
2127
2279
|
*
|
|
@@ -2331,6 +2483,41 @@ export default class Client extends OpenApi {
|
|
|
2331
2483
|
* @returns DissociateProjectFromResourceGroupResponse
|
|
2332
2484
|
*/
|
|
2333
2485
|
dissociateProjectFromResourceGroup(request: $_model.DissociateProjectFromResourceGroupRequest): Promise<$_model.DissociateProjectFromResourceGroupResponse>;
|
|
2486
|
+
/**
|
|
2487
|
+
* Returns the download URL of artifacts by job name and an optional run ID after a run completes. If JobRunId is not specified, the results of the most recent run of the job are returned.
|
|
2488
|
+
*
|
|
2489
|
+
* @remarks
|
|
2490
|
+
* ## Scenarios
|
|
2491
|
+
* Retrieves temporary download URLs for result files of a submitted semantic job run, such as semantic model YAML artifacts. This operation returns download URLs and does not directly return file content.
|
|
2492
|
+
* ## Procedure
|
|
2493
|
+
* 1. Use the job name `JobName` to locate the job.
|
|
2494
|
+
* 2. To retrieve artifacts of a specific run, specify the `JobRunId` from the `RunSemanticJob.Data.JobRunId` or `ListSemanticJobRuns` response. If you do not specify this parameter, the artifacts of the most recent run are returned.
|
|
2495
|
+
* 3. Download the corresponding files from `Data.Results[].DownloadUrl`.
|
|
2496
|
+
* ## Before you begin
|
|
2497
|
+
* The download URL is a temporary credential. Use it only briefly on the client side. Do not write it to logs or store it for long-term use.
|
|
2498
|
+
*
|
|
2499
|
+
* @param request - DownloadSemanticResultsRequest
|
|
2500
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2501
|
+
* @returns DownloadSemanticResultsResponse
|
|
2502
|
+
*/
|
|
2503
|
+
downloadSemanticResultsWithOptions(request: $_model.DownloadSemanticResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DownloadSemanticResultsResponse>;
|
|
2504
|
+
/**
|
|
2505
|
+
* Returns the download URL of artifacts by job name and an optional run ID after a run completes. If JobRunId is not specified, the results of the most recent run of the job are returned.
|
|
2506
|
+
*
|
|
2507
|
+
* @remarks
|
|
2508
|
+
* ## Scenarios
|
|
2509
|
+
* Retrieves temporary download URLs for result files of a submitted semantic job run, such as semantic model YAML artifacts. This operation returns download URLs and does not directly return file content.
|
|
2510
|
+
* ## Procedure
|
|
2511
|
+
* 1. Use the job name `JobName` to locate the job.
|
|
2512
|
+
* 2. To retrieve artifacts of a specific run, specify the `JobRunId` from the `RunSemanticJob.Data.JobRunId` or `ListSemanticJobRuns` response. If you do not specify this parameter, the artifacts of the most recent run are returned.
|
|
2513
|
+
* 3. Download the corresponding files from `Data.Results[].DownloadUrl`.
|
|
2514
|
+
* ## Before you begin
|
|
2515
|
+
* The download URL is a temporary credential. Use it only briefly on the client side. Do not write it to logs or store it for long-term use.
|
|
2516
|
+
*
|
|
2517
|
+
* @param request - DownloadSemanticResultsRequest
|
|
2518
|
+
* @returns DownloadSemanticResultsResponse
|
|
2519
|
+
*/
|
|
2520
|
+
downloadSemanticResults(request: $_model.DownloadSemanticResultsRequest): Promise<$_model.DownloadSemanticResultsResponse>;
|
|
2334
2521
|
/**
|
|
2335
2522
|
* Enables a process definition with the specified ID.
|
|
2336
2523
|
*
|
|
@@ -2677,6 +2864,82 @@ export default class Client extends OpenApi {
|
|
|
2677
2864
|
* @returns GetComputeResourceResponse
|
|
2678
2865
|
*/
|
|
2679
2866
|
getComputeResource(request: $_model.GetComputeResourceRequest): Promise<$_model.GetComputeResourceResponse>;
|
|
2867
|
+
/**
|
|
2868
|
+
* 获取元数据采集器详情
|
|
2869
|
+
*
|
|
2870
|
+
* @remarks
|
|
2871
|
+
* ## 使用场景
|
|
2872
|
+
* 查询指定元数据采集器的配置、可用状态和最近一次运行信息。
|
|
2873
|
+
* ## 推荐流程
|
|
2874
|
+
* 1. 调用 `ListCrawlers` 查询采集器 ID。
|
|
2875
|
+
* 2. 调用本接口获取采集器详情。
|
|
2876
|
+
* 3. 如需查询完整运行历史,调用 `ListCrawlerRuns`。
|
|
2877
|
+
* ## 版本要求
|
|
2878
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
2879
|
+
* ## 注意事项
|
|
2880
|
+
* 采集器尚未运行时,最近运行状态和任务实例 ID 可能为空。
|
|
2881
|
+
*
|
|
2882
|
+
* @param request - GetCrawlerRequest
|
|
2883
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2884
|
+
* @returns GetCrawlerResponse
|
|
2885
|
+
*/
|
|
2886
|
+
getCrawlerWithOptions(request: $_model.GetCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCrawlerResponse>;
|
|
2887
|
+
/**
|
|
2888
|
+
* 获取元数据采集器详情
|
|
2889
|
+
*
|
|
2890
|
+
* @remarks
|
|
2891
|
+
* ## 使用场景
|
|
2892
|
+
* 查询指定元数据采集器的配置、可用状态和最近一次运行信息。
|
|
2893
|
+
* ## 推荐流程
|
|
2894
|
+
* 1. 调用 `ListCrawlers` 查询采集器 ID。
|
|
2895
|
+
* 2. 调用本接口获取采集器详情。
|
|
2896
|
+
* 3. 如需查询完整运行历史,调用 `ListCrawlerRuns`。
|
|
2897
|
+
* ## 版本要求
|
|
2898
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
2899
|
+
* ## 注意事项
|
|
2900
|
+
* 采集器尚未运行时,最近运行状态和任务实例 ID 可能为空。
|
|
2901
|
+
*
|
|
2902
|
+
* @param request - GetCrawlerRequest
|
|
2903
|
+
* @returns GetCrawlerResponse
|
|
2904
|
+
*/
|
|
2905
|
+
getCrawler(request: $_model.GetCrawlerRequest): Promise<$_model.GetCrawlerResponse>;
|
|
2906
|
+
/**
|
|
2907
|
+
* 查询当前地域支持创建的元数据采集器类型及能力
|
|
2908
|
+
*
|
|
2909
|
+
* @remarks
|
|
2910
|
+
* ## 使用场景
|
|
2911
|
+
* 查询当前地域支持创建的采集器类型,以及各类型支持的数据源、采集范围、资源组、调度、AI 元数据描述和扩展配置能力。
|
|
2912
|
+
* ## 推荐流程
|
|
2913
|
+
* 1. 在创建或更新采集器前调用本接口。
|
|
2914
|
+
* 2. 根据返回的能力信息构造 `CreateCrawler` 或 `UpdateCrawler` 请求。
|
|
2915
|
+
* ## 版本要求
|
|
2916
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
2917
|
+
* ## 注意事项
|
|
2918
|
+
* 不同地域和采集器类型的能力可能不同,请以本接口的实际返回结果为准。
|
|
2919
|
+
*
|
|
2920
|
+
* @param request - GetCrawlerTypeCapabilitiesRequest
|
|
2921
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
2922
|
+
* @returns GetCrawlerTypeCapabilitiesResponse
|
|
2923
|
+
*/
|
|
2924
|
+
getCrawlerTypeCapabilitiesWithOptions(request: $_model.GetCrawlerTypeCapabilitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetCrawlerTypeCapabilitiesResponse>;
|
|
2925
|
+
/**
|
|
2926
|
+
* 查询当前地域支持创建的元数据采集器类型及能力
|
|
2927
|
+
*
|
|
2928
|
+
* @remarks
|
|
2929
|
+
* ## 使用场景
|
|
2930
|
+
* 查询当前地域支持创建的采集器类型,以及各类型支持的数据源、采集范围、资源组、调度、AI 元数据描述和扩展配置能力。
|
|
2931
|
+
* ## 推荐流程
|
|
2932
|
+
* 1. 在创建或更新采集器前调用本接口。
|
|
2933
|
+
* 2. 根据返回的能力信息构造 `CreateCrawler` 或 `UpdateCrawler` 请求。
|
|
2934
|
+
* ## 版本要求
|
|
2935
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
2936
|
+
* ## 注意事项
|
|
2937
|
+
* 不同地域和采集器类型的能力可能不同,请以本接口的实际返回结果为准。
|
|
2938
|
+
*
|
|
2939
|
+
* @param request - GetCrawlerTypeCapabilitiesRequest
|
|
2940
|
+
* @returns GetCrawlerTypeCapabilitiesResponse
|
|
2941
|
+
*/
|
|
2942
|
+
getCrawlerTypeCapabilities(request: $_model.GetCrawlerTypeCapabilitiesRequest): Promise<$_model.GetCrawlerTypeCapabilitiesResponse>;
|
|
2680
2943
|
/**
|
|
2681
2944
|
* Queries the result of asynchronously creating a workflow instance.
|
|
2682
2945
|
*
|
|
@@ -3607,6 +3870,76 @@ export default class Client extends OpenApi {
|
|
|
3607
3870
|
* @returns GetSecurityStrategyResponse
|
|
3608
3871
|
*/
|
|
3609
3872
|
getSecurityStrategy(request: $_model.GetSecurityStrategyRequest): Promise<$_model.GetSecurityStrategyResponse>;
|
|
3873
|
+
/**
|
|
3874
|
+
* Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
|
|
3875
|
+
*
|
|
3876
|
+
* @remarks
|
|
3877
|
+
* ## Scenarios
|
|
3878
|
+
* Queries the detailed status and runtime information of a semantic job run on the executor side. This is used to poll execution progress or troubleshoot run failures.
|
|
3879
|
+
* ## Procedure
|
|
3880
|
+
* 1. Call `RunSemanticJob` or `ListSemanticJobRuns` to obtain the `ExecutorJobId`.
|
|
3881
|
+
* 2. Use the `ProjectId` returned by the job definition as the `ProjectId` for this operation.
|
|
3882
|
+
* 3. Determine the current status based on the executor details in `Data`. If the job is still running, continue polling this operation.
|
|
3883
|
+
* ## Related operations
|
|
3884
|
+
* To retrieve logs, call `GetSemanticJobLog`. To stop a run, call `KillSemanticJob`.
|
|
3885
|
+
*
|
|
3886
|
+
* @param request - GetSemanticJobDetailRequest
|
|
3887
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3888
|
+
* @returns GetSemanticJobDetailResponse
|
|
3889
|
+
*/
|
|
3890
|
+
getSemanticJobDetailWithOptions(request: $_model.GetSemanticJobDetailRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetSemanticJobDetailResponse>;
|
|
3891
|
+
/**
|
|
3892
|
+
* Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
|
|
3893
|
+
*
|
|
3894
|
+
* @remarks
|
|
3895
|
+
* ## Scenarios
|
|
3896
|
+
* Queries the detailed status and runtime information of a semantic job run on the executor side. This is used to poll execution progress or troubleshoot run failures.
|
|
3897
|
+
* ## Procedure
|
|
3898
|
+
* 1. Call `RunSemanticJob` or `ListSemanticJobRuns` to obtain the `ExecutorJobId`.
|
|
3899
|
+
* 2. Use the `ProjectId` returned by the job definition as the `ProjectId` for this operation.
|
|
3900
|
+
* 3. Determine the current status based on the executor details in `Data`. If the job is still running, continue polling this operation.
|
|
3901
|
+
* ## Related operations
|
|
3902
|
+
* To retrieve logs, call `GetSemanticJobLog`. To stop a run, call `KillSemanticJob`.
|
|
3903
|
+
*
|
|
3904
|
+
* @param request - GetSemanticJobDetailRequest
|
|
3905
|
+
* @returns GetSemanticJobDetailResponse
|
|
3906
|
+
*/
|
|
3907
|
+
getSemanticJobDetail(request: $_model.GetSemanticJobDetailRequest): Promise<$_model.GetSemanticJobDetailResponse>;
|
|
3908
|
+
/**
|
|
3909
|
+
* Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The current POP contract exposes only the task and workspace identifiers and returns default log segments.
|
|
3910
|
+
*
|
|
3911
|
+
* @remarks
|
|
3912
|
+
* ## Scenarios
|
|
3913
|
+
* Reads the execution logs of a semantic job run to observe the execution process and identify failure causes.
|
|
3914
|
+
* ## Procedure
|
|
3915
|
+
* 1. Specify the run by using `RunSemanticJob.Data.ExecutorJobId` or `ListSemanticJobRuns[].ExecutorJobId`.
|
|
3916
|
+
* 2. Call this operation with the `ProjectId` of the corresponding task.
|
|
3917
|
+
* 3. Analyze the log segments in `Data` together with the run status returned by `GetSemanticJobDetail`.
|
|
3918
|
+
* ## Before you begin
|
|
3919
|
+
* Logs are used for diagnostics and do not represent the final result files. Obtain result artifacts by calling `DownloadSemanticResults`.
|
|
3920
|
+
*
|
|
3921
|
+
* @param request - GetSemanticJobLogRequest
|
|
3922
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
3923
|
+
* @returns GetSemanticJobLogResponse
|
|
3924
|
+
*/
|
|
3925
|
+
getSemanticJobLogWithOptions(request: $_model.GetSemanticJobLogRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetSemanticJobLogResponse>;
|
|
3926
|
+
/**
|
|
3927
|
+
* Queries execution logs by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. The current POP contract exposes only the task and workspace identifiers and returns default log segments.
|
|
3928
|
+
*
|
|
3929
|
+
* @remarks
|
|
3930
|
+
* ## Scenarios
|
|
3931
|
+
* Reads the execution logs of a semantic job run to observe the execution process and identify failure causes.
|
|
3932
|
+
* ## Procedure
|
|
3933
|
+
* 1. Specify the run by using `RunSemanticJob.Data.ExecutorJobId` or `ListSemanticJobRuns[].ExecutorJobId`.
|
|
3934
|
+
* 2. Call this operation with the `ProjectId` of the corresponding task.
|
|
3935
|
+
* 3. Analyze the log segments in `Data` together with the run status returned by `GetSemanticJobDetail`.
|
|
3936
|
+
* ## Before you begin
|
|
3937
|
+
* Logs are used for diagnostics and do not represent the final result files. Obtain result artifacts by calling `DownloadSemanticResults`.
|
|
3938
|
+
*
|
|
3939
|
+
* @param request - GetSemanticJobLogRequest
|
|
3940
|
+
* @returns GetSemanticJobLogResponse
|
|
3941
|
+
*/
|
|
3942
|
+
getSemanticJobLog(request: $_model.GetSemanticJobLogRequest): Promise<$_model.GetSemanticJobLogResponse>;
|
|
3610
3943
|
/**
|
|
3611
3944
|
* Retrieves the details of a specified Skill by name, including the body of the SKILL.md file and the bundle\\"s download link.
|
|
3612
3945
|
*
|
|
@@ -3635,7 +3968,7 @@ export default class Client extends OpenApi {
|
|
|
3635
3968
|
*/
|
|
3636
3969
|
getSkill(request: $_model.GetSkillRequest): Promise<$_model.GetSkillResponse>;
|
|
3637
3970
|
/**
|
|
3638
|
-
* Retrieves the details of a specified
|
|
3971
|
+
* Retrieves the details of a specified table in Data Map. You can choose whether to return business metadata.
|
|
3639
3972
|
*
|
|
3640
3973
|
* @remarks
|
|
3641
3974
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -3646,7 +3979,7 @@ export default class Client extends OpenApi {
|
|
|
3646
3979
|
*/
|
|
3647
3980
|
getTableWithOptions(request: $_model.GetTableRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableResponse>;
|
|
3648
3981
|
/**
|
|
3649
|
-
* Retrieves the details of a specified
|
|
3982
|
+
* Retrieves the details of a specified table in Data Map. You can choose whether to return business metadata.
|
|
3650
3983
|
*
|
|
3651
3984
|
* @remarks
|
|
3652
3985
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -3815,12 +4148,12 @@ export default class Client extends OpenApi {
|
|
|
3815
4148
|
importCertificate(request: $_model.ImportCertificateRequest): Promise<$_model.ImportCertificateResponse>;
|
|
3816
4149
|
importCertificateAdvance(request: $_model.ImportCertificateAdvanceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ImportCertificateResponse>;
|
|
3817
4150
|
/**
|
|
3818
|
-
* Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
|
|
4151
|
+
* Imports a workflow node defined by FlowSpec and its internal child nodes into DataStudio.
|
|
3819
4152
|
*
|
|
3820
4153
|
* @remarks
|
|
3821
4154
|
* >Notice:
|
|
3822
|
-
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows
|
|
3823
|
-
* - This is an asynchronous operation.
|
|
4155
|
+
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows after the first one are ignored.
|
|
4156
|
+
* - This is an asynchronous operation. Calling this operation returns an asynchronous task object. To query the execution status of the task, call GetJobStatus.
|
|
3824
4157
|
*
|
|
3825
4158
|
* @param request - ImportWorkflowDefinitionRequest
|
|
3826
4159
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3828,17 +4161,52 @@ export default class Client extends OpenApi {
|
|
|
3828
4161
|
*/
|
|
3829
4162
|
importWorkflowDefinitionWithOptions(request: $_model.ImportWorkflowDefinitionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ImportWorkflowDefinitionResponse>;
|
|
3830
4163
|
/**
|
|
3831
|
-
* Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.
|
|
4164
|
+
* Imports a workflow node defined by FlowSpec and its internal child nodes into DataStudio.
|
|
3832
4165
|
*
|
|
3833
4166
|
* @remarks
|
|
3834
4167
|
* >Notice:
|
|
3835
|
-
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows
|
|
3836
|
-
* - This is an asynchronous operation.
|
|
4168
|
+
* - This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows after the first one are ignored.
|
|
4169
|
+
* - This is an asynchronous operation. Calling this operation returns an asynchronous task object. To query the execution status of the task, call GetJobStatus.
|
|
3837
4170
|
*
|
|
3838
4171
|
* @param request - ImportWorkflowDefinitionRequest
|
|
3839
4172
|
* @returns ImportWorkflowDefinitionResponse
|
|
3840
4173
|
*/
|
|
3841
4174
|
importWorkflowDefinition(request: $_model.ImportWorkflowDefinitionRequest): Promise<$_model.ImportWorkflowDefinitionResponse>;
|
|
4175
|
+
/**
|
|
4176
|
+
* Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call indicates only that the stop request has been accepted. Query the final status by calling GetSemanticJobDetail.
|
|
4177
|
+
*
|
|
4178
|
+
* @remarks
|
|
4179
|
+
* ## Scenarios
|
|
4180
|
+
* 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
|
+
* ## Procedure
|
|
4182
|
+
* 1. Obtain the `ExecutorJobId` from `RunSemanticJob` or `ListSemanticJobRuns`, and use the `ProjectId` of the job.
|
|
4183
|
+
* 2. Optionally specify `RetryTimes` as needed.
|
|
4184
|
+
* 3. After the call, poll the final status by using `GetSemanticJobDetail`. If necessary, call `GetSemanticJobLog` for diagnostics.
|
|
4185
|
+
* ## Before you begin
|
|
4186
|
+
* A successful response indicates only that the stop request has been processed. It does not mean the job has reached a desired state.
|
|
4187
|
+
*
|
|
4188
|
+
* @param request - KillSemanticJobRequest
|
|
4189
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
4190
|
+
* @returns KillSemanticJobResponse
|
|
4191
|
+
*/
|
|
4192
|
+
killSemanticJobWithOptions(request: $_model.KillSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.KillSemanticJobResponse>;
|
|
4193
|
+
/**
|
|
4194
|
+
* Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call indicates only that the stop request has been accepted. Query the final status by calling GetSemanticJobDetail.
|
|
4195
|
+
*
|
|
4196
|
+
* @remarks
|
|
4197
|
+
* ## Scenarios
|
|
4198
|
+
* 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
|
+
* ## Procedure
|
|
4200
|
+
* 1. Obtain the `ExecutorJobId` from `RunSemanticJob` or `ListSemanticJobRuns`, and use the `ProjectId` of the job.
|
|
4201
|
+
* 2. Optionally specify `RetryTimes` as needed.
|
|
4202
|
+
* 3. After the call, poll the final status by using `GetSemanticJobDetail`. If necessary, call `GetSemanticJobLog` for diagnostics.
|
|
4203
|
+
* ## Before you begin
|
|
4204
|
+
* A successful response indicates only that the stop request has been processed. It does not mean the job has reached a desired state.
|
|
4205
|
+
*
|
|
4206
|
+
* @param request - KillSemanticJobRequest
|
|
4207
|
+
* @returns KillSemanticJobResponse
|
|
4208
|
+
*/
|
|
4209
|
+
killSemanticJob(request: $_model.KillSemanticJobRequest): Promise<$_model.KillSemanticJobResponse>;
|
|
3842
4210
|
/**
|
|
3843
4211
|
* Retrieves a list of artifacts from a specified session.
|
|
3844
4212
|
*
|
|
@@ -3997,7 +4365,7 @@ export default class Client extends OpenApi {
|
|
|
3997
4365
|
*/
|
|
3998
4366
|
listCertificates(request: $_model.ListCertificatesRequest): Promise<$_model.ListCertificatesResponse>;
|
|
3999
4367
|
/**
|
|
4000
|
-
* Queries the column list of a specified
|
|
4368
|
+
* Queries the column list of a specified table in DataWorks Data Map.
|
|
4001
4369
|
*
|
|
4002
4370
|
* @remarks
|
|
4003
4371
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -4008,7 +4376,7 @@ export default class Client extends OpenApi {
|
|
|
4008
4376
|
*/
|
|
4009
4377
|
listColumnsWithOptions(request: $_model.ListColumnsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListColumnsResponse>;
|
|
4010
4378
|
/**
|
|
4011
|
-
* Queries the column list of a specified
|
|
4379
|
+
* Queries the column list of a specified table in DataWorks Data Map.
|
|
4012
4380
|
*
|
|
4013
4381
|
* @remarks
|
|
4014
4382
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -4063,6 +4431,45 @@ export default class Client extends OpenApi {
|
|
|
4063
4431
|
* @returns ListComputeResourcesResponse
|
|
4064
4432
|
*/
|
|
4065
4433
|
listComputeResources(request: $_model.ListComputeResourcesRequest): Promise<$_model.ListComputeResourcesResponse>;
|
|
4434
|
+
/**
|
|
4435
|
+
* 查询元数据采集器运行记录
|
|
4436
|
+
*
|
|
4437
|
+
* @remarks
|
|
4438
|
+
* ## 使用场景
|
|
4439
|
+
* 分页查询指定元数据采集器最近 30 天内的运行记录,并可按运行开始时间和状态筛选。
|
|
4440
|
+
* ## 推荐流程
|
|
4441
|
+
* 1. 使用 `ListCrawlers` 查询采集器 ID。
|
|
4442
|
+
* 2. 调用本接口查询运行记录和任务实例 ID。
|
|
4443
|
+
* 3. 对运行、停止等异步操作,以本接口返回的最终状态为准。
|
|
4444
|
+
* ## 版本要求
|
|
4445
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
4446
|
+
* ## 注意事项
|
|
4447
|
+
* 未指定时间范围时,默认查询当前时间向前 30 天。
|
|
4448
|
+
*
|
|
4449
|
+
* @param request - ListCrawlerRunsRequest
|
|
4450
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
4451
|
+
* @returns ListCrawlerRunsResponse
|
|
4452
|
+
*/
|
|
4453
|
+
listCrawlerRunsWithOptions(request: $_model.ListCrawlerRunsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCrawlerRunsResponse>;
|
|
4454
|
+
/**
|
|
4455
|
+
* 查询元数据采集器运行记录
|
|
4456
|
+
*
|
|
4457
|
+
* @remarks
|
|
4458
|
+
* ## 使用场景
|
|
4459
|
+
* 分页查询指定元数据采集器最近 30 天内的运行记录,并可按运行开始时间和状态筛选。
|
|
4460
|
+
* ## 推荐流程
|
|
4461
|
+
* 1. 使用 `ListCrawlers` 查询采集器 ID。
|
|
4462
|
+
* 2. 调用本接口查询运行记录和任务实例 ID。
|
|
4463
|
+
* 3. 对运行、停止等异步操作,以本接口返回的最终状态为准。
|
|
4464
|
+
* ## 版本要求
|
|
4465
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
4466
|
+
* ## 注意事项
|
|
4467
|
+
* 未指定时间范围时,默认查询当前时间向前 30 天。
|
|
4468
|
+
*
|
|
4469
|
+
* @param request - ListCrawlerRunsRequest
|
|
4470
|
+
* @returns ListCrawlerRunsResponse
|
|
4471
|
+
*/
|
|
4472
|
+
listCrawlerRuns(request: $_model.ListCrawlerRunsRequest): Promise<$_model.ListCrawlerRunsResponse>;
|
|
4066
4473
|
/**
|
|
4067
4474
|
* Queries a list of metadata crawler types supported in Data Map. The subtypes of the types and the hierarchical relationship between the subtypes are also returned.
|
|
4068
4475
|
*
|
|
@@ -4081,6 +4488,43 @@ export default class Client extends OpenApi {
|
|
|
4081
4488
|
* @returns ListCrawlerTypesResponse
|
|
4082
4489
|
*/
|
|
4083
4490
|
listCrawlerTypes(): Promise<$_model.ListCrawlerTypesResponse>;
|
|
4491
|
+
/**
|
|
4492
|
+
* 查询元数据采集器列表
|
|
4493
|
+
*
|
|
4494
|
+
* @remarks
|
|
4495
|
+
* ## 使用场景
|
|
4496
|
+
* 分页查询有权访问的元数据采集器,并可按工作空间、数据源、采集器类型、环境、负责人和名称筛选。
|
|
4497
|
+
* ## 推荐流程
|
|
4498
|
+
* 1. 按需组合筛选条件查询采集器列表。
|
|
4499
|
+
* 2. 使用返回的采集器 ID 调用详情、更新、运行、停止、运行记录或删除接口。
|
|
4500
|
+
* ## 版本要求
|
|
4501
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
4502
|
+
* ## 注意事项
|
|
4503
|
+
* 多个筛选条件同时提供时组合生效,名称支持模糊匹配。
|
|
4504
|
+
*
|
|
4505
|
+
* @param tmpReq - ListCrawlersRequest
|
|
4506
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
4507
|
+
* @returns ListCrawlersResponse
|
|
4508
|
+
*/
|
|
4509
|
+
listCrawlersWithOptions(tmpReq: $_model.ListCrawlersRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCrawlersResponse>;
|
|
4510
|
+
/**
|
|
4511
|
+
* 查询元数据采集器列表
|
|
4512
|
+
*
|
|
4513
|
+
* @remarks
|
|
4514
|
+
* ## 使用场景
|
|
4515
|
+
* 分页查询有权访问的元数据采集器,并可按工作空间、数据源、采集器类型、环境、负责人和名称筛选。
|
|
4516
|
+
* ## 推荐流程
|
|
4517
|
+
* 1. 按需组合筛选条件查询采集器列表。
|
|
4518
|
+
* 2. 使用返回的采集器 ID 调用详情、更新、运行、停止、运行记录或删除接口。
|
|
4519
|
+
* ## 版本要求
|
|
4520
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
4521
|
+
* ## 注意事项
|
|
4522
|
+
* 多个筛选条件同时提供时组合生效,名称支持模糊匹配。
|
|
4523
|
+
*
|
|
4524
|
+
* @param request - ListCrawlersRequest
|
|
4525
|
+
* @returns ListCrawlersResponse
|
|
4526
|
+
*/
|
|
4527
|
+
listCrawlers(request: $_model.ListCrawlersRequest): Promise<$_model.ListCrawlersResponse>;
|
|
4084
4528
|
/**
|
|
4085
4529
|
* Retrieves a paginated list of custom agents.
|
|
4086
4530
|
*
|
|
@@ -4109,7 +4553,7 @@ export default class Client extends OpenApi {
|
|
|
4109
4553
|
*/
|
|
4110
4554
|
listCustomAgents(request: $_model.ListCustomAgentsRequest): Promise<$_model.ListCustomAgentsResponse>;
|
|
4111
4555
|
/**
|
|
4112
|
-
*
|
|
4556
|
+
* Queries the list of custom attribute definitions.
|
|
4113
4557
|
*
|
|
4114
4558
|
* @param request - ListCustomAttributesRequest
|
|
4115
4559
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4117,7 +4561,7 @@ export default class Client extends OpenApi {
|
|
|
4117
4561
|
*/
|
|
4118
4562
|
listCustomAttributesWithOptions(request: $_model.ListCustomAttributesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAttributesResponse>;
|
|
4119
4563
|
/**
|
|
4120
|
-
*
|
|
4564
|
+
* Queries the list of custom attribute definitions.
|
|
4121
4565
|
*
|
|
4122
4566
|
* @param request - ListCustomAttributesRequest
|
|
4123
4567
|
* @returns ListCustomAttributesResponse
|
|
@@ -4453,10 +4897,10 @@ export default class Client extends OpenApi {
|
|
|
4453
4897
|
*/
|
|
4454
4898
|
listDataQualityScans(request: $_model.ListDataQualityScansRequest): Promise<$_model.ListDataQualityScansResponse>;
|
|
4455
4899
|
/**
|
|
4456
|
-
* Queries the list of data quality rule templates in a project.
|
|
4900
|
+
* Queries the list of data quality rule templates in a specified project.
|
|
4457
4901
|
*
|
|
4458
4902
|
* @remarks
|
|
4459
|
-
* DataWorks Basic Edition or a higher edition
|
|
4903
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
4460
4904
|
*
|
|
4461
4905
|
* @param request - ListDataQualityTemplatesRequest
|
|
4462
4906
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4464,10 +4908,10 @@ export default class Client extends OpenApi {
|
|
|
4464
4908
|
*/
|
|
4465
4909
|
listDataQualityTemplatesWithOptions(request: $_model.ListDataQualityTemplatesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListDataQualityTemplatesResponse>;
|
|
4466
4910
|
/**
|
|
4467
|
-
* Queries the list of data quality rule templates in a project.
|
|
4911
|
+
* Queries the list of data quality rule templates in a specified project.
|
|
4468
4912
|
*
|
|
4469
4913
|
* @remarks
|
|
4470
|
-
* DataWorks Basic Edition or a higher edition
|
|
4914
|
+
* You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
4471
4915
|
*
|
|
4472
4916
|
* @param request - ListDataQualityTemplatesRequest
|
|
4473
4917
|
* @returns ListDataQualityTemplatesResponse
|
|
@@ -4793,10 +5237,10 @@ export default class Client extends OpenApi {
|
|
|
4793
5237
|
*/
|
|
4794
5238
|
listImages(request: $_model.ListImagesRequest): Promise<$_model.ListImagesResponse>;
|
|
4795
5239
|
/**
|
|
4796
|
-
* Queries the
|
|
5240
|
+
* Queries the list of data lineage relationships between two specified entities (tables, fields, OSS files, etc.) in DataWorks Data Map.
|
|
4797
5241
|
*
|
|
4798
5242
|
* @remarks
|
|
4799
|
-
* 1.
|
|
5243
|
+
* 1. You must purchase DataWorks Standard Edition or a higher edition to use this feature.
|
|
4800
5244
|
*
|
|
4801
5245
|
* @param request - ListLineageRelationshipsRequest
|
|
4802
5246
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4804,10 +5248,10 @@ export default class Client extends OpenApi {
|
|
|
4804
5248
|
*/
|
|
4805
5249
|
listLineageRelationshipsWithOptions(request: $_model.ListLineageRelationshipsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListLineageRelationshipsResponse>;
|
|
4806
5250
|
/**
|
|
4807
|
-
* Queries the
|
|
5251
|
+
* Queries the list of data lineage relationships between two specified entities (tables, fields, OSS files, etc.) in DataWorks Data Map.
|
|
4808
5252
|
*
|
|
4809
5253
|
* @remarks
|
|
4810
|
-
* 1.
|
|
5254
|
+
* 1. You must purchase DataWorks Standard Edition or a higher edition to use this feature.
|
|
4811
5255
|
*
|
|
4812
5256
|
* @param request - ListLineageRelationshipsRequest
|
|
4813
5257
|
* @returns ListLineageRelationshipsResponse
|
|
@@ -4868,10 +5312,10 @@ export default class Client extends OpenApi {
|
|
|
4868
5312
|
*/
|
|
4869
5313
|
listMcpServers(request: $_model.ListMcpServersRequest): Promise<$_model.ListMcpServersResponse>;
|
|
4870
5314
|
/**
|
|
4871
|
-
* Queries
|
|
5315
|
+
* Queries the list of Data Map collections. Supports querying both Data Map categories and data albums.
|
|
4872
5316
|
*
|
|
4873
5317
|
* @remarks
|
|
4874
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
5318
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
4875
5319
|
*
|
|
4876
5320
|
* @param request - ListMetaCollectionsRequest
|
|
4877
5321
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4879,17 +5323,17 @@ export default class Client extends OpenApi {
|
|
|
4879
5323
|
*/
|
|
4880
5324
|
listMetaCollectionsWithOptions(request: $_model.ListMetaCollectionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaCollectionsResponse>;
|
|
4881
5325
|
/**
|
|
4882
|
-
* Queries
|
|
5326
|
+
* Queries the list of Data Map collections. Supports querying both Data Map categories and data albums.
|
|
4883
5327
|
*
|
|
4884
5328
|
* @remarks
|
|
4885
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
5329
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
4886
5330
|
*
|
|
4887
5331
|
* @param request - ListMetaCollectionsRequest
|
|
4888
5332
|
* @returns ListMetaCollectionsResponse
|
|
4889
5333
|
*/
|
|
4890
5334
|
listMetaCollections(request: $_model.ListMetaCollectionsRequest): Promise<$_model.ListMetaCollectionsResponse>;
|
|
4891
5335
|
/**
|
|
4892
|
-
*
|
|
5336
|
+
* Queries a list of metadata entities. Currently, only custom entity types are supported.
|
|
4893
5337
|
*
|
|
4894
5338
|
* @param tmpReq - ListMetaEntitiesRequest
|
|
4895
5339
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4897,14 +5341,14 @@ export default class Client extends OpenApi {
|
|
|
4897
5341
|
*/
|
|
4898
5342
|
listMetaEntitiesWithOptions(tmpReq: $_model.ListMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaEntitiesResponse>;
|
|
4899
5343
|
/**
|
|
4900
|
-
*
|
|
5344
|
+
* Queries a list of metadata entities. Currently, only custom entity types are supported.
|
|
4901
5345
|
*
|
|
4902
5346
|
* @param request - ListMetaEntitiesRequest
|
|
4903
5347
|
* @returns ListMetaEntitiesResponse
|
|
4904
5348
|
*/
|
|
4905
5349
|
listMetaEntities(request: $_model.ListMetaEntitiesRequest): Promise<$_model.ListMetaEntitiesResponse>;
|
|
4906
5350
|
/**
|
|
4907
|
-
*
|
|
5351
|
+
* Queries the list of custom entity definitions, including custom entity types and extension table types.
|
|
4908
5352
|
*
|
|
4909
5353
|
* @param request - ListMetaEntityDefsRequest
|
|
4910
5354
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4912,7 +5356,7 @@ export default class Client extends OpenApi {
|
|
|
4912
5356
|
*/
|
|
4913
5357
|
listMetaEntityDefsWithOptions(request: $_model.ListMetaEntityDefsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaEntityDefsResponse>;
|
|
4914
5358
|
/**
|
|
4915
|
-
*
|
|
5359
|
+
* Queries the list of custom entity definitions, including custom entity types and extension table types.
|
|
4916
5360
|
*
|
|
4917
5361
|
* @param request - ListMetaEntityDefsRequest
|
|
4918
5362
|
* @returns ListMetaEntityDefsResponse
|
|
@@ -5076,11 +5520,12 @@ export default class Client extends OpenApi {
|
|
|
5076
5520
|
*/
|
|
5077
5521
|
listParameters(request: $_model.ListParametersRequest): Promise<$_model.ListParametersResponse>;
|
|
5078
5522
|
/**
|
|
5079
|
-
* Queries
|
|
5523
|
+
* Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS (EMR cluster) types.
|
|
5080
5524
|
*
|
|
5081
5525
|
* @remarks
|
|
5082
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
5083
|
-
* 2. Only
|
|
5526
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
5527
|
+
* 2. Only MaxCompute and HMS (EMR cluster) table types are supported.
|
|
5528
|
+
* 3. Before calling this API, call ListCrawlers to obtain the MetaEntityId of the metadata crawler, then call ListDatabases to obtain the database ID. For MaxCompute projects with Schema enabled, call ListSchemas to obtain the schema ID. Then call ListTables to obtain the TableId, and pass the returned table ID to this API.
|
|
5084
5529
|
*
|
|
5085
5530
|
* @param request - ListPartitionsRequest
|
|
5086
5531
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5088,11 +5533,12 @@ export default class Client extends OpenApi {
|
|
|
5088
5533
|
*/
|
|
5089
5534
|
listPartitionsWithOptions(request: $_model.ListPartitionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListPartitionsResponse>;
|
|
5090
5535
|
/**
|
|
5091
|
-
* Queries
|
|
5536
|
+
* Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS (EMR cluster) types.
|
|
5092
5537
|
*
|
|
5093
5538
|
* @remarks
|
|
5094
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
5095
|
-
* 2. Only
|
|
5539
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
5540
|
+
* 2. Only MaxCompute and HMS (EMR cluster) table types are supported.
|
|
5541
|
+
* 3. Before calling this API, call ListCrawlers to obtain the MetaEntityId of the metadata crawler, then call ListDatabases to obtain the database ID. For MaxCompute projects with Schema enabled, call ListSchemas to obtain the schema ID. Then call ListTables to obtain the TableId, and pass the returned table ID to this API.
|
|
5096
5542
|
*
|
|
5097
5543
|
* @param request - ListPartitionsRequest
|
|
5098
5544
|
* @returns ListPartitionsResponse
|
|
@@ -5438,6 +5884,76 @@ export default class Client extends OpenApi {
|
|
|
5438
5884
|
* @returns ListSecurityStrategiesResponse
|
|
5439
5885
|
*/
|
|
5440
5886
|
listSecurityStrategies(request: $_model.ListSecurityStrategiesRequest): Promise<$_model.ListSecurityStrategiesResponse>;
|
|
5887
|
+
/**
|
|
5888
|
+
* Queries the run records of a created node by Name with paging. The JobRunId in each record is active for retrieving the results of a specific run, and the ExecutorJobId is active for querying details, retrieving logs, or stopping the run.
|
|
5889
|
+
*
|
|
5890
|
+
* @remarks
|
|
5891
|
+
* ## Scenarios
|
|
5892
|
+
* View the historical run records of a semantic job with pagination to obtain the run ID, executor job ID, status, and time information for each submission.
|
|
5893
|
+
* ## Procedure
|
|
5894
|
+
* 1. Use the job name from `CreateSemanticJob.Data.Name` or `ListSemanticJobs` as the `JobName`.
|
|
5895
|
+
* 2. Use `PageNumber` and `PageSize` to read records page by page.
|
|
5896
|
+
* 3. Use the `JobRunId` from a record to call `DownloadSemanticResults`, and use the `ExecutorJobId` to call the detail, log, or stop operations.
|
|
5897
|
+
* ## Before you begin
|
|
5898
|
+
* Pagination starts from page 1 by default. Each page contains a maximum of 200 records.
|
|
5899
|
+
*
|
|
5900
|
+
* @param request - ListSemanticJobRunsRequest
|
|
5901
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5902
|
+
* @returns ListSemanticJobRunsResponse
|
|
5903
|
+
*/
|
|
5904
|
+
listSemanticJobRunsWithOptions(request: $_model.ListSemanticJobRunsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
5905
|
+
/**
|
|
5906
|
+
* Queries the run records of a created node by Name with paging. The JobRunId in each record is active for retrieving the results of a specific run, and the ExecutorJobId is active for querying details, retrieving logs, or stopping the run.
|
|
5907
|
+
*
|
|
5908
|
+
* @remarks
|
|
5909
|
+
* ## Scenarios
|
|
5910
|
+
* View the historical run records of a semantic job with pagination to obtain the run ID, executor job ID, status, and time information for each submission.
|
|
5911
|
+
* ## Procedure
|
|
5912
|
+
* 1. Use the job name from `CreateSemanticJob.Data.Name` or `ListSemanticJobs` as the `JobName`.
|
|
5913
|
+
* 2. Use `PageNumber` and `PageSize` to read records page by page.
|
|
5914
|
+
* 3. Use the `JobRunId` from a record to call `DownloadSemanticResults`, and use the `ExecutorJobId` to call the detail, log, or stop operations.
|
|
5915
|
+
* ## Before you begin
|
|
5916
|
+
* Pagination starts from page 1 by default. Each page contains a maximum of 200 records.
|
|
5917
|
+
*
|
|
5918
|
+
* @param request - ListSemanticJobRunsRequest
|
|
5919
|
+
* @returns ListSemanticJobRunsResponse
|
|
5920
|
+
*/
|
|
5921
|
+
listSemanticJobRuns(request: $_model.ListSemanticJobRunsRequest): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
5922
|
+
/**
|
|
5923
|
+
* Queries the semantic node definitions of the current tenant with paging. The Name, ProjectId, and Source fields in the list items can be used for running/deleting nodes, querying run details, and verifying input scope, respectively.
|
|
5924
|
+
*
|
|
5925
|
+
* @remarks
|
|
5926
|
+
* ## Scenarios
|
|
5927
|
+
* Queries the saved semantic node definitions of the current tenant with paging. Use this operation to display the node list, select a node to run, or obtain the workspace to which a node belongs.
|
|
5928
|
+
* ## Invoke flow
|
|
5929
|
+
* 1. Use `PageNumber` and `PageSize` to read `Data.SemanticJobs` with paging.
|
|
5930
|
+
* 2. Use the `Name` field of a list item to invoke `RunSemanticJob`, `DeleteSemanticJob`, or `ListSemanticJobRuns`.
|
|
5931
|
+
* 3. Use the `ProjectId` field of a list item together with `ExecutorJobId` to invoke the details, log, and stop operations.
|
|
5932
|
+
* ## Notes
|
|
5933
|
+
* This operation returns node definitions, not real-time run statuses. To query run statuses, invoke `ListSemanticJobRuns`.
|
|
5934
|
+
*
|
|
5935
|
+
* @param request - ListSemanticJobsRequest
|
|
5936
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
5937
|
+
* @returns ListSemanticJobsResponse
|
|
5938
|
+
*/
|
|
5939
|
+
listSemanticJobsWithOptions(request: $_model.ListSemanticJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobsResponse>;
|
|
5940
|
+
/**
|
|
5941
|
+
* Queries the semantic node definitions of the current tenant with paging. The Name, ProjectId, and Source fields in the list items can be used for running/deleting nodes, querying run details, and verifying input scope, respectively.
|
|
5942
|
+
*
|
|
5943
|
+
* @remarks
|
|
5944
|
+
* ## Scenarios
|
|
5945
|
+
* Queries the saved semantic node definitions of the current tenant with paging. Use this operation to display the node list, select a node to run, or obtain the workspace to which a node belongs.
|
|
5946
|
+
* ## Invoke flow
|
|
5947
|
+
* 1. Use `PageNumber` and `PageSize` to read `Data.SemanticJobs` with paging.
|
|
5948
|
+
* 2. Use the `Name` field of a list item to invoke `RunSemanticJob`, `DeleteSemanticJob`, or `ListSemanticJobRuns`.
|
|
5949
|
+
* 3. Use the `ProjectId` field of a list item together with `ExecutorJobId` to invoke the details, log, and stop operations.
|
|
5950
|
+
* ## Notes
|
|
5951
|
+
* This operation returns node definitions, not real-time run statuses. To query run statuses, invoke `ListSemanticJobRuns`.
|
|
5952
|
+
*
|
|
5953
|
+
* @param request - ListSemanticJobsRequest
|
|
5954
|
+
* @returns ListSemanticJobsResponse
|
|
5955
|
+
*/
|
|
5956
|
+
listSemanticJobs(request: $_model.ListSemanticJobsRequest): Promise<$_model.ListSemanticJobsResponse>;
|
|
5441
5957
|
/**
|
|
5442
5958
|
* Lists the Skills in your account.
|
|
5443
5959
|
*
|
|
@@ -5473,7 +5989,7 @@ export default class Client extends OpenApi {
|
|
|
5473
5989
|
* 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.
|
|
5474
5990
|
*
|
|
5475
5991
|
* @remarks
|
|
5476
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
5992
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
5477
5993
|
*
|
|
5478
5994
|
* @param tmpReq - ListTablesRequest
|
|
5479
5995
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5484,7 +6000,7 @@ export default class Client extends OpenApi {
|
|
|
5484
6000
|
* 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.
|
|
5485
6001
|
*
|
|
5486
6002
|
* @remarks
|
|
5487
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
6003
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
5488
6004
|
*
|
|
5489
6005
|
* @param request - ListTablesRequest
|
|
5490
6006
|
* @returns ListTablesResponse
|
|
@@ -5794,18 +6310,18 @@ export default class Client extends OpenApi {
|
|
|
5794
6310
|
*/
|
|
5795
6311
|
previewDatasetVersion(request: $_model.PreviewDatasetVersionRequest): Promise<$_model.PreviewDatasetVersionResponse>;
|
|
5796
6312
|
/**
|
|
5797
|
-
* Sends a prompt to an existing session and
|
|
6313
|
+
* Sends a user prompt to an existing session and returns the Agent response in streaming mode.
|
|
5798
6314
|
*
|
|
5799
6315
|
* @remarks
|
|
5800
|
-
* ##
|
|
5801
|
-
* - This API sends a user prompt to a specified session ID and
|
|
5802
|
-
* - The response may include message
|
|
5803
|
-
* - If the specified session does not exist,
|
|
5804
|
-
* - The `stopReason` field indicates why the
|
|
5805
|
-
* -
|
|
5806
|
-
* - You can provide additional
|
|
5807
|
-
* - The
|
|
5808
|
-
* -
|
|
6316
|
+
* ## Operation description
|
|
6317
|
+
* - This API sends a user prompt to a specified session ID and accepts the Agent response in SSE (Server-Sent Events) streaming mode.
|
|
6318
|
+
* - The response may include message fragments, thinking procedures, tool calling status updates, and other information.
|
|
6319
|
+
* - If the specified session does not exist, a 400 fault is returned through an SSE error frame.
|
|
6320
|
+
* - The `stopReason` field indicates why the Agent stopped the current conversation turn.
|
|
6321
|
+
* - Multiple types of content blocks are supported as prompt input, such as text and OSS file download links.
|
|
6322
|
+
* - You can optionally provide additional meta information `Meta` to pass more context to the server.
|
|
6323
|
+
* - The returned content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, visit: https://agentclientprotocol.com
|
|
6324
|
+
* - **Before invoking this API, make sure you fully understand the billing methods and pricing of the Data Agent product**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
5809
6325
|
*
|
|
5810
6326
|
* @param tmpReq - PromptAgentSessionRequest
|
|
5811
6327
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5813,18 +6329,18 @@ export default class Client extends OpenApi {
|
|
|
5813
6329
|
*/
|
|
5814
6330
|
promptAgentSessionWithSSE(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): AsyncGenerator<$_model.PromptAgentSessionResponse, any, unknown>;
|
|
5815
6331
|
/**
|
|
5816
|
-
* Sends a prompt to an existing session and
|
|
6332
|
+
* Sends a user prompt to an existing session and returns the Agent response in streaming mode.
|
|
5817
6333
|
*
|
|
5818
6334
|
* @remarks
|
|
5819
|
-
* ##
|
|
5820
|
-
* - This API sends a user prompt to a specified session ID and
|
|
5821
|
-
* - The response may include message
|
|
5822
|
-
* - If the specified session does not exist,
|
|
5823
|
-
* - The `stopReason` field indicates why the
|
|
5824
|
-
* -
|
|
5825
|
-
* - You can provide additional
|
|
5826
|
-
* - The
|
|
5827
|
-
* -
|
|
6335
|
+
* ## Operation description
|
|
6336
|
+
* - This API sends a user prompt to a specified session ID and accepts the Agent response in SSE (Server-Sent Events) streaming mode.
|
|
6337
|
+
* - The response may include message fragments, thinking procedures, tool calling status updates, and other information.
|
|
6338
|
+
* - If the specified session does not exist, a 400 fault is returned through an SSE error frame.
|
|
6339
|
+
* - The `stopReason` field indicates why the Agent stopped the current conversation turn.
|
|
6340
|
+
* - Multiple types of content blocks are supported as prompt input, such as text and OSS file download links.
|
|
6341
|
+
* - You can optionally provide additional meta information `Meta` to pass more context to the server.
|
|
6342
|
+
* - The returned content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, visit: https://agentclientprotocol.com
|
|
6343
|
+
* - **Before invoking this API, make sure you fully understand the billing methods and pricing of the Data Agent product**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
5828
6344
|
*
|
|
5829
6345
|
* @param tmpReq - PromptAgentSessionRequest
|
|
5830
6346
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5832,18 +6348,18 @@ export default class Client extends OpenApi {
|
|
|
5832
6348
|
*/
|
|
5833
6349
|
promptAgentSessionWithOptions(tmpReq: $_model.PromptAgentSessionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PromptAgentSessionResponse>;
|
|
5834
6350
|
/**
|
|
5835
|
-
* Sends a prompt to an existing session and
|
|
6351
|
+
* Sends a user prompt to an existing session and returns the Agent response in streaming mode.
|
|
5836
6352
|
*
|
|
5837
6353
|
* @remarks
|
|
5838
|
-
* ##
|
|
5839
|
-
* - This API sends a user prompt to a specified session ID and
|
|
5840
|
-
* - The response may include message
|
|
5841
|
-
* - If the specified session does not exist,
|
|
5842
|
-
* - The `stopReason` field indicates why the
|
|
5843
|
-
* -
|
|
5844
|
-
* - You can provide additional
|
|
5845
|
-
* - The
|
|
5846
|
-
* -
|
|
6354
|
+
* ## Operation description
|
|
6355
|
+
* - This API sends a user prompt to a specified session ID and accepts the Agent response in SSE (Server-Sent Events) streaming mode.
|
|
6356
|
+
* - The response may include message fragments, thinking procedures, tool calling status updates, and other information.
|
|
6357
|
+
* - If the specified session does not exist, a 400 fault is returned through an SSE error frame.
|
|
6358
|
+
* - The `stopReason` field indicates why the Agent stopped the current conversation turn.
|
|
6359
|
+
* - Multiple types of content blocks are supported as prompt input, such as text and OSS file download links.
|
|
6360
|
+
* - You can optionally provide additional meta information `Meta` to pass more context to the server.
|
|
6361
|
+
* - The returned content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, visit: https://agentclientprotocol.com
|
|
6362
|
+
* - **Before invoking this API, make sure you fully understand the billing methods and pricing of the Data Agent product**: https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing
|
|
5847
6363
|
*
|
|
5848
6364
|
* @param request - PromptAgentSessionRequest
|
|
5849
6365
|
* @returns PromptAgentSessionResponse
|
|
@@ -6052,6 +6568,86 @@ export default class Client extends OpenApi {
|
|
|
6052
6568
|
* @returns RollbackParameterResponse
|
|
6053
6569
|
*/
|
|
6054
6570
|
rollbackParameter(request: $_model.RollbackParameterRequest): Promise<$_model.RollbackParameterResponse>;
|
|
6571
|
+
/**
|
|
6572
|
+
* 运行元数据采集器
|
|
6573
|
+
*
|
|
6574
|
+
* @remarks
|
|
6575
|
+
* ## 使用场景
|
|
6576
|
+
* 提交指定元数据采集器的运行请求。
|
|
6577
|
+
* ## 推荐流程
|
|
6578
|
+
* 1. 调用 `ListCrawlers` 查询可运行的采集器 ID。
|
|
6579
|
+
* 2. 调用本接口提交运行请求。
|
|
6580
|
+
* 3. 调用 `ListCrawlerRuns` 查询最终运行状态。
|
|
6581
|
+
* ## 版本要求
|
|
6582
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
6583
|
+
* ## 费用说明
|
|
6584
|
+
* 运行采集任务会使用计算资源,可能产生费用,具体以实际使用的资源组和 DataWorks 计费规则为准。
|
|
6585
|
+
* 当采集器已开启 AI 元数据描述能力(`EnableAiComment=true`)时,采集元数据并生成 AI 说明会消耗 Token。Token 赠送额度及超出额度后的计费规则,请参见 [Data Agent 费用](https://help.aliyun.com/zh/dataworks/dataworks-data-agent-agent-billing)。
|
|
6586
|
+
* ## 注意事项
|
|
6587
|
+
* 接口成功仅表示运行请求已受理,不表示采集任务已经完成。
|
|
6588
|
+
*
|
|
6589
|
+
* @param request - RunCrawlerRequest
|
|
6590
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6591
|
+
* @returns RunCrawlerResponse
|
|
6592
|
+
*/
|
|
6593
|
+
runCrawlerWithOptions(request: $_model.RunCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RunCrawlerResponse>;
|
|
6594
|
+
/**
|
|
6595
|
+
* 运行元数据采集器
|
|
6596
|
+
*
|
|
6597
|
+
* @remarks
|
|
6598
|
+
* ## 使用场景
|
|
6599
|
+
* 提交指定元数据采集器的运行请求。
|
|
6600
|
+
* ## 推荐流程
|
|
6601
|
+
* 1. 调用 `ListCrawlers` 查询可运行的采集器 ID。
|
|
6602
|
+
* 2. 调用本接口提交运行请求。
|
|
6603
|
+
* 3. 调用 `ListCrawlerRuns` 查询最终运行状态。
|
|
6604
|
+
* ## 版本要求
|
|
6605
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
6606
|
+
* ## 费用说明
|
|
6607
|
+
* 运行采集任务会使用计算资源,可能产生费用,具体以实际使用的资源组和 DataWorks 计费规则为准。
|
|
6608
|
+
* 当采集器已开启 AI 元数据描述能力(`EnableAiComment=true`)时,采集元数据并生成 AI 说明会消耗 Token。Token 赠送额度及超出额度后的计费规则,请参见 [Data Agent 费用](https://help.aliyun.com/zh/dataworks/dataworks-data-agent-agent-billing)。
|
|
6609
|
+
* ## 注意事项
|
|
6610
|
+
* 接口成功仅表示运行请求已受理,不表示采集任务已经完成。
|
|
6611
|
+
*
|
|
6612
|
+
* @param request - RunCrawlerRequest
|
|
6613
|
+
* @returns RunCrawlerResponse
|
|
6614
|
+
*/
|
|
6615
|
+
runCrawler(request: $_model.RunCrawlerRequest): Promise<$_model.RunCrawlerResponse>;
|
|
6616
|
+
/**
|
|
6617
|
+
* Submits a saved semantic job for execution by name and returns the run identifier and executor job identifier. A successful call indicates that the job has been submitted, not that the semantic model results have been generated.
|
|
6618
|
+
*
|
|
6619
|
+
* @remarks
|
|
6620
|
+
* ## Description
|
|
6621
|
+
* Loads a saved semantic job definition by `Name` and submits a new analysis run to the executor. This operation does not accept runtime `Source`, resource group, or reference file overrides. The execution always uses the configuration saved by `CreateSemanticJob`.
|
|
6622
|
+
* ## Pre-execution validation
|
|
6623
|
+
* The service validates the existence and access permissions of the job, and re-validates whether the associated files still exist. For files associated through `ReferenceFileIds`, the service resolves them to temporary addresses readable by the current run before submission. Deleting a file after upload or specifying an invalid file ID causes the submission to fail.
|
|
6624
|
+
* ## Response and What to do next
|
|
6625
|
+
* `Data.JobRunId` is the identity of the current semantics node run and is used by `DownloadSemanticResults` to download the exact output of this run. `Data.ExecutorJobId` is the identity of the executor node and is used by `GetSemanticJobDetail`, `GetSemanticJobLog`, and `KillSemanticJob`. A successful response indicates that the executor has accepted the submission, not that the model analysis or result files are complete.
|
|
6626
|
+
* ## Billing
|
|
6627
|
+
* **Before using this operation, make sure that you fully understand the billing method and pricing of the [model calls](https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing) used by semantic construction.**
|
|
6628
|
+
*
|
|
6629
|
+
* @param request - RunSemanticJobRequest
|
|
6630
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6631
|
+
* @returns RunSemanticJobResponse
|
|
6632
|
+
*/
|
|
6633
|
+
runSemanticJobWithOptions(request: $_model.RunSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RunSemanticJobResponse>;
|
|
6634
|
+
/**
|
|
6635
|
+
* Submits a saved semantic job for execution by name and returns the run identifier and executor job identifier. A successful call indicates that the job has been submitted, not that the semantic model results have been generated.
|
|
6636
|
+
*
|
|
6637
|
+
* @remarks
|
|
6638
|
+
* ## Description
|
|
6639
|
+
* Loads a saved semantic job definition by `Name` and submits a new analysis run to the executor. This operation does not accept runtime `Source`, resource group, or reference file overrides. The execution always uses the configuration saved by `CreateSemanticJob`.
|
|
6640
|
+
* ## Pre-execution validation
|
|
6641
|
+
* The service validates the existence and access permissions of the job, and re-validates whether the associated files still exist. For files associated through `ReferenceFileIds`, the service resolves them to temporary addresses readable by the current run before submission. Deleting a file after upload or specifying an invalid file ID causes the submission to fail.
|
|
6642
|
+
* ## Response and What to do next
|
|
6643
|
+
* `Data.JobRunId` is the identity of the current semantics node run and is used by `DownloadSemanticResults` to download the exact output of this run. `Data.ExecutorJobId` is the identity of the executor node and is used by `GetSemanticJobDetail`, `GetSemanticJobLog`, and `KillSemanticJob`. A successful response indicates that the executor has accepted the submission, not that the model analysis or result files are complete.
|
|
6644
|
+
* ## Billing
|
|
6645
|
+
* **Before using this operation, make sure that you fully understand the billing method and pricing of the [model calls](https://www.alibabacloud.com/help/en/dataworks/dataworks-data-agent-agent-billing) used by semantic construction.**
|
|
6646
|
+
*
|
|
6647
|
+
* @param request - RunSemanticJobRequest
|
|
6648
|
+
* @returns RunSemanticJobResponse
|
|
6649
|
+
*/
|
|
6650
|
+
runSemanticJob(request: $_model.RunSemanticJobRequest): Promise<$_model.RunSemanticJobResponse>;
|
|
6055
6651
|
/**
|
|
6056
6652
|
* Sets the statuses of multiple instances to successful at a time.
|
|
6057
6653
|
*
|
|
@@ -6115,6 +6711,45 @@ export default class Client extends OpenApi {
|
|
|
6115
6711
|
* @returns StartWorkflowInstancesResponse
|
|
6116
6712
|
*/
|
|
6117
6713
|
startWorkflowInstances(request: $_model.StartWorkflowInstancesRequest): Promise<$_model.StartWorkflowInstancesResponse>;
|
|
6714
|
+
/**
|
|
6715
|
+
* 停止元数据采集器运行
|
|
6716
|
+
*
|
|
6717
|
+
* @remarks
|
|
6718
|
+
* ## 使用场景
|
|
6719
|
+
* 停止指定元数据采集器当前正在执行的运行任务。
|
|
6720
|
+
* ## 推荐流程
|
|
6721
|
+
* 1. 调用 `ListCrawlerRuns` 确认采集器存在正在执行的运行任务。
|
|
6722
|
+
* 2. 调用本接口提交停止请求。
|
|
6723
|
+
* 3. 再次调用 `ListCrawlerRuns` 确认最终运行状态。
|
|
6724
|
+
* ## 版本要求
|
|
6725
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
6726
|
+
* ## 注意事项
|
|
6727
|
+
* 没有正在执行的运行任务时调用会失败。接口成功仅表示停止请求已受理。
|
|
6728
|
+
*
|
|
6729
|
+
* @param request - StopCrawlerRequest
|
|
6730
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
6731
|
+
* @returns StopCrawlerResponse
|
|
6732
|
+
*/
|
|
6733
|
+
stopCrawlerWithOptions(request: $_model.StopCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.StopCrawlerResponse>;
|
|
6734
|
+
/**
|
|
6735
|
+
* 停止元数据采集器运行
|
|
6736
|
+
*
|
|
6737
|
+
* @remarks
|
|
6738
|
+
* ## 使用场景
|
|
6739
|
+
* 停止指定元数据采集器当前正在执行的运行任务。
|
|
6740
|
+
* ## 推荐流程
|
|
6741
|
+
* 1. 调用 `ListCrawlerRuns` 确认采集器存在正在执行的运行任务。
|
|
6742
|
+
* 2. 调用本接口提交停止请求。
|
|
6743
|
+
* 3. 再次调用 `ListCrawlerRuns` 确认最终运行状态。
|
|
6744
|
+
* ## 版本要求
|
|
6745
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
6746
|
+
* ## 注意事项
|
|
6747
|
+
* 没有正在执行的运行任务时调用会失败。接口成功仅表示停止请求已受理。
|
|
6748
|
+
*
|
|
6749
|
+
* @param request - StopCrawlerRequest
|
|
6750
|
+
* @returns StopCrawlerResponse
|
|
6751
|
+
*/
|
|
6752
|
+
stopCrawler(request: $_model.StopCrawlerRequest): Promise<$_model.StopCrawlerResponse>;
|
|
6118
6753
|
/**
|
|
6119
6754
|
* Stops a synchronization task.
|
|
6120
6755
|
*
|
|
@@ -6428,6 +7063,45 @@ export default class Client extends OpenApi {
|
|
|
6428
7063
|
* @returns UpdateComputeResourceResponse
|
|
6429
7064
|
*/
|
|
6430
7065
|
updateComputeResource(request: $_model.UpdateComputeResourceRequest): Promise<$_model.UpdateComputeResourceResponse>;
|
|
7066
|
+
/**
|
|
7067
|
+
* 更新元数据采集器
|
|
7068
|
+
*
|
|
7069
|
+
* @remarks
|
|
7070
|
+
* ## 使用场景
|
|
7071
|
+
* 部分更新指定元数据采集器的资源组、采集范围、调度、AI 元数据描述或扩展配置。
|
|
7072
|
+
* ## 推荐流程
|
|
7073
|
+
* 1. 调用 `GetCrawler` 查询当前配置。
|
|
7074
|
+
* 2. 调用 `GetCrawlerTypeCapabilities` 确认该采集器类型支持的配置能力。
|
|
7075
|
+
* 3. 仅传入需要更新的字段调用本接口。
|
|
7076
|
+
* ## 版本要求
|
|
7077
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
7078
|
+
* ## 注意事项
|
|
7079
|
+
* 至少需要提供一个可更新字段;未提供的字段保持不变。
|
|
7080
|
+
*
|
|
7081
|
+
* @param tmpReq - UpdateCrawlerRequest
|
|
7082
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7083
|
+
* @returns UpdateCrawlerResponse
|
|
7084
|
+
*/
|
|
7085
|
+
updateCrawlerWithOptions(tmpReq: $_model.UpdateCrawlerRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateCrawlerResponse>;
|
|
7086
|
+
/**
|
|
7087
|
+
* 更新元数据采集器
|
|
7088
|
+
*
|
|
7089
|
+
* @remarks
|
|
7090
|
+
* ## 使用场景
|
|
7091
|
+
* 部分更新指定元数据采集器的资源组、采集范围、调度、AI 元数据描述或扩展配置。
|
|
7092
|
+
* ## 推荐流程
|
|
7093
|
+
* 1. 调用 `GetCrawler` 查询当前配置。
|
|
7094
|
+
* 2. 调用 `GetCrawlerTypeCapabilities` 确认该采集器类型支持的配置能力。
|
|
7095
|
+
* 3. 仅传入需要更新的字段调用本接口。
|
|
7096
|
+
* ## 版本要求
|
|
7097
|
+
* 需要购买DataWorks基础版及以上版本才能使用。
|
|
7098
|
+
* ## 注意事项
|
|
7099
|
+
* 至少需要提供一个可更新字段;未提供的字段保持不变。
|
|
7100
|
+
*
|
|
7101
|
+
* @param request - UpdateCrawlerRequest
|
|
7102
|
+
* @returns UpdateCrawlerResponse
|
|
7103
|
+
*/
|
|
7104
|
+
updateCrawler(request: $_model.UpdateCrawlerRequest): Promise<$_model.UpdateCrawlerResponse>;
|
|
6431
7105
|
/**
|
|
6432
7106
|
* Updates a custom attribute.
|
|
6433
7107
|
*
|
|
@@ -6813,10 +7487,10 @@ export default class Client extends OpenApi {
|
|
|
6813
7487
|
*/
|
|
6814
7488
|
updateMetaEntity(request: $_model.UpdateMetaEntityRequest): Promise<$_model.UpdateMetaEntityResponse>;
|
|
6815
7489
|
/**
|
|
6816
|
-
* Updates a
|
|
7490
|
+
* Updates a metadata entity definition, including custom entity types and extension table types.
|
|
6817
7491
|
*
|
|
6818
7492
|
* @remarks
|
|
6819
|
-
*
|
|
7493
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
6820
7494
|
*
|
|
6821
7495
|
* @param tmpReq - UpdateMetaEntityDefRequest
|
|
6822
7496
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6824,10 +7498,10 @@ export default class Client extends OpenApi {
|
|
|
6824
7498
|
*/
|
|
6825
7499
|
updateMetaEntityDefWithOptions(tmpReq: $_model.UpdateMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMetaEntityDefResponse>;
|
|
6826
7500
|
/**
|
|
6827
|
-
* Updates a
|
|
7501
|
+
* Updates a metadata entity definition, including custom entity types and extension table types.
|
|
6828
7502
|
*
|
|
6829
7503
|
* @remarks
|
|
6830
|
-
*
|
|
7504
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
6831
7505
|
*
|
|
6832
7506
|
* @param request - UpdateMetaEntityDefRequest
|
|
6833
7507
|
* @returns UpdateMetaEntityDefResponse
|
|
@@ -7024,10 +7698,33 @@ export default class Client extends OpenApi {
|
|
|
7024
7698
|
*/
|
|
7025
7699
|
updateSecurityStrategy(request: $_model.UpdateSecurityStrategyRequest): Promise<$_model.UpdateSecurityStrategyResponse>;
|
|
7026
7700
|
/**
|
|
7027
|
-
* Updates
|
|
7701
|
+
* Updates a specified Skill and generates a new version.
|
|
7702
|
+
*
|
|
7703
|
+
* @remarks
|
|
7704
|
+
* ## Request description
|
|
7705
|
+
* This API allows you to update an existing Skill and create a new version based on the current highest version or a specified version. Fields not provided in the request retain their original values. You can update the Skill content by providing either `SkillMdOverride` or `BundleUrl`. You can also set additional information such as the visibility scope.
|
|
7706
|
+
*
|
|
7707
|
+
* @param tmpReq - UpdateSkillRequest
|
|
7708
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7709
|
+
* @returns UpdateSkillResponse
|
|
7710
|
+
*/
|
|
7711
|
+
updateSkillWithOptions(tmpReq: $_model.UpdateSkillRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateSkillResponse>;
|
|
7712
|
+
/**
|
|
7713
|
+
* Updates a specified Skill and generates a new version.
|
|
7714
|
+
*
|
|
7715
|
+
* @remarks
|
|
7716
|
+
* ## Request description
|
|
7717
|
+
* This API allows you to update an existing Skill and create a new version based on the current highest version or a specified version. Fields not provided in the request retain their original values. You can update the Skill content by providing either `SkillMdOverride` or `BundleUrl`. You can also set additional information such as the visibility scope.
|
|
7718
|
+
*
|
|
7719
|
+
* @param request - UpdateSkillRequest
|
|
7720
|
+
* @returns UpdateSkillResponse
|
|
7721
|
+
*/
|
|
7722
|
+
updateSkill(request: $_model.UpdateSkillRequest): Promise<$_model.UpdateSkillResponse>;
|
|
7723
|
+
/**
|
|
7724
|
+
* Updates the business metadata of a table in Data Map. Currently, only the table usage description and custom attributes can be updated.
|
|
7028
7725
|
*
|
|
7029
7726
|
* @remarks
|
|
7030
|
-
* 1. You must
|
|
7727
|
+
* 1. You must have DataWorks Basic Edition or a higher edition to use this feature.
|
|
7031
7728
|
*
|
|
7032
7729
|
* @param tmpReq - UpdateTableBusinessMetadataRequest
|
|
7033
7730
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7035,10 +7732,10 @@ export default class Client extends OpenApi {
|
|
|
7035
7732
|
*/
|
|
7036
7733
|
updateTableBusinessMetadataWithOptions(tmpReq: $_model.UpdateTableBusinessMetadataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableBusinessMetadataResponse>;
|
|
7037
7734
|
/**
|
|
7038
|
-
* Updates the business metadata
|
|
7735
|
+
* Updates the business metadata of a table in Data Map. Currently, only the table usage description and custom attributes can be updated.
|
|
7039
7736
|
*
|
|
7040
7737
|
* @remarks
|
|
7041
|
-
* 1. You must
|
|
7738
|
+
* 1. You must have DataWorks Basic Edition or a higher edition to use this feature.
|
|
7042
7739
|
*
|
|
7043
7740
|
* @param request - UpdateTableBusinessMetadataRequest
|
|
7044
7741
|
* @returns UpdateTableBusinessMetadataResponse
|
|
@@ -7139,4 +7836,39 @@ export default class Client extends OpenApi {
|
|
|
7139
7836
|
* @returns UpdateWorkflowDefinitionResponse
|
|
7140
7837
|
*/
|
|
7141
7838
|
updateWorkflowDefinition(request: $_model.UpdateWorkflowDefinitionRequest): Promise<$_model.UpdateWorkflowDefinitionResponse>;
|
|
7839
|
+
/**
|
|
7840
|
+
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, then pass the returned FileId to the ReferenceFileIds parameter of CreateSemanticJob.
|
|
7841
|
+
*
|
|
7842
|
+
* @remarks
|
|
7843
|
+
* ## Scenarios
|
|
7844
|
+
* Requests an upload slot for a reference file to prepare a file for the `singleTableFile` source of `CreateSemanticJob`.
|
|
7845
|
+
* ## Procedure
|
|
7846
|
+
* 1. Pass the file name, MIME type, and actual size to this operation to obtain `Data.UploadUrl` and `Data.FileId`.
|
|
7847
|
+
* 2. Perform an HTTP PUT upload with the same `Content-Type` before the `UploadUrl` expires.
|
|
7848
|
+
* 3. After the upload is complete, use `FileId` as the only element of `CreateSemanticJob.ReferenceFileIds`.
|
|
7849
|
+
* ## Security considerations
|
|
7850
|
+
* `UploadUrl` is a short-lived pre-signed PUT URL. The holder can write to the corresponding object. Do not log, share, or persist this URL.
|
|
7851
|
+
*
|
|
7852
|
+
* @param request - UploadSemanticFileRequest
|
|
7853
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
7854
|
+
* @returns UploadSemanticFileResponse
|
|
7855
|
+
*/
|
|
7856
|
+
uploadSemanticFileWithOptions(request: $_model.UploadSemanticFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UploadSemanticFileResponse>;
|
|
7857
|
+
/**
|
|
7858
|
+
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires, then pass the returned FileId to the ReferenceFileIds parameter of CreateSemanticJob.
|
|
7859
|
+
*
|
|
7860
|
+
* @remarks
|
|
7861
|
+
* ## Scenarios
|
|
7862
|
+
* Requests an upload slot for a reference file to prepare a file for the `singleTableFile` source of `CreateSemanticJob`.
|
|
7863
|
+
* ## Procedure
|
|
7864
|
+
* 1. Pass the file name, MIME type, and actual size to this operation to obtain `Data.UploadUrl` and `Data.FileId`.
|
|
7865
|
+
* 2. Perform an HTTP PUT upload with the same `Content-Type` before the `UploadUrl` expires.
|
|
7866
|
+
* 3. After the upload is complete, use `FileId` as the only element of `CreateSemanticJob.ReferenceFileIds`.
|
|
7867
|
+
* ## Security considerations
|
|
7868
|
+
* `UploadUrl` is a short-lived pre-signed PUT URL. The holder can write to the corresponding object. Do not log, share, or persist this URL.
|
|
7869
|
+
*
|
|
7870
|
+
* @param request - UploadSemanticFileRequest
|
|
7871
|
+
* @returns UploadSemanticFileResponse
|
|
7872
|
+
*/
|
|
7873
|
+
uploadSemanticFile(request: $_model.UploadSemanticFileRequest): Promise<$_model.UploadSemanticFileResponse>;
|
|
7142
7874
|
}
|