@alicloud/dataworks-public20240518 9.0.0 → 9.1.1
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 +571 -78
- package/dist/client.js +880 -78
- package/dist/client.js.map +1 -1
- 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/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 +5 -5
- package/dist/models/CreateSemanticJobResponseBody.d.ts +10 -10
- package/dist/models/CreateSemanticJobShrinkRequest.d.ts +5 -5
- 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/DeleteSemanticJobRequest.d.ts +1 -1
- package/dist/models/DeleteSemanticJobResponseBody.d.ts +5 -5
- package/dist/models/DownloadSemanticResultsRequest.d.ts +2 -2
- package/dist/models/DownloadSemanticResultsResponseBody.d.ts +6 -6
- 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 +1 -1
- package/dist/models/GetSemanticJobDetailResponseBody.d.ts +1 -1
- package/dist/models/GetSemanticJobLogRequest.d.ts +1 -1
- 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/KillSemanticJobRequest.d.ts +3 -3
- package/dist/models/KillSemanticJobResponseBody.d.ts +1 -1
- 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/ListLineageRelationshipsRequest.d.ts +12 -11
- package/dist/models/ListLineageRelationshipsRequest.js.map +1 -1
- package/dist/models/ListLineageRelationshipsResponseBody.d.ts +5 -5
- package/dist/models/ListLineagesRequest.d.ts +1 -0
- package/dist/models/ListLineagesRequest.js +2 -0
- package/dist/models/ListLineagesRequest.js.map +1 -1
- 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 +2 -2
- package/dist/models/ListSemanticJobRunsResponseBody.d.ts +7 -7
- package/dist/models/ListSemanticJobsRequest.d.ts +2 -2
- package/dist/models/ListSemanticJobsResponseBody.d.ts +16 -16
- 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/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 +1 -1
- package/dist/models/RunSemanticJobResponseBody.d.ts +1 -1
- 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 +1 -1
- package/dist/models/UpdateSkillShrinkRequest.d.ts +1 -1
- package/dist/models/UpdateTableBusinessMetadataRequest.d.ts +3 -3
- package/dist/models/UpdateTableBusinessMetadataShrinkRequest.d.ts +3 -3
- package/dist/models/UploadSemanticFileRequest.d.ts +2 -2
- package/dist/models/UploadSemanticFileResponseBody.d.ts +5 -5
- package/dist/models/model.d.ts +45 -0
- package/dist/models/model.js +132 -41
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +937 -78
- 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/CreateMetaEntityDefRequest.ts +7 -8
- package/src/models/CreateMetaEntityDefResponseBody.ts +1 -1
- package/src/models/CreateMetaEntityDefShrinkRequest.ts +7 -8
- package/src/models/CreateSemanticJobRequest.ts +5 -5
- package/src/models/CreateSemanticJobResponseBody.ts +10 -10
- package/src/models/CreateSemanticJobShrinkRequest.ts +5 -5
- 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/DeleteSemanticJobRequest.ts +1 -1
- package/src/models/DeleteSemanticJobResponseBody.ts +5 -5
- package/src/models/DownloadSemanticResultsRequest.ts +2 -2
- package/src/models/DownloadSemanticResultsResponseBody.ts +6 -6
- 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 +1 -1
- package/src/models/GetSemanticJobDetailResponseBody.ts +1 -1
- package/src/models/GetSemanticJobLogRequest.ts +1 -1
- package/src/models/GetTableRequest.ts +11 -5
- package/src/models/GetTableResponseBody.ts +1 -1
- package/src/models/KillSemanticJobRequest.ts +3 -3
- package/src/models/KillSemanticJobResponseBody.ts +1 -1
- 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/ListLineageRelationshipsRequest.ts +12 -11
- package/src/models/ListLineageRelationshipsResponseBody.ts +5 -5
- package/src/models/ListLineagesRequest.ts +3 -0
- 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 +2 -2
- package/src/models/ListSemanticJobRunsResponseBody.ts +7 -7
- package/src/models/ListSemanticJobsRequest.ts +2 -2
- package/src/models/ListSemanticJobsResponseBody.ts +16 -16
- package/src/models/ListTablesRequest.ts +13 -6
- package/src/models/ListTablesShrinkRequest.ts +13 -6
- package/src/models/LoadAgentSessionRequest.ts +1 -1
- 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 +1 -1
- package/src/models/RunSemanticJobResponseBody.ts +1 -1
- 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 +1 -1
- package/src/models/UpdateSkillShrinkRequest.ts +1 -1
- package/src/models/UpdateTableBusinessMetadataRequest.ts +3 -3
- package/src/models/UpdateTableBusinessMetadataShrinkRequest.ts +3 -3
- package/src/models/UploadSemanticFileRequest.ts +2 -2
- package/src/models/UploadSemanticFileResponseBody.ts +5 -5
- package/src/models/model.ts +45 -0
package/dist/client.d.ts
CHANGED
|
@@ -453,6 +453,45 @@ export default class Client extends OpenApi {
|
|
|
453
453
|
* @returns CreateComputeResourceResponse
|
|
454
454
|
*/
|
|
455
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>;
|
|
456
495
|
/**
|
|
457
496
|
* Creates a custom attribute definition.
|
|
458
497
|
*
|
|
@@ -929,10 +968,10 @@ export default class Client extends OpenApi {
|
|
|
929
968
|
*/
|
|
930
969
|
createMetaCollection(request: $_model.CreateMetaCollectionRequest): Promise<$_model.CreateMetaCollectionResponse>;
|
|
931
970
|
/**
|
|
932
|
-
* Creates a metadata entity definition
|
|
971
|
+
* Creates a metadata entity definition, including custom types and extended table types.
|
|
933
972
|
*
|
|
934
973
|
* @remarks
|
|
935
|
-
*
|
|
974
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
936
975
|
*
|
|
937
976
|
* @param tmpReq - CreateMetaEntityDefRequest
|
|
938
977
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -940,10 +979,10 @@ export default class Client extends OpenApi {
|
|
|
940
979
|
*/
|
|
941
980
|
createMetaEntityDefWithOptions(tmpReq: $_model.CreateMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateMetaEntityDefResponse>;
|
|
942
981
|
/**
|
|
943
|
-
* Creates a metadata entity definition
|
|
982
|
+
* Creates a metadata entity definition, including custom types and extended table types.
|
|
944
983
|
*
|
|
945
984
|
* @remarks
|
|
946
|
-
*
|
|
985
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
947
986
|
*
|
|
948
987
|
* @param request - CreateMetaEntityDefRequest
|
|
949
988
|
* @returns CreateMetaEntityDefResponse
|
|
@@ -1241,10 +1280,17 @@ export default class Client extends OpenApi {
|
|
|
1241
1280
|
*/
|
|
1242
1281
|
createSecurityStrategy(request: $_model.CreateSecurityStrategyRequest): Promise<$_model.CreateSecurityStrategyResponse>;
|
|
1243
1282
|
/**
|
|
1244
|
-
* Saves a reusable semantic
|
|
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.
|
|
1245
1284
|
*
|
|
1246
1285
|
* @remarks
|
|
1247
|
-
*
|
|
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.
|
|
1248
1294
|
*
|
|
1249
1295
|
* @param tmpReq - CreateSemanticJobRequest
|
|
1250
1296
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1252,10 +1298,17 @@ export default class Client extends OpenApi {
|
|
|
1252
1298
|
*/
|
|
1253
1299
|
createSemanticJobWithOptions(tmpReq: $_model.CreateSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CreateSemanticJobResponse>;
|
|
1254
1300
|
/**
|
|
1255
|
-
* Saves a reusable semantic
|
|
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.
|
|
1256
1302
|
*
|
|
1257
1303
|
* @remarks
|
|
1258
|
-
*
|
|
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.
|
|
1259
1312
|
*
|
|
1260
1313
|
* @param request - CreateSemanticJobRequest
|
|
1261
1314
|
* @returns CreateSemanticJobResponse
|
|
@@ -1471,6 +1524,43 @@ export default class Client extends OpenApi {
|
|
|
1471
1524
|
* @returns DeleteComputeResourceResponse
|
|
1472
1525
|
*/
|
|
1473
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>;
|
|
1474
1564
|
/**
|
|
1475
1565
|
* Deletes a custom attribute definition.
|
|
1476
1566
|
*
|
|
@@ -1811,10 +1901,10 @@ export default class Client extends OpenApi {
|
|
|
1811
1901
|
*/
|
|
1812
1902
|
deleteFunction(request: $_model.DeleteFunctionRequest): Promise<$_model.DeleteFunctionResponse>;
|
|
1813
1903
|
/**
|
|
1814
|
-
* Deletes a lineage
|
|
1904
|
+
* Deletes a specified data lineage relationship from DataWorks Data Map.
|
|
1815
1905
|
*
|
|
1816
1906
|
* @remarks
|
|
1817
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
1907
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
1818
1908
|
*
|
|
1819
1909
|
* @param request - DeleteLineageRelationshipRequest
|
|
1820
1910
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -1822,10 +1912,10 @@ export default class Client extends OpenApi {
|
|
|
1822
1912
|
*/
|
|
1823
1913
|
deleteLineageRelationshipWithOptions(request: $_model.DeleteLineageRelationshipRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteLineageRelationshipResponse>;
|
|
1824
1914
|
/**
|
|
1825
|
-
* Deletes a lineage
|
|
1915
|
+
* Deletes a specified data lineage relationship from DataWorks Data Map.
|
|
1826
1916
|
*
|
|
1827
1917
|
* @remarks
|
|
1828
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
1918
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
1829
1919
|
*
|
|
1830
1920
|
* @param request - DeleteLineageRelationshipRequest
|
|
1831
1921
|
* @returns DeleteLineageRelationshipResponse
|
|
@@ -2150,10 +2240,17 @@ export default class Client extends OpenApi {
|
|
|
2150
2240
|
*/
|
|
2151
2241
|
deleteSecurityStrategy(request: $_model.DeleteSecurityStrategyRequest): Promise<$_model.DeleteSecurityStrategyResponse>;
|
|
2152
2242
|
/**
|
|
2153
|
-
* Deletes a
|
|
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.
|
|
2154
2244
|
*
|
|
2155
2245
|
* @remarks
|
|
2156
|
-
*
|
|
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`.
|
|
2157
2254
|
*
|
|
2158
2255
|
* @param request - DeleteSemanticJobRequest
|
|
2159
2256
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2161,10 +2258,17 @@ export default class Client extends OpenApi {
|
|
|
2161
2258
|
*/
|
|
2162
2259
|
deleteSemanticJobWithOptions(request: $_model.DeleteSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteSemanticJobResponse>;
|
|
2163
2260
|
/**
|
|
2164
|
-
* Deletes a
|
|
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.
|
|
2165
2262
|
*
|
|
2166
2263
|
* @remarks
|
|
2167
|
-
*
|
|
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`.
|
|
2168
2272
|
*
|
|
2169
2273
|
* @param request - DeleteSemanticJobRequest
|
|
2170
2274
|
* @returns DeleteSemanticJobResponse
|
|
@@ -2380,10 +2484,17 @@ export default class Client extends OpenApi {
|
|
|
2380
2484
|
*/
|
|
2381
2485
|
dissociateProjectFromResourceGroup(request: $_model.DissociateProjectFromResourceGroupRequest): Promise<$_model.DissociateProjectFromResourceGroupResponse>;
|
|
2382
2486
|
/**
|
|
2383
|
-
* Returns the download URL of artifacts by
|
|
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.
|
|
2384
2488
|
*
|
|
2385
2489
|
* @remarks
|
|
2386
|
-
*
|
|
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.
|
|
2387
2498
|
*
|
|
2388
2499
|
* @param request - DownloadSemanticResultsRequest
|
|
2389
2500
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -2391,10 +2502,17 @@ export default class Client extends OpenApi {
|
|
|
2391
2502
|
*/
|
|
2392
2503
|
downloadSemanticResultsWithOptions(request: $_model.DownloadSemanticResultsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DownloadSemanticResultsResponse>;
|
|
2393
2504
|
/**
|
|
2394
|
-
* Returns the download URL of artifacts by
|
|
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.
|
|
2395
2506
|
*
|
|
2396
2507
|
* @remarks
|
|
2397
|
-
*
|
|
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.
|
|
2398
2516
|
*
|
|
2399
2517
|
* @param request - DownloadSemanticResultsRequest
|
|
2400
2518
|
* @returns DownloadSemanticResultsResponse
|
|
@@ -2746,6 +2864,82 @@ export default class Client extends OpenApi {
|
|
|
2746
2864
|
* @returns GetComputeResourceResponse
|
|
2747
2865
|
*/
|
|
2748
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>;
|
|
2749
2943
|
/**
|
|
2750
2944
|
* Queries the result of asynchronously creating a workflow instance.
|
|
2751
2945
|
*
|
|
@@ -3680,7 +3874,14 @@ export default class Client extends OpenApi {
|
|
|
3680
3874
|
* Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
|
|
3681
3875
|
*
|
|
3682
3876
|
* @remarks
|
|
3683
|
-
*
|
|
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`.
|
|
3684
3885
|
*
|
|
3685
3886
|
* @param request - GetSemanticJobDetailRequest
|
|
3686
3887
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3691,7 +3892,14 @@ export default class Client extends OpenApi {
|
|
|
3691
3892
|
* Queries the executor status and runtime configuration by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns.
|
|
3692
3893
|
*
|
|
3693
3894
|
* @remarks
|
|
3694
|
-
*
|
|
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`.
|
|
3695
3903
|
*
|
|
3696
3904
|
* @param request - GetSemanticJobDetailRequest
|
|
3697
3905
|
* @returns GetSemanticJobDetailResponse
|
|
@@ -3701,7 +3909,14 @@ export default class Client extends OpenApi {
|
|
|
3701
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.
|
|
3702
3910
|
*
|
|
3703
3911
|
* @remarks
|
|
3704
|
-
*
|
|
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`.
|
|
3705
3920
|
*
|
|
3706
3921
|
* @param request - GetSemanticJobLogRequest
|
|
3707
3922
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3712,7 +3927,14 @@ export default class Client extends OpenApi {
|
|
|
3712
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.
|
|
3713
3928
|
*
|
|
3714
3929
|
* @remarks
|
|
3715
|
-
*
|
|
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`.
|
|
3716
3938
|
*
|
|
3717
3939
|
* @param request - GetSemanticJobLogRequest
|
|
3718
3940
|
* @returns GetSemanticJobLogResponse
|
|
@@ -3746,7 +3968,7 @@ export default class Client extends OpenApi {
|
|
|
3746
3968
|
*/
|
|
3747
3969
|
getSkill(request: $_model.GetSkillRequest): Promise<$_model.GetSkillResponse>;
|
|
3748
3970
|
/**
|
|
3749
|
-
* 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.
|
|
3750
3972
|
*
|
|
3751
3973
|
* @remarks
|
|
3752
3974
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -3757,7 +3979,7 @@ export default class Client extends OpenApi {
|
|
|
3757
3979
|
*/
|
|
3758
3980
|
getTableWithOptions(request: $_model.GetTableRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetTableResponse>;
|
|
3759
3981
|
/**
|
|
3760
|
-
* 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.
|
|
3761
3983
|
*
|
|
3762
3984
|
* @remarks
|
|
3763
3985
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -3951,10 +4173,17 @@ export default class Client extends OpenApi {
|
|
|
3951
4173
|
*/
|
|
3952
4174
|
importWorkflowDefinition(request: $_model.ImportWorkflowDefinitionRequest): Promise<$_model.ImportWorkflowDefinitionResponse>;
|
|
3953
4175
|
/**
|
|
3954
|
-
* Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call only
|
|
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.
|
|
3955
4177
|
*
|
|
3956
4178
|
* @remarks
|
|
3957
|
-
*
|
|
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.
|
|
3958
4187
|
*
|
|
3959
4188
|
* @param request - KillSemanticJobRequest
|
|
3960
4189
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -3962,10 +4191,17 @@ export default class Client extends OpenApi {
|
|
|
3962
4191
|
*/
|
|
3963
4192
|
killSemanticJobWithOptions(request: $_model.KillSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.KillSemanticJobResponse>;
|
|
3964
4193
|
/**
|
|
3965
|
-
* Stops a specified run by using the ExecutorJobId returned by RunSemanticJob or ListSemanticJobRuns. A successful call only
|
|
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.
|
|
3966
4195
|
*
|
|
3967
4196
|
* @remarks
|
|
3968
|
-
*
|
|
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.
|
|
3969
4205
|
*
|
|
3970
4206
|
* @param request - KillSemanticJobRequest
|
|
3971
4207
|
* @returns KillSemanticJobResponse
|
|
@@ -4129,7 +4365,7 @@ export default class Client extends OpenApi {
|
|
|
4129
4365
|
*/
|
|
4130
4366
|
listCertificates(request: $_model.ListCertificatesRequest): Promise<$_model.ListCertificatesResponse>;
|
|
4131
4367
|
/**
|
|
4132
|
-
* Queries the column list of a specified
|
|
4368
|
+
* Queries the column list of a specified table in DataWorks Data Map.
|
|
4133
4369
|
*
|
|
4134
4370
|
* @remarks
|
|
4135
4371
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -4140,7 +4376,7 @@ export default class Client extends OpenApi {
|
|
|
4140
4376
|
*/
|
|
4141
4377
|
listColumnsWithOptions(request: $_model.ListColumnsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListColumnsResponse>;
|
|
4142
4378
|
/**
|
|
4143
|
-
* Queries the column list of a specified
|
|
4379
|
+
* Queries the column list of a specified table in DataWorks Data Map.
|
|
4144
4380
|
*
|
|
4145
4381
|
* @remarks
|
|
4146
4382
|
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
@@ -4195,6 +4431,45 @@ export default class Client extends OpenApi {
|
|
|
4195
4431
|
* @returns ListComputeResourcesResponse
|
|
4196
4432
|
*/
|
|
4197
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>;
|
|
4198
4473
|
/**
|
|
4199
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.
|
|
4200
4475
|
*
|
|
@@ -4213,6 +4488,43 @@ export default class Client extends OpenApi {
|
|
|
4213
4488
|
* @returns ListCrawlerTypesResponse
|
|
4214
4489
|
*/
|
|
4215
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>;
|
|
4216
4528
|
/**
|
|
4217
4529
|
* Retrieves a paginated list of custom agents.
|
|
4218
4530
|
*
|
|
@@ -4241,7 +4553,7 @@ export default class Client extends OpenApi {
|
|
|
4241
4553
|
*/
|
|
4242
4554
|
listCustomAgents(request: $_model.ListCustomAgentsRequest): Promise<$_model.ListCustomAgentsResponse>;
|
|
4243
4555
|
/**
|
|
4244
|
-
*
|
|
4556
|
+
* Queries the list of custom attribute definitions.
|
|
4245
4557
|
*
|
|
4246
4558
|
* @param request - ListCustomAttributesRequest
|
|
4247
4559
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4249,7 +4561,7 @@ export default class Client extends OpenApi {
|
|
|
4249
4561
|
*/
|
|
4250
4562
|
listCustomAttributesWithOptions(request: $_model.ListCustomAttributesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListCustomAttributesResponse>;
|
|
4251
4563
|
/**
|
|
4252
|
-
*
|
|
4564
|
+
* Queries the list of custom attribute definitions.
|
|
4253
4565
|
*
|
|
4254
4566
|
* @param request - ListCustomAttributesRequest
|
|
4255
4567
|
* @returns ListCustomAttributesResponse
|
|
@@ -4925,10 +5237,10 @@ export default class Client extends OpenApi {
|
|
|
4925
5237
|
*/
|
|
4926
5238
|
listImages(request: $_model.ListImagesRequest): Promise<$_model.ListImagesResponse>;
|
|
4927
5239
|
/**
|
|
4928
|
-
* Queries the
|
|
5240
|
+
* Queries the list of data lineage relationships between two specified entities (tables, fields, OSS files, etc.) in DataWorks Data Map.
|
|
4929
5241
|
*
|
|
4930
5242
|
* @remarks
|
|
4931
|
-
* 1.
|
|
5243
|
+
* 1. You must purchase DataWorks Standard Edition or a higher edition to use this feature.
|
|
4932
5244
|
*
|
|
4933
5245
|
* @param request - ListLineageRelationshipsRequest
|
|
4934
5246
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -4936,10 +5248,10 @@ export default class Client extends OpenApi {
|
|
|
4936
5248
|
*/
|
|
4937
5249
|
listLineageRelationshipsWithOptions(request: $_model.ListLineageRelationshipsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListLineageRelationshipsResponse>;
|
|
4938
5250
|
/**
|
|
4939
|
-
* Queries the
|
|
5251
|
+
* Queries the list of data lineage relationships between two specified entities (tables, fields, OSS files, etc.) in DataWorks Data Map.
|
|
4940
5252
|
*
|
|
4941
5253
|
* @remarks
|
|
4942
|
-
* 1.
|
|
5254
|
+
* 1. You must purchase DataWorks Standard Edition or a higher edition to use this feature.
|
|
4943
5255
|
*
|
|
4944
5256
|
* @param request - ListLineageRelationshipsRequest
|
|
4945
5257
|
* @returns ListLineageRelationshipsResponse
|
|
@@ -5000,10 +5312,10 @@ export default class Client extends OpenApi {
|
|
|
5000
5312
|
*/
|
|
5001
5313
|
listMcpServers(request: $_model.ListMcpServersRequest): Promise<$_model.ListMcpServersResponse>;
|
|
5002
5314
|
/**
|
|
5003
|
-
* Queries
|
|
5315
|
+
* Queries the list of Data Map collections. Supports querying both Data Map categories and data albums.
|
|
5004
5316
|
*
|
|
5005
5317
|
* @remarks
|
|
5006
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
5318
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
5007
5319
|
*
|
|
5008
5320
|
* @param request - ListMetaCollectionsRequest
|
|
5009
5321
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5011,17 +5323,17 @@ export default class Client extends OpenApi {
|
|
|
5011
5323
|
*/
|
|
5012
5324
|
listMetaCollectionsWithOptions(request: $_model.ListMetaCollectionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaCollectionsResponse>;
|
|
5013
5325
|
/**
|
|
5014
|
-
* Queries
|
|
5326
|
+
* Queries the list of Data Map collections. Supports querying both Data Map categories and data albums.
|
|
5015
5327
|
*
|
|
5016
5328
|
* @remarks
|
|
5017
|
-
* 1. DataWorks Professional Edition or a higher edition
|
|
5329
|
+
* 1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.
|
|
5018
5330
|
*
|
|
5019
5331
|
* @param request - ListMetaCollectionsRequest
|
|
5020
5332
|
* @returns ListMetaCollectionsResponse
|
|
5021
5333
|
*/
|
|
5022
5334
|
listMetaCollections(request: $_model.ListMetaCollectionsRequest): Promise<$_model.ListMetaCollectionsResponse>;
|
|
5023
5335
|
/**
|
|
5024
|
-
*
|
|
5336
|
+
* Queries a list of metadata entities. Currently, only custom entity types are supported.
|
|
5025
5337
|
*
|
|
5026
5338
|
* @param tmpReq - ListMetaEntitiesRequest
|
|
5027
5339
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5029,14 +5341,14 @@ export default class Client extends OpenApi {
|
|
|
5029
5341
|
*/
|
|
5030
5342
|
listMetaEntitiesWithOptions(tmpReq: $_model.ListMetaEntitiesRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaEntitiesResponse>;
|
|
5031
5343
|
/**
|
|
5032
|
-
*
|
|
5344
|
+
* Queries a list of metadata entities. Currently, only custom entity types are supported.
|
|
5033
5345
|
*
|
|
5034
5346
|
* @param request - ListMetaEntitiesRequest
|
|
5035
5347
|
* @returns ListMetaEntitiesResponse
|
|
5036
5348
|
*/
|
|
5037
5349
|
listMetaEntities(request: $_model.ListMetaEntitiesRequest): Promise<$_model.ListMetaEntitiesResponse>;
|
|
5038
5350
|
/**
|
|
5039
|
-
*
|
|
5351
|
+
* Queries the list of custom entity definitions, including custom entity types and extension table types.
|
|
5040
5352
|
*
|
|
5041
5353
|
* @param request - ListMetaEntityDefsRequest
|
|
5042
5354
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5044,7 +5356,7 @@ export default class Client extends OpenApi {
|
|
|
5044
5356
|
*/
|
|
5045
5357
|
listMetaEntityDefsWithOptions(request: $_model.ListMetaEntityDefsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListMetaEntityDefsResponse>;
|
|
5046
5358
|
/**
|
|
5047
|
-
*
|
|
5359
|
+
* Queries the list of custom entity definitions, including custom entity types and extension table types.
|
|
5048
5360
|
*
|
|
5049
5361
|
* @param request - ListMetaEntityDefsRequest
|
|
5050
5362
|
* @returns ListMetaEntityDefsResponse
|
|
@@ -5208,11 +5520,12 @@ export default class Client extends OpenApi {
|
|
|
5208
5520
|
*/
|
|
5209
5521
|
listParameters(request: $_model.ListParametersRequest): Promise<$_model.ListParametersResponse>;
|
|
5210
5522
|
/**
|
|
5211
|
-
* Queries
|
|
5523
|
+
* Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS (EMR cluster) types.
|
|
5212
5524
|
*
|
|
5213
5525
|
* @remarks
|
|
5214
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
5215
|
-
* 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.
|
|
5216
5529
|
*
|
|
5217
5530
|
* @param request - ListPartitionsRequest
|
|
5218
5531
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5220,11 +5533,12 @@ export default class Client extends OpenApi {
|
|
|
5220
5533
|
*/
|
|
5221
5534
|
listPartitionsWithOptions(request: $_model.ListPartitionsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListPartitionsResponse>;
|
|
5222
5535
|
/**
|
|
5223
|
-
* Queries
|
|
5536
|
+
* Queries the partition list of a specified table in DataWorks Data Map. Currently supports MaxCompute and HMS (EMR cluster) types.
|
|
5224
5537
|
*
|
|
5225
5538
|
* @remarks
|
|
5226
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
5227
|
-
* 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.
|
|
5228
5542
|
*
|
|
5229
5543
|
* @param request - ListPartitionsRequest
|
|
5230
5544
|
* @returns ListPartitionsResponse
|
|
@@ -5571,10 +5885,17 @@ export default class Client extends OpenApi {
|
|
|
5571
5885
|
*/
|
|
5572
5886
|
listSecurityStrategies(request: $_model.ListSecurityStrategiesRequest): Promise<$_model.ListSecurityStrategiesResponse>;
|
|
5573
5887
|
/**
|
|
5574
|
-
* Queries the run records of a created node by
|
|
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.
|
|
5575
5889
|
*
|
|
5576
5890
|
* @remarks
|
|
5577
|
-
*
|
|
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.
|
|
5578
5899
|
*
|
|
5579
5900
|
* @param request - ListSemanticJobRunsRequest
|
|
5580
5901
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5582,20 +5903,34 @@ export default class Client extends OpenApi {
|
|
|
5582
5903
|
*/
|
|
5583
5904
|
listSemanticJobRunsWithOptions(request: $_model.ListSemanticJobRunsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
5584
5905
|
/**
|
|
5585
|
-
* Queries the run records of a created node by
|
|
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.
|
|
5586
5907
|
*
|
|
5587
5908
|
* @remarks
|
|
5588
|
-
*
|
|
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.
|
|
5589
5917
|
*
|
|
5590
5918
|
* @param request - ListSemanticJobRunsRequest
|
|
5591
5919
|
* @returns ListSemanticJobRunsResponse
|
|
5592
5920
|
*/
|
|
5593
5921
|
listSemanticJobRuns(request: $_model.ListSemanticJobRunsRequest): Promise<$_model.ListSemanticJobRunsResponse>;
|
|
5594
5922
|
/**
|
|
5595
|
-
* Queries
|
|
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.
|
|
5596
5924
|
*
|
|
5597
5925
|
* @remarks
|
|
5598
|
-
*
|
|
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`.
|
|
5599
5934
|
*
|
|
5600
5935
|
* @param request - ListSemanticJobsRequest
|
|
5601
5936
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5603,10 +5938,17 @@ export default class Client extends OpenApi {
|
|
|
5603
5938
|
*/
|
|
5604
5939
|
listSemanticJobsWithOptions(request: $_model.ListSemanticJobsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListSemanticJobsResponse>;
|
|
5605
5940
|
/**
|
|
5606
|
-
* Queries
|
|
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.
|
|
5607
5942
|
*
|
|
5608
5943
|
* @remarks
|
|
5609
|
-
*
|
|
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`.
|
|
5610
5952
|
*
|
|
5611
5953
|
* @param request - ListSemanticJobsRequest
|
|
5612
5954
|
* @returns ListSemanticJobsResponse
|
|
@@ -5647,7 +5989,7 @@ export default class Client extends OpenApi {
|
|
|
5647
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.
|
|
5648
5990
|
*
|
|
5649
5991
|
* @remarks
|
|
5650
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
5992
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
5651
5993
|
*
|
|
5652
5994
|
* @param tmpReq - ListTablesRequest
|
|
5653
5995
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -5658,7 +6000,7 @@ export default class Client extends OpenApi {
|
|
|
5658
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.
|
|
5659
6001
|
*
|
|
5660
6002
|
* @remarks
|
|
5661
|
-
* 1. DataWorks Basic Edition or a higher edition
|
|
6003
|
+
* 1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.
|
|
5662
6004
|
*
|
|
5663
6005
|
* @param request - ListTablesRequest
|
|
5664
6006
|
* @returns ListTablesResponse
|
|
@@ -6227,10 +6569,62 @@ export default class Client extends OpenApi {
|
|
|
6227
6569
|
*/
|
|
6228
6570
|
rollbackParameter(request: $_model.RollbackParameterRequest): Promise<$_model.RollbackParameterResponse>;
|
|
6229
6571
|
/**
|
|
6230
|
-
*
|
|
6572
|
+
* 运行元数据采集器
|
|
6231
6573
|
*
|
|
6232
6574
|
* @remarks
|
|
6233
|
-
*
|
|
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.**
|
|
6234
6628
|
*
|
|
6235
6629
|
* @param request - RunSemanticJobRequest
|
|
6236
6630
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -6238,10 +6632,17 @@ export default class Client extends OpenApi {
|
|
|
6238
6632
|
*/
|
|
6239
6633
|
runSemanticJobWithOptions(request: $_model.RunSemanticJobRequest, runtime: $dara.RuntimeOptions): Promise<$_model.RunSemanticJobResponse>;
|
|
6240
6634
|
/**
|
|
6241
|
-
* Submits a semantic job for execution by
|
|
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.
|
|
6242
6636
|
*
|
|
6243
6637
|
* @remarks
|
|
6244
|
-
*
|
|
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.**
|
|
6245
6646
|
*
|
|
6246
6647
|
* @param request - RunSemanticJobRequest
|
|
6247
6648
|
* @returns RunSemanticJobResponse
|
|
@@ -6310,6 +6711,45 @@ export default class Client extends OpenApi {
|
|
|
6310
6711
|
* @returns StartWorkflowInstancesResponse
|
|
6311
6712
|
*/
|
|
6312
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>;
|
|
6313
6753
|
/**
|
|
6314
6754
|
* Stops a synchronization task.
|
|
6315
6755
|
*
|
|
@@ -6623,6 +7063,45 @@ export default class Client extends OpenApi {
|
|
|
6623
7063
|
* @returns UpdateComputeResourceResponse
|
|
6624
7064
|
*/
|
|
6625
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>;
|
|
6626
7105
|
/**
|
|
6627
7106
|
* Updates a custom attribute.
|
|
6628
7107
|
*
|
|
@@ -7008,10 +7487,10 @@ export default class Client extends OpenApi {
|
|
|
7008
7487
|
*/
|
|
7009
7488
|
updateMetaEntity(request: $_model.UpdateMetaEntityRequest): Promise<$_model.UpdateMetaEntityResponse>;
|
|
7010
7489
|
/**
|
|
7011
|
-
* Updates a
|
|
7490
|
+
* Updates a metadata entity definition, including custom entity types and extension table types.
|
|
7012
7491
|
*
|
|
7013
7492
|
* @remarks
|
|
7014
|
-
*
|
|
7493
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
7015
7494
|
*
|
|
7016
7495
|
* @param tmpReq - UpdateMetaEntityDefRequest
|
|
7017
7496
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7019,10 +7498,10 @@ export default class Client extends OpenApi {
|
|
|
7019
7498
|
*/
|
|
7020
7499
|
updateMetaEntityDefWithOptions(tmpReq: $_model.UpdateMetaEntityDefRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateMetaEntityDefResponse>;
|
|
7021
7500
|
/**
|
|
7022
|
-
* Updates a
|
|
7501
|
+
* Updates a metadata entity definition, including custom entity types and extension table types.
|
|
7023
7502
|
*
|
|
7024
7503
|
* @remarks
|
|
7025
|
-
*
|
|
7504
|
+
* DataWorks Professional Edition or a more advanced edition is required.
|
|
7026
7505
|
*
|
|
7027
7506
|
* @param request - UpdateMetaEntityDefRequest
|
|
7028
7507
|
* @returns UpdateMetaEntityDefResponse
|
|
@@ -7242,10 +7721,10 @@ export default class Client extends OpenApi {
|
|
|
7242
7721
|
*/
|
|
7243
7722
|
updateSkill(request: $_model.UpdateSkillRequest): Promise<$_model.UpdateSkillResponse>;
|
|
7244
7723
|
/**
|
|
7245
|
-
* Updates the business metadata
|
|
7724
|
+
* Updates the business metadata of a table in Data Map. Currently, only the table usage description and custom attributes can be updated.
|
|
7246
7725
|
*
|
|
7247
7726
|
* @remarks
|
|
7248
|
-
* 1. You must
|
|
7727
|
+
* 1. You must have DataWorks Basic Edition or a higher edition to use this feature.
|
|
7249
7728
|
*
|
|
7250
7729
|
* @param tmpReq - UpdateTableBusinessMetadataRequest
|
|
7251
7730
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7253,10 +7732,10 @@ export default class Client extends OpenApi {
|
|
|
7253
7732
|
*/
|
|
7254
7733
|
updateTableBusinessMetadataWithOptions(tmpReq: $_model.UpdateTableBusinessMetadataRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateTableBusinessMetadataResponse>;
|
|
7255
7734
|
/**
|
|
7256
|
-
* 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.
|
|
7257
7736
|
*
|
|
7258
7737
|
* @remarks
|
|
7259
|
-
* 1. You must
|
|
7738
|
+
* 1. You must have DataWorks Basic Edition or a higher edition to use this feature.
|
|
7260
7739
|
*
|
|
7261
7740
|
* @param request - UpdateTableBusinessMetadataRequest
|
|
7262
7741
|
* @returns UpdateTableBusinessMetadataResponse
|
|
@@ -7358,10 +7837,17 @@ export default class Client extends OpenApi {
|
|
|
7358
7837
|
*/
|
|
7359
7838
|
updateWorkflowDefinition(request: $_model.UpdateWorkflowDefinitionRequest): Promise<$_model.UpdateWorkflowDefinitionResponse>;
|
|
7360
7839
|
/**
|
|
7361
|
-
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires,
|
|
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.
|
|
7362
7841
|
*
|
|
7363
7842
|
* @remarks
|
|
7364
|
-
*
|
|
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.
|
|
7365
7851
|
*
|
|
7366
7852
|
* @param request - UploadSemanticFileRequest
|
|
7367
7853
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -7369,10 +7855,17 @@ export default class Client extends OpenApi {
|
|
|
7369
7855
|
*/
|
|
7370
7856
|
uploadSemanticFileWithOptions(request: $_model.UploadSemanticFileRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UploadSemanticFileResponse>;
|
|
7371
7857
|
/**
|
|
7372
|
-
* Requests a temporary OSS PUT upload URL. Complete the PUT upload before the URL expires,
|
|
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.
|
|
7373
7859
|
*
|
|
7374
7860
|
* @remarks
|
|
7375
|
-
*
|
|
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.
|
|
7376
7869
|
*
|
|
7377
7870
|
* @param request - UploadSemanticFileRequest
|
|
7378
7871
|
* @returns UploadSemanticFileResponse
|